# XFormURLEncodedFormatter.java

    /*
     * Licensed to the Apache Software Foundation (ASF) under one
     * or more contributor license agreements. See the NOTICE file
     * distributed with this work for additional information
     * regarding copyright ownership. The ASF licenses this file
     * to you under the Apache License, Version 2.0 (the
     * "License"); you may not use this file except in compliance
     * with the License. You may obtain a copy of the License at
     *
     * http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing,
     * software distributed under the License is distributed on an
     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     * KIND, either express or implied. See the License for the
     * specific language governing permissions and limitations
     * under the License.
     */

    package org.apache.synapse.commons.formatters;

    import org.apache.axiom.om.OMElement;
    import org.apache.axiom.om.OMOutputFormat;
    import org.apache.axis2.AxisFault;
    import org.apache.axis2.Constants;
    import org.apache.axis2.context.MessageContext;
    import org.apache.axis2.description.WSDL2Constants;
    import org.apache.axis2.transport.MessageFormatter;
    import org.apache.axis2.transport.http.HTTPConstants;
    import org.apache.axis2.transport.http.util.URLTemplatingUtil;
    import org.apache.axis2.util.JavaUtils;

    import java.io.IOException;
    import java.io.OutputStream;
    import java.io.UnsupportedEncodingException;
    import java.net.URL;
    import java.net.URLEncoder;
    import java.util.Iterator;

    /**
     * Formates the request message as application/x-www-form-urlencoded
     */
    public class XFormURLEncodedFormatter implements MessageFormatter {

        public byte[] getBytes(MessageContext messageContext, OMOutputFormat format) throws AxisFault {

            OMElement omElement = messageContext.getEnvelope().getBody().getFirstElement();

            if (omElement != null) {
                Iterator it = omElement.getChildElements();
                String paraString = "";

                String encoding= format.getCharSetEncoding();
                if(encoding==null)    {
                    encoding= "UTF-8";
                }
                while (it.hasNext()) {
                    OMElement ele1 = (OMElement) it.next();

                    String parameter;
                    try {
                        parameter = ele1.getLocalName() + "=" + URLEncoder.encode(ele1.getText(),encoding).replace("+", "%20");
                    } catch (UnsupportedEncodingException e) {
                        throw new IllegalArgumentException("UnsupportedEncoding for " + ele1.getText());
                    }

                    //    "2a" "_JsonReader_PD_2a" replace with ""
                    //    "$a" "_JsonReader_PS_a" replace with $
                    parameter = parameter.replace("_JsonReader_PD_","").replace("_JsonReader_PS_","$");
                    paraString = "".equals(paraString) ? parameter : (paraString + "&" + parameter);
                }
                return paraString.getBytes();
            }

            return new byte[0];
        }

        public void writeTo(MessageContext messageContext, OMOutputFormat format,
                            OutputStream outputStream, boolean preserve) throws AxisFault {

            try {
                outputStream.write(getBytes(messageContext, format));
            } catch (IOException e) {
                throw new AxisFault("An error occured while writing the request");
            }
        }

        public String getContentType(MessageContext messageContext, OMOutputFormat format,
                                     String soapAction) {

            String encoding = format.getCharSetEncoding();
            String contentType = HTTPConstants.MEDIA_TYPE_X_WWW_FORM;

            String setEncoding = (String) messageContext.getProperty(
                    Constants.Configuration.SET_CONTENT_TYPE_CHARACTER_ENCODING);

            if (encoding != null && !"false".equals(setEncoding)) {
                contentType += "; charset=" + encoding;
            }

            // if soap action is there (can be there is soap response MEP is used) add it.
            if ((soapAction != null)
                    && !"".equals(soapAction.trim())
                    && !"\"\"".equals(soapAction.trim())) {
                contentType = contentType + ";action=\"" + soapAction + "\";";
            }

            return contentType;
        }

        public URL getTargetAddress(MessageContext messageContext, OMOutputFormat format, URL targetURL)
                throws AxisFault {

            // Check whether there is a template in the URL, if so we have to replace then with data
            // values and create a new target URL.
            targetURL = URLTemplatingUtil.getTemplatedURL(targetURL, messageContext, true);
            String ignoreUncited =
                    (String) messageContext.getProperty(WSDL2Constants.ATTR_WHTTP_IGNORE_UNCITED);

            // Need to have this check here cause
            if (ignoreUncited == null || !JavaUtils.isTrueExplicitly(ignoreUncited)) {
                String httpMethod = (String) messageContext.getProperty(Constants.Configuration.HTTP_METHOD);
                if (Constants.Configuration.HTTP_METHOD_GET.equals(httpMethod) || Constants.Configuration.HTTP_METHOD_DELETE.equals(httpMethod)) {
                    targetURL = URLTemplatingUtil.appendQueryParameters(messageContext, targetURL);
                }
            } else {
                messageContext.getEnvelope().getBody().getFirstElement().detach();
            }

            return targetURL;
        }

        public String formatSOAPAction(MessageContext messageContext, OMOutputFormat format,
                                       String soapAction) {
            return soapAction;
        }
    }