com.github.restdriver.clientdriver.jetty

Class DefaultClientDriverJettyHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

com.github.restdriver.clientdriver.jetty.DefaultClientDriverJettyHandler

All Implemented Interfaces:

ClientDriverJettyHandler, org.eclipse.jetty.server.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle

public final class DefaultClientDriverJettyHandler
extends org.eclipse.jetty.server.handler.AbstractHandler
implements ClientDriverJettyHandler

Class which acts as a Jetty Handler to see if the actual incoming HTTP request matches any expectation and to act accordingly. In case of any kind of error, ClientDriverInternalException is usually thrown.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
DefaultClientDriverJettyHandler(RequestMatcher matcher) Constructor which accepts a RequestMatcher.

Method Summary

Modifier and Type	Method and Description
ClientDriverExpectation	addExpectation(ClientDriverRequest request, ClientDriverResponse response) Add in a ClientDriverRequest/ ClientDriverResponse pair.
void	checkForUnexpectedRequests() This method will throw a ClientDriverFailedExpectationException if there have been any unexpected requests.
void	checkForUnmatchedExpectations() This method will throw a ClientDriverFailedExpectationException if any expectations have not been met.
void	handle(String target, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	noFailFastOnUnexpectedRequest() Should not fail fast on unexpected requests, but will fail later when running ClientDriverJettyHandler.checkForUnexpectedRequests().
void	reset() Resets the expectations so the current ClientDriver instance can be reused.
void	verify(ClientDriverRequest request, int times)

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

destroy, doStart, doStop, dumpThis, getServer, setServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.Handler

destroy, getServer, setServer

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Constructor Detail

DefaultClientDriverJettyHandler

public DefaultClientDriverJettyHandler(RequestMatcher matcher)

Constructor which accepts a RequestMatcher.

Parameters:

matcher - The RequestMatcher to use.

Method Detail

handle

public void handle(String target,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException

This implementation uses the expected ClientDriverRequest/ ClientDriverResponse pairs to serve its requests. If an unexpected request comes in, a ClientDriverInternalException is thrown.

Specified by:

handle in interface org.eclipse.jetty.server.Handler

Throws:

IOException

javax.servlet.ServletException

checkForUnexpectedRequests

public void checkForUnexpectedRequests()

Description copied from interface: ClientDriverJettyHandler

This method will throw a ClientDriverFailedExpectationException if there have been any unexpected requests.

Specified by:

checkForUnexpectedRequests in interface ClientDriverJettyHandler

checkForUnmatchedExpectations

public void checkForUnmatchedExpectations()

Description copied from interface: ClientDriverJettyHandler

This method will throw a ClientDriverFailedExpectationException if any expectations have not been met.

Specified by:

checkForUnmatchedExpectations in interface ClientDriverJettyHandler

noFailFastOnUnexpectedRequest

public void noFailFastOnUnexpectedRequest()

Description copied from interface: ClientDriverJettyHandler

Should not fail fast on unexpected requests, but will fail later when running ClientDriverJettyHandler.checkForUnexpectedRequests().

Specified by:

noFailFastOnUnexpectedRequest in interface ClientDriverJettyHandler

reset

public void reset()

Description copied from interface: ClientDriverJettyHandler

Resets the expectations so the current ClientDriver instance can be reused.

Specified by:

reset in interface ClientDriverJettyHandler

addExpectation

public ClientDriverExpectation addExpectation(ClientDriverRequest request,
                                              ClientDriverResponse response)

Add in a ClientDriverRequest/ ClientDriverResponse pair.

Specified by:

addExpectation in interface ClientDriverJettyHandler

Parameters:

request - The expected request

response - The response to serve to that request

Returns:

The added expectation

verify

public void verify(ClientDriverRequest request,
                   int times)

Specified by:

verify in interface ClientDriverJettyHandler