com.adaptris.core.http.jetty

Class BasicJettyConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

com.adaptris.core.http.jetty.BasicJettyConsumer

All Implemented Interfaces:

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

Direct Known Subclasses:

JettyMessageConsumer

public abstract class BasicJettyConsumer
extends AdaptrisMessageConsumerImp

This is the abstract class for all implementations that make use of Jetty to receive messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicJettyConsumer.BasicServlet
static interface	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
BasicJettyConsumer()

Method Summary

Modifier and Type	Method and Description
protected ServletWrapper	asServletWrapper()
void	close() Closes the component.
abstract AdaptrisMessage	createMessage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create an AdaptrisMessage from the incoming servlet request and response.
protected java.lang.String	ensureIsPath(java.lang.String s)
java.lang.Boolean	getAdditionalDebug()
TimeInterval	getMaxWaitTime() Deprecated. since 3.6.6 use getTimeoutAction() instead.
TimeInterval	getSendProcessingInterval()
TimeoutAction	getTimeoutAction()
TimeInterval	getWarnAfter()
java.lang.Long	getWarnAfterMessageHangMillis() Deprecated. since 3.5.1 use getWarnAfter() instead.
void	init() Initialises the component.
protected void	logHeaders(javax.servlet.http.HttpServletRequest req)
void	setAdditionalDebug(java.lang.Boolean additionalDebug)
void	setMaxWaitTime(TimeInterval maxWait) Deprecated. since 3.6.6 use setTimeoutAction(TimeoutAction) instead.
void	setSendProcessingInterval(TimeInterval t) If required send a 102 upon this interval.
void	setTimeoutAction(TimeoutAction action) Set the behaviour that should occur when the workflow takes too long to finish.
void	setWarnAfter(TimeInterval t) Log a warning after this interval.
void	setWarnAfterMessageHangMillis(java.lang.Long w) Deprecated. since 3.5.1 use setWarnAfter(TimeInterval) instead.
void	start() Starts the component.
void	stop() Stop the component

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, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, 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.ComponentLifecycleExtension

prepare

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isConfirmation, isTrackingEndpoint

Constructor Detail

BasicJettyConsumer

public BasicJettyConsumer()

Method Detail

createMessage

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

Create an AdaptrisMessage from the incoming servlet request and response.

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)

logHeaders

protected void logHeaders(javax.servlet.http.HttpServletRequest req)

asServletWrapper

protected ServletWrapper asServletWrapper()
                                   throws CoreException

Throws:

CoreException

ensureIsPath

protected java.lang.String ensureIsPath(java.lang.String s)
                                 throws CoreException

Throws:

CoreException

init

public void init()
          throws CoreException

Description copied from interface: ComponentLifecycle

Initialises the component.

Component initialisation includes config verification, creation of connections etc.

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.init()

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Throws:

CoreException - wrapping any underlying Exceptions

See Also:

ComponentLifecycle.start()

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

See Also:

ComponentLifecycle.stop()

close

public void close()

Description copied from interface: ComponentLifecycle

Closes the component.

A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

See Also:

ComponentLifecycle.close()

getMaxWaitTime

@Deprecated
 @Removal(version="3.9.0",
         message="Use #getTimeoutAction()")
public TimeInterval getMaxWaitTime()

Deprecated. since 3.6.6 use getTimeoutAction() instead.

Returns:

the maxWaitTime

setMaxWaitTime

@Deprecated
 @Removal(version="3.9.0",
         message="Use #setTimeoutAction(TimeoutAction)")
public void setMaxWaitTime(TimeInterval maxWait)

Deprecated. since 3.6.6 use setTimeoutAction(TimeoutAction) instead.

Set the max wait time for an individual worker in a workflow to finish.

This setting only has an impact if the consumer is the entry point for a PoolingWorkflow instance. In the event that the wait time is exceeded, then the internal HttpServlet instance commits the response in its current state and returns control back to the Jetty engine.

Parameters:

maxWait - the maxWaitTime to set (default 10 minutes)

getTimeoutAction

public TimeoutAction getTimeoutAction()

setTimeoutAction

public void setTimeoutAction(TimeoutAction action)

Set the behaviour that should occur when the workflow takes too long to finish.

This setting only has an impact if the consumer is the entry point for a PoolingWorkflow instance. In the event that the wait time is exceeded, then the behaviour specified here is done.

Parameters:

action - the action; default is a 202 after 10 minutes.

getAdditionalDebug

public java.lang.Boolean getAdditionalDebug()

setAdditionalDebug

public void setAdditionalDebug(java.lang.Boolean additionalDebug)

getWarnAfterMessageHangMillis

@Deprecated
 @Removal(version="3.9.0",
         message="Use #getWarnAfter()")
public java.lang.Long getWarnAfterMessageHangMillis()

Deprecated. since 3.5.1 use getWarnAfter() instead.

setWarnAfterMessageHangMillis

@Deprecated
 @Removal(version="3.9.0",
         message="Use #setWarnAfter(TimeInterval)")
public void setWarnAfterMessageHangMillis(java.lang.Long w)

Deprecated. since 3.5.1 use setWarnAfter(TimeInterval) instead.

getWarnAfter

public TimeInterval getWarnAfter()

Returns:

the warnAfter

setWarnAfter

public void setWarnAfter(TimeInterval t)

Log a warning after this interval.

Parameters:

t - the warnAfter to set, default is to never warn.

getSendProcessingInterval

public TimeInterval getSendProcessingInterval()

Returns:

the sendExpectEvery

setSendProcessingInterval

public void setSendProcessingInterval(TimeInterval t)

If required send a 102 upon this interval.

Parameters:

t - the sendExpectEvery to set, default is 20 seconds.