com.adaptris.core.http.jetty

Class JettyMessageConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.http.jetty.BasicJettyConsumer

com.adaptris.core.http.jetty.JettyMessageConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent

@ComponentProfile(summary="Listen for HTTP traffic on the specified URI",
                  tag="consumer,http,https",
                  metadata={"jettyQueryString","jettyURI","jettyURL","httpmethod","_interlokMessageConsumedFrom"},
                  recommended={EmbeddedConnection.class,JettyConnection.class})
public class JettyMessageConsumer
extends BasicJettyConsumer

This is the standard class that receives documents via HTTP.

You should configure the AdaptrisMessageConsumerImp.setDestination(com.adaptris.core.ConsumeDestination) to contain the URI that should trigger this consumer (e.g. /path/to/my/workflow). The value from ConsumeDestination.getFilterExpression() is used to determine which HTTP methods are appropriate for this consumer and should be a comma separated list. In the event that the filter expression is empty / null then all HTTP methods are acceptable ("GET", "POST", "HEAD", "PUT", "DELETE", "TRACE", "CONNECT", "PATCH") and will need to be handled directly by your workflow. OPTIONS will be automatically.

If you want to preserve the http request headers or parameters simply configure a handler for either or both the headers and parameters.

See the following javadoc for the following configuration items for headers/parameters;

• parameter-handler
• header-handler

Note that if you intend for this class to be consumer withing a PoolingWorkflow then you should consider configuring a JettyPoolingWorkflowInterceptor as part of that workflow.

In the adapter configuration file this class is aliased as jetty-message-consumer which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested classes/interfaces inherited from class com.adaptris.core.http.jetty.BasicJettyConsumer

BasicJettyConsumer.BasicServlet, BasicJettyConsumer.HttpOperation

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
JettyMessageConsumer()

Method Summary

Modifier and Type	Method and Description
AdaptrisMessage	createMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create an AdaptrisMessage from the incoming servlet request and response.
HeaderHandler<javax.servlet.http.HttpServletRequest>	getHeaderHandler()
ParameterHandler<javax.servlet.http.HttpServletRequest>	getParameterHandler()
void	prepare() Prepare for initialisation.
void	setHeaderHandler(HeaderHandler<javax.servlet.http.HttpServletRequest> headerHandler)
void	setParameterHandler(ParameterHandler<javax.servlet.http.HttpServletRequest> parameterHandler)

Methods inherited from class com.adaptris.core.http.jetty.BasicJettyConsumer

asServletWrapper, close, consumeLocationKey, ensureIsPath, getAdditionalDebug, getSendProcessingInterval, getTimeoutAction, getWarnAfter, init, logHeaders, setAdditionalDebug, setSendProcessingInterval, setTimeoutAction, setWarnAfter, start, stop

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, getDestination, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

JettyMessageConsumer

public JettyMessageConsumer()

Method Detail

createMessage

public AdaptrisMessage createMessage(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws java.io.IOException,
                                     javax.servlet.ServletException

Description copied from class: BasicJettyConsumer

Create an AdaptrisMessage from the incoming servlet request and response.

Specified by:

createMessage in class BasicJettyConsumer

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

an AdaptrisMessage instance.

Throws:

java.io.IOException

javax.servlet.ServletException

See Also:

HttpServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

getParameterHandler

public ParameterHandler<javax.servlet.http.HttpServletRequest> getParameterHandler()

setParameterHandler

public void setParameterHandler(ParameterHandler<javax.servlet.http.HttpServletRequest> parameterHandler)

getHeaderHandler

public HeaderHandler<javax.servlet.http.HttpServletRequest> getHeaderHandler()

setHeaderHandler

public void setHeaderHandler(HeaderHandler<javax.servlet.http.HttpServletRequest> headerHandler)

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException