org.opengis.cite.securityclient10.httpServer

Class TestServer

java.lang.Object

org.opengis.cite.securityclient10.httpServer.TestServer

public class TestServer
extends Object

A wrapper class around the Jetty Server class. This adds functionality for the testing suite for adding/removing servlets to capture test client requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestServer.TestAsyncServlet Use a servlet class to capture requests from the secure client.
(package private) class	TestServer.WaitTask Thread class for delaying until a servlet request has been made

Constructor Summary

Constructors

Constructor and Description
TestServer(String host, int port, String jks_path, String jks_password)

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port the server is currently using.
RequestRepresenter	getRequests(String path) Retrieve the HTTP Servlet Request objects for a registered path
void	registerHandler(String path, ServerOptions serverOptions) Create a new ServletContextHandler for the given `path`, and create a shared handler block boolean.
void	shutdown() Shut down the embedded server.
void	unregisterHandler(String path) Iterate through the registered ServletContextHandler instances on this server for the first one to have a mapping matching `path`, and if found then that ServletContextHandler is removed.
void	waitForRequest(String path) Block the thread until a request is received, or the timeout is hit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestServer

public TestServer(String host,
                  int port,
                  String jks_path,
                  String jks_password)
           throws Exception

Parameters:

host - String of host interface to bind

port - Integer of port to bind

jks_path - Path to the Java KeyStore

jks_password - Password to unlock the KeyStore

Throws:

Exception - for any errors starting the embedded Jetty server

Method Detail

getPort

public int getPort()

Return the port the server is currently using.

Returns:

int Current port being used by the embedded server

getRequests

public RequestRepresenter getRequests(String path)

Retrieve the HTTP Servlet Request objects for a registered path

Parameters:

path - String of the path to retrieve from the stored Handlers

Returns:

Zero or more HttpServletRequests

registerHandler

public void registerHandler(String path,
                            ServerOptions serverOptions)
                     throws Exception

Create a new ServletContextHandler for the given `path`, and create a shared handler block boolean. The boolean will be used by the waitForRequest thread to delay until the request is fulfilled or a timeout is hit. The Handler will catch requests to `path`, and to `path/*` where `*` is a wildcard.

Parameters:

path - HTTP path to dynamically add to the embedded server

serverOptions - ServerOptions Object with options for the type of OWS to emulate, will determine which capabilities document will be presented to the client

Throws:

Exception - Exception if context could not be started

shutdown

public void shutdown()
              throws Exception

Shut down the embedded server. This will force close any open HTTP connections.

Throws:

Exception - for any errors shutting down the embedded server

unregisterHandler

public void unregisterHandler(String path)
                       throws org.opengis.cite.servlet.ServletException

Iterate through the registered ServletContextHandler instances on this server for the first one to have a mapping matching `path`, and if found then that ServletContextHandler is removed. If no match is found then nothing is done.

Parameters:

path - HTTP path to dynamically remove from the embedded server

Throws:

org.opengis.cite.servlet.ServletException - For any errors removing a servlet context handler

waitForRequest

public void waitForRequest(String path)
                    throws InterruptedException,
                           ExecutionException

Block the thread until a request is received, or the timeout is hit.

Parameters:

path - The unique code associated with the thread created to wait for the servlet activation

Throws:

InterruptedException - For any errors caused by the waiting thread being interrupted

ExecutionException - For any errors caused by the waiting thread having an exception