org.eclipse.jetty.testing

Class ServletTester

java.lang.Object

org.eclipse.jetty.testing.ServletTester

public class ServletTester
extends Object

Testing support for servlets and filters. Allows a programatic setup of a context with servlets and filters for testing. Raw HTTP requests may be sent to the context and responses received. To avoid handling raw HTTP see HttpTester.

      ServletTester tester=new ServletTester();
      tester.setContextPath("/context");
      tester.addServlet(TestServlet.class, "/servlet/*");
      tester.addServlet("org.eclipse.jetty.servlet.DefaultServlet", "/");
      tester.start();
      String response = tester.getResponses("GET /context/servlet/info HTTP/1.0\r\n\r\n");
 

See Also:

HttpTester

Constructor Summary

Constructors

Constructor and Description
ServletTester()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(EventListener listener)
FilterHolder	addFilter(Class filterClass, String pathSpec, EnumSet<javax.servlet.DispatcherType> dispatches)
FilterHolder	addFilter(String filterClass, String pathSpec, EnumSet<javax.servlet.DispatcherType> dispatches)
ServletHolder	addServlet(Class servlet, String pathSpec)
ServletHolder	addServlet(String className, String pathSpec)
String	createChannelConnector(boolean localhost) Create a SelectChannel connector.
LocalConnector	createLocalConnector() Create a local connector.
String	createSocketConnector(boolean localhost) Create a Socket connector.
void	dump()
Object	getAttribute(String name)
Enumeration	getAttributeNames()
Attributes	getAttributes()
ServletContextHandler	getContext()
String	getResourceBase()
ByteArrayBuffer	getResponses(ByteArrayBuffer rawRequests) Get raw HTTP responses from raw HTTP requests.
String	getResponses(String rawRequests) Get raw HTTP responses from raw HTTP requests.
String	getResponses(String rawRequests, LocalConnector connector) Get raw HTTP responses from raw HTTP requests.
void	join()
void	setAttribute(String name, Object value)
void	setClassLoader(ClassLoader classLoader)
void	setContextPath(String contextPath)
void	setEventListeners(EventListener[] eventListeners)
void	setResourceBase(String resourceBase)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletTester

public ServletTester()

Method Detail

dump

public void dump()

start

public void start()
           throws Exception

Throws:

Exception

join

public void join()
          throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

getContext

public ServletContextHandler getContext()

getResponses

public String getResponses(String rawRequests)
                    throws Exception

Get raw HTTP responses from raw HTTP requests. Multiple requests and responses may be handled, but only if persistent connections conditions apply.

Parameters:

rawRequests - String of raw HTTP requests

Returns:

String of raw HTTP responses

Throws:

Exception

getResponses

public String getResponses(String rawRequests,
                  LocalConnector connector)
                    throws Exception

Get raw HTTP responses from raw HTTP requests. Multiple requests and responses may be handled, but only if persistent connections conditions apply.

Parameters:

rawRequests - String of raw HTTP requests

connector - The connector to handle the responses

Returns:

String of raw HTTP responses

Throws:

Exception

getResponses

public ByteArrayBuffer getResponses(ByteArrayBuffer rawRequests)
                             throws Exception

Get raw HTTP responses from raw HTTP requests. Multiple requests and responses may be handled, but only if persistent connections conditions apply.

Parameters:

rawRequests - String of raw HTTP requests

Returns:

String of raw HTTP responses

Throws:

Exception

createSocketConnector

public String createSocketConnector(boolean localhost)
                             throws Exception

Create a Socket connector. This methods adds a socket connector to the server

Parameters:

localhost - if true, only listen on local host, else listen on all interfaces.

Returns:

A URL to access the server via the socket connector.

Throws:

Exception

createChannelConnector

public String createChannelConnector(boolean localhost)
                              throws Exception

Create a SelectChannel connector. This methods adds a select channel connector to the server

Returns:

A URL to access the server via the connector.

Throws:

Exception

createLocalConnector

public LocalConnector createLocalConnector()
                                    throws Exception

Create a local connector. This methods adds a local connector to the server

Returns:

The LocalConnector object

Throws:

Exception

addEventListener

public void addEventListener(EventListener listener)

Parameters:

listener -

See Also:

ContextHandler.addEventListener(java.util.EventListener)

addFilter

public FilterHolder addFilter(Class filterClass,
                     String pathSpec,
                     EnumSet<javax.servlet.DispatcherType> dispatches)

Parameters:

filterClass -

pathSpec -

dispatches -

Returns:

the FilterHolder

See Also:

org.eclipse.jetty.servlet.ServletContextHandler#addFilter(java.lang.Class, java.lang.String, int)

addFilter

public FilterHolder addFilter(String filterClass,
                     String pathSpec,
                     EnumSet<javax.servlet.DispatcherType> dispatches)

Parameters:

filterClass -

pathSpec -

dispatches -

Returns:

the FilterHolder

See Also:

org.eclipse.jetty.servlet.ServletContextHandler#addFilter(java.lang.String, java.lang.String, int)

addServlet

public ServletHolder addServlet(Class servlet,
                       String pathSpec)

Parameters:

servlet -

pathSpec -

Returns:

the ServletHolder

See Also:

ServletContextHandler.addServlet(java.lang.Class, java.lang.String)

addServlet

public ServletHolder addServlet(String className,
                       String pathSpec)

Parameters:

className -

pathSpec -

Returns:

the ServletHolder

See Also:

ServletContextHandler.addServlet(java.lang.String, java.lang.String)

getAttribute

public Object getAttribute(String name)

Parameters:

name -

Returns:

the Attribute object

See Also:

ContextHandler.getAttribute(java.lang.String)

getAttributeNames

public Enumeration getAttributeNames()

Returns:

the Attribute Names

See Also:

ContextHandler.getAttributeNames()

getAttributes

public Attributes getAttributes()

Returns:

the attributes

See Also:

ContextHandler.getAttributes()

getResourceBase

public String getResourceBase()

Returns:

the resource base

See Also:

ContextHandler.getResourceBase()

setAttribute

public void setAttribute(String name,
                Object value)

Parameters:

name -

value -

See Also:

ContextHandler.setAttribute(java.lang.String, java.lang.Object)

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Parameters:

classLoader -

See Also:

ContextHandler.setClassLoader(java.lang.ClassLoader)

setContextPath

public void setContextPath(String contextPath)

Parameters:

contextPath -

See Also:

ContextHandler.setContextPath(java.lang.String)

setEventListeners

public void setEventListeners(EventListener[] eventListeners)

Parameters:

eventListeners -

See Also:

ContextHandler.setEventListeners(java.util.EventListener[])

setResourceBase

public void setResourceBase(String resourceBase)

Parameters:

resourceBase -

See Also:

ContextHandler.setResourceBase(java.lang.String)