ksoap2/transport/HttpTransportSE.java

/**
 *  Copyright (c) 2003,2004, Stefan Haustein, Oberhausen, Rhld., Germany
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The  above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * Contributor(s): John D. Beatty, Dave Dash, F. Hunter, Alexander Krebs,
 *                 Lars Mehrmann, Sean McDaniel, Thomas Strang, Renaud Tognelli
 * */

package org.ksoap2.transport;

import java.util.List;
import java.util.zip.GZIPInputStream;
import java.io.*;
import java.net.MalformedURLException;
import java.net.Proxy;
import java.net.URL;

import org.ksoap2.*;
import org.ksoap2.serialization.SoapSerializationEnvelope;
import org.xmlpull.v1.*;

/**
 * A J2SE based HttpTransport layer.
 */
public class HttpTransportSE extends Transport {

    private ServiceConnection serviceConnection;

    /**
     * Creates instance of HttpTransportSE with set url
     *
     * @param url
     *            the destination to POST SOAP data
     */
    public HttpTransportSE(String url) {
        super(null, url);
    }

    /**
     * Creates instance of HttpTransportSE with set url and defines a
     * proxy server to use to access it
     *
     * @param proxy
     * Proxy information or <code>null</code> for direct access
     * @param url
     * The destination to POST SOAP data
     */
    public HttpTransportSE(Proxy proxy, String url) {
        super(proxy, url);
    }

    /**
     * Creates instance of HttpTransportSE with set url
     *
     * @param url
     *            the destination to POST SOAP data
     * @param timeout
     *   timeout for connection and Read Timeouts (milliseconds)
     */
    public HttpTransportSE(String url, int timeout) {
        super(url, timeout);
    }

    public HttpTransportSE(Proxy proxy, String url, int timeout) {
        super(proxy, url, timeout);
    }

    /**
     * Creates instance of HttpTransportSE with set url
     *
     * @param url
     *            the destination to POST SOAP data
     * @param timeout
     *   timeout for connection and Read Timeouts (milliseconds)
     * @param contentLength
     *   Content Lenght in bytes if known in advance
     */
    public HttpTransportSE(String url, int timeout, int contentLength) {
        super(url, timeout);
    }

    public HttpTransportSE(Proxy proxy, String url, int timeout, int contentLength) {
        super(proxy, url, timeout);
    }

    /**
     * set the desired soapAction header field
     *
     * @param soapAction
     *            the desired soapAction
     * @param envelope
     *            the envelope containing the information for the soap call.
     * @throws IOException
     * @throws XmlPullParserException
     */
    public void call(String soapAction, SoapEnvelope envelope) throws IOException,
            XmlPullParserException {

        call(soapAction, envelope, null);
    }

    /**
     *
     * set the desired soapAction header field
     *
     * @param soapAction
     *            the desired soapAction
     * @param envelope
     *            the envelope containing the information for the soap call.
     * @param headers
     *              a list of HeaderProperties to be http header properties when establishing the connection
     *
     * @return <code>CookieJar</code> with any cookies sent by the server
     * @throws IOException
     * @throws XmlPullParserException
     */
    public List call(String soapAction, SoapEnvelope envelope, List headers)
            throws IOException, XmlPullParserException {

        if (soapAction == null) {
            soapAction = "\"\"";
        }

        System.out.println("call action:" + soapAction);
        byte[] requestData = createRequestData(envelope, "UTF-8");

        if (requestData != null) {
            requestDump = debug ? new String(requestData) : null;
        }
        else {
            requestDump = null;
        }
        responseDump = null;

        System.out.println("requestDump:" + requestDump);
        ServiceConnection connection = getServiceConnection();
        System.out.println("connection:" + connection);

        connection.setRequestProperty("User-Agent", USER_AGENT);
        // SOAPAction is not a valid header for VER12 so do not add
        // it
        // @see "http://code.google.com/p/ksoap2-android/issues/detail?id=67
        System.out.println("envelope:" + envelope);
        if (envelope != null) {
            if (envelope.version != SoapSerializationEnvelope.VER12) {
                connection.setRequestProperty("SOAPAction", soapAction);
            }

            if (envelope.version == SoapSerializationEnvelope.VER12) {
                connection.setRequestProperty("Content-Type", CONTENT_TYPE_SOAP_XML_CHARSET_UTF_8);
            } else {
                connection.setRequestProperty("Content-Type", CONTENT_TYPE_XML_CHARSET_UTF_8);
            }

            connection.setRequestProperty("Connection", "close");
            connection.setRequestProperty("Accept-Encoding", "gzip");
            connection.setRequestProperty("Content-Length", "" + requestData.length);

            //M: Retry for HTTP Authentication
            //connection.setFixedLengthStreamingMode(requestData.length);

            // Pass the headers provided by the user along with the call
            if (headers != null) {
                for (int i = 0; i < headers.size(); i++) {
                    HeaderProperty hp = (HeaderProperty) headers.get(i);
                    connection.setRequestProperty(hp.getKey(), hp.getValue());
                }
            }

            connection.setRequestMethod("POST");

        }
        else {
            connection.setRequestProperty("Connection", "close");
            connection.setRequestProperty("Accept-Encoding", "gzip");
            connection.setRequestMethod("GET");
        }

        if (requestData != null) {
            OutputStream os = connection.openOutputStream();

            os.write(requestData, 0, requestData.length);
            os.flush();
            os.close();
            requestData = null;
        }
        InputStream is;
        List retHeaders = null;
        boolean gZippedContent = false;
        boolean bcaCert = false;

        try {
            retHeaders = connection.getResponseProperties();
            System.out.println("[HttpTransportSE] retHeaders = " + retHeaders);
            for (int i = 0; i < retHeaders.size(); i++) {
                HeaderProperty hp = (HeaderProperty) retHeaders.get(i);
                // HTTP response code has null key
                if (null == hp.getKey()) {
                    continue;
                }
                // ignoring case since users found that all smaller case is used on some server
                // and even if it is wrong according to spec, we rather have it work..
                if (hp.getKey().equalsIgnoreCase("Content-Encoding")
                        && hp.getValue().equalsIgnoreCase("gzip")) {
                    gZippedContent = true;
                }
            }
            if (gZippedContent) {
                is = getUnZippedInputStream(connection.openInputStream());
            } else {
                is = connection.openInputStream();
            }
        } catch (IOException e) {
            if (gZippedContent) {
                is = getUnZippedInputStream(connection.getErrorStream());
            } else {
                is = connection.getErrorStream();
            }

            if (is == null) {
                connection.disconnect();
                throw (e);
            }
        }

        if (debug) {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            byte[] buf = new byte[8192];

            while (true) {
                int rd = is.read(buf, 0, 8192);
                if (rd == -1) {
                    break;
                }
                bos.write(buf, 0, rd);
            }

            bos.flush();
            buf = bos.toByteArray();

            responseDump = new String(buf);

            System.out.println("responseDump:" + responseDump);
            is.close();
            is = new ByteArrayInputStream(buf);
        }

        if (envelope != null) {
            parseResponse(envelope, is);
        }

        return retHeaders;
    }

    private InputStream getUnZippedInputStream(InputStream inputStream) throws IOException {
        /* workaround for Android 2.3
           (see http://stackoverflow.com/questions/5131016/)
        */
        try {
            return (GZIPInputStream) inputStream;
        } catch (ClassCastException e) {
            return new GZIPInputStream(inputStream);
        }
    }

    public ServiceConnection getServiceConnection() throws IOException {
        if (serviceConnection == null) {
            System.out.println("new ServiceConnectionSE:" + proxy + " " + url + " " + timeout);
            serviceConnection = new ServiceConnectionSE(proxy, url, timeout);
        }
        return serviceConnection;
    }

    public String getHost() {

        String retVal = null;

        try {
            retVal = new URL(url).getHost();
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }

        return retVal;
    }

    public int getPort() {

        int retVal = -1;

        try {
            retVal = new URL(url).getPort();
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }

        return retVal;
    }

    public String getPath() {

        String retVal = null;

        try {
            retVal = new URL(url).getPath();
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }

        return retVal;
    }

    public String getQuery() {

        String retVal = null;

        try {
            retVal = new URL(url).getQuery();
        } catch (MalformedURLException e) {
            e.printStackTrace();
        }

        return retVal;
    }

    /**
     * @hide
     */
    public byte[] getRequestData(SoapEnvelope envelope, String encoding) {
        try {
            return createRequestData(envelope, encoding);
        } catch (Exception e) {
            e.printStackTrace();
        }

        return null;
    }
}