org.sakaiproject.nakamura.testutils.http.DummyServer.java Source code

Introduction

Here is the source code for org.sakaiproject.nakamura.testutils.http.DummyServer.java

Source

/**
 * Licensed to the Sakai Foundation (SF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The SF 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.sakaiproject.nakamura.testutils.http;

import org.apache.commons.io.IOUtils;
import org.mortbay.jetty.Request;
import org.mortbay.jetty.Server;
import org.mortbay.jetty.handler.AbstractHandler;

import java.io.IOException;
import java.io.InputStream;
import java.net.ServerSocket;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Create a HTTP server on the next available port between 8888 and 8988 that will respond
 * with the configured request to any request. Should be run single threaded.
 */
public class DummyServer extends AbstractHandler {

    /**
     * The next body response to send.
     */
    private String responseBody = "Hello";
    /**
     * The server object.
     */
    private Server server;
    /**
     * The port on which the server is listening.
     */
    private int port;
    /**
     * The next content type to respond with.
     */
    private String contentType = "text/plain";
    /**
     * The next status to send.
     */
    private int status = 200;
    /**
     * The last captured request.
     */
    private CapturedRequest request;

    /**
     * Create the dummy server on the first available port. There will be 100 tries before
     * we stop trying.
     */
    public DummyServer() {
        int attempts = 0;
        while (server == null) {
            try {
                // new ServerSocket(0) will automatically try to find a free port.
                ServerSocket socket = new ServerSocket(0);
                port = socket.getLocalPort();
                socket.close();

                server = new Server(port);
                server.setHandler(this);
                server.start();
                break;
            } catch (Exception e) {
                if (server != null) {
                    try {
                        server.stop();
                        server.destroy();
                    } catch (Exception ex2) {
                    }
                }
                server = null;
            }
            attempts++;
            if (attempts == 100) {
                throw new RuntimeException(
                        "Unable to find a free port the range 8888 - 8988, aborting http server startup ");
            }
        }
    }

    /**
     * Close the server down, releasing resources.
     */
    public void close() {
        if (server != null) {
            try {
                server.stop();
            } catch (Exception e) {
            }
            server.destroy();
            server = null;
        }
    }

    /**
     * @return the current URL that the server is listening on.
     */
    public String getUrl() {
        return "http://localhost:" + port + "/test";
    }

    /**
     * {@inheritDoc}
     * 
     * @see org.mortbay.jetty.Handler#handle(java.lang.String,
     *      javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse,
     *      int)
     */
    public void handle(String target, HttpServletRequest request, HttpServletResponse response, int dispatch)
            throws IOException, ServletException {

        this.request = new CapturedRequest(request);

        response.setContentType(contentType);
        response.setStatus(status);
        response.getWriter().print(responseBody);
        ((Request) request).setHandled(true);
    }

    /**
     * @param contentType
     *          the contentType to set
     */
    public void setContentType(String contentType) {
        this.contentType = contentType;
    }

    /**
     * @param status
     *          the status to set
     */
    public void setStatus(int status) {
        this.status = status;
    }

    /**
     * @param responsebody
     *          the responsebody to set
     */
    public void setResponseBody(String responseBody) {
        this.responseBody = responseBody;
    }

    public void setResponseBodyFromFile(String filename) throws IOException {
        InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(filename);
        if (is == null) {
            throw new IOException("No such file " + filename);
        }
        this.responseBody = IOUtils.toString(is);
    }

    /**
     * @return the request
     */
    public CapturedRequest getRequest() {
        return request;
    }

    public int getPort() {
        return port;
    }

}