httpposter.java

J2ME MIDP_Example_Applications

// Copyright 2003 Nokia Corporation.
//
// THIS SOURCE CODE IS PROVIDED 'AS IS', WITH NO WARRANTIES WHATSOEVER,
// EXPRESS OR IMPLIED, INCLUDING ANY WARRANTY OF MERCHANTABILITY, FITNESS
// FOR ANY PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE
// OR TRADE PRACTICE, RELATING TO THE SOURCE CODE OR ANY WARRANTY OTHERWISE
// ARISING OUT OF ANY PROPOSAL, SPECIFICATION, OR SAMPLE AND WITH NO
// OBLIGATION OF NOKIA TO PROVIDE THE LICENSEE WITH ANY MAINTENANCE OR
// SUPPORT. FURTHERMORE, NOKIA MAKES NO WARRANTY THAT EXERCISE OF THE
// RIGHTS GRANTED HEREUNDER DOES NOT INFRINGE OR MAY NOT CAUSE INFRINGEMENT
// OF ANY PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OWNED OR CONTROLLED
// BY THIRD PARTIES
//
// Furthermore, information provided in this source code is preliminary,
// and may be changed substantially prior to final release. Nokia Corporation
// retains the right to make changes to this source code at
// any time, without notice. This source code is provided for informational
// purposes only.
//
// Nokia and Nokia Connecting People are registered trademarks of Nokia
// Corporation.
// Java and all Java-based marks are trademarks or registered trademarks of
// Sun Microsystems, Inc.
// Other product and company names mentioned herein may be trademarks or
// trade names of their respective owners.
//
// A non-exclusive, non-transferable, worldwide, limited license is hereby
// granted to the Licensee to download, print, reproduce and modify the
// source code. The licensee has the right to market, sell, distribute and
// make available the source code in original or modified form only when
// incorporated into the programs developed by the Licensee. No other
// license, express or implied, by estoppel or otherwise, to any other
// intellectual property rights is granted herein.
package whiteboard;

import java.io.*;
import java.security.SecureRandom;
import java.util.*;
import javax.microedition.io.*;
import javax.microedition.lcdui.*;

import org.bouncycastle.crypto.*;

import org.bouncycastle.crypto.digests.MD5Digest;
import org.bouncycastle.crypto.engines.*;
import org.bouncycastle.crypto.paddings.*;
import org.bouncycastle.crypto.params.*;
import org.bouncycastle.util.encoders.Hex;

/**
 *  This class accepts and queues POST and GET requests for a particular URL,
 *  and services them in first-in-first-out order. Using the queue allows it to
 *  be thread-safe without forcing its clients ever to block. It also accept
 *  alternative MIME-types Supports Basic Authentication
 */
class HttpPoster
     implements Runnable
{
    private final static int NONE = 0;
    private final static int BASIC = 1;
    private final static int DIGEST = 2;
    private final static int CUSTOM = 3;

    protected String url;
    protected Display display;
    protected volatile boolean aborting = false;
    protected Vector requestQueue = new Vector();
    protected String credentials = null;
    protected String username = null, password = null;
    protected int authorizationType = NONE;
    protected long internalKey = 0, counter = 0;
    protected boolean authenticationAccepted = false;

    HttpPoster(Display display, String url)
    {
        this.display = display;
        this.url = url;
        internalKey = new Random().nextLong();
        Thread thread = new Thread(this);
        thread.start();
    }


    void sendRequest(String type, String request, HttpPosterListener listener)
        throws IOException
    {
        sendRequest(type, null, request, listener);
    }


    synchronized void sendRequest(String type, String mimeType,
                                  String request, HttpPosterListener listener)
        throws IOException
    {
        // Create a new request and add it to the queue
        HttpRequest newRequest = new HttpRequest();
        newRequest.type = type;
        newRequest.request = request;
        newRequest.listener = listener;
        newRequest.mimeType = mimeType;
        requestQueue.addElement(newRequest);
        // wake up sending thread
        notify();
    }


    public void run()
    {
        running :
        while (!aborting)
        {
            HttpRequest request = null;

            synchronized (this)
            {
                while (requestQueue.size() == 0)
                {
                    try
                    {
                        // releases lock
                        wait();
                    }
                    catch (InterruptedException e)
                    {
                        // Ignore this thread is not interrupted in MIDP
                    }

                    if (aborting)
                    {
                        break running;
                    }
                }

                request = (HttpRequest) (requestQueue.elementAt(0));
                requestQueue.removeElementAt(0);
            }

            // sendRequest must have notified us
            doSend(request.type, request.mimeType, request.request, request.listener);
        }
    }


    private void doSend(String type, String mimeType,
                        String requestStr, HttpPosterListener listener)
    {
        HttpConnection conn = null;
        InputStream in = null;
        String responseStr = null;
        String errorStr = null;
        boolean wasError = false;
        try
        {
            int responseCode;
            do
            {
                conn = (HttpConnection) Connector.open(url);

                // Set the request method and headers
                conn.setRequestMethod(type);
                if (mimeType != null)
                {
                    conn.setRequestProperty("Content-Type", mimeType);
                }

                if (credentials != null)
                {
                    if (authorizationType == BASIC)
                    {
                        conn.setRequestProperty("Authorization",
                            "Basic " + credentials);
                    }
                    else if (authorizationType == DIGEST)
                    {
                        conn.setRequestProperty("Authorization",
                            "Digest " + credentials);
                    }
                    else if (authorizationType == CUSTOM)
                    {
                        conn.setRequestProperty("X-Authorization",
                            "X-Digest " + credentials);
                    }
                }

                // write request
                writeRequest(conn, requestStr);

                // read response
                responseStr = readResponse(conn);

                responseCode = conn.getResponseCode();
                switch (responseCode)
                {
                    case HttpConnection.HTTP_OK:
                        if (authorizationType != NONE)
                        {
                            // the digest authorization was ok. Let's remember that
                            authenticationAccepted = true;
                        }
                        break;
                    case HttpConnection.HTTP_UNAUTHORIZED:
                        // missing credentials when server requires them,
                        // or credentials sent but invalid, perhaphs nonce changed
                        String challenge = null;
                        if (conn.getHeaderField("X-WWW-Authenticate") != null)
                        {
                            challenge = conn.getHeaderField("X-WWW-Authenticate");
                        }
                        else
                        {
                            challenge = conn.getHeaderField("WWW-Authenticate");
                        }
                        credentials = getCredentials(conn.getFile(),
                                                     conn.getRequestMethod(),
                                                     challenge);
                        conn.close();
                        // open again, this time with credentials
                        break;
                    default:
                        throw new IOException("Unsupported response code: " + responseCode);
                }
            } while (responseCode != HttpConnection.HTTP_OK);

            // support URL rewriting for session handling
            String rewrittenUrl = conn.getHeaderField("X-RewrittenURL");
            if (rewrittenUrl != null)
            {
                // use this new one in future
                url = rewrittenUrl;
            }
        }
        catch (IOException e)
        {
            wasError = true;
            errorStr = e.getMessage();
        }
        catch (SecurityException e)
        {
            wasError = true;
            errorStr = e.getMessage();
        }
        finally
        {
            if (conn != null)
            {
                try
                {
                    conn.close();
                }
                catch (IOException e)
                {
                    // already closing, just ignore
                }
            }
        }

        if (wasError)
        {
            listener.handleHttpError(errorStr);
        }
        else
        {
            listener.receiveHttpResponse(responseStr);
        }
    }


    private void writeRequest(HttpConnection conn, String request)
        throws IOException
    {
        OutputStream out = null;
        try
        {
            if (password != null && request.length()>0)
            {
                String nonce = createNonce();
                try
                {
                    // encrypt the content
                    request = encryptRequest(request, nonce);
                }
                catch (InvalidCipherTextException e)
                {
                    throw new IOException(e.getMessage());
                }
                conn.setRequestProperty("X-Crypto-Nonce", nonce);
            } else {
                // clean up the request so we never send it in clear
                request = "";
            }
            conn.setRequestProperty("Content-Length",
                                    Integer.toString(request.length()));

            // Getting the output stream may flush the headers
            out = conn.openOutputStream();
            int requestLength = request.length();
            for (int i = 0; i < requestLength; ++i)
            {
                out.write(request.charAt(i));
            }
        }
        finally
        {
            if (out != null)
            {
                try
                {
                    out.close();
                }
                catch (IOException e)
                {
                    // already closing, just ignore
                }
            }
        }
    }


    private String readResponse(HttpConnection conn)
        throws IOException
    {
        InputStream in = null;