com.adaptris.core.http.jetty

Class JettyResponseService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.http.jetty.JettyResponseService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Send a HTTP Response",
                  tag="service,http,https,jetty",
                  since="3.6.5")
public class JettyResponseService
extends ServiceImp

Send a response via HTTP as a service rather than having to wrap in a StandaloneProducer.

Note that this service just wraps a StandardResponseProducer instance but doesn't expose all the possible settings available. If you need those features, than continue using the producer wrapped as a StandaloneProducer.

• It will also always send the current payload (i.e. ResponseProducerImpl.setSendPayload(Boolean) is true)
• ResponseProducerImpl.setForwardConnectionException(Boolean) is always false.
• ResponseProducerImpl.setFlushBuffer(Boolean) is always true.

String parameters in this service will use the InterlokMessage.resolve(String) which allows you to specify metadata values as part of a constant string e.g. setUrl("%message{http_url}") will use the metadata value associated with the key http_url.

Since:

3.6.5

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor and Description
JettyResponseService()
JettyResponseService(int status, java.lang.String contentType)

Method Summary

Modifier and Type	Method and Description
protected StandardResponseProducer	buildProducer(AdaptrisMessage msg)
protected void	closeService()
void	doService(AdaptrisMessage msg) Apply the service to the message.
java.lang.String	getContentType()
java.lang.String	getHttpStatus()
ResponseHeaderProvider<javax.servlet.http.HttpServletResponse>	getResponseHeaderProvider()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setContentType(java.lang.String ct)
void	setHttpStatus(java.lang.String s)
void	setResponseHeaderProvider(ResponseHeaderProvider<javax.servlet.http.HttpServletResponse> provider)
JettyResponseService	withContentType(java.lang.String type)
JettyResponseService	withHttpStatus(java.lang.String status)
JettyResponseService	withResponseHeaderProvider(ResponseHeaderProvider<javax.servlet.http.HttpServletResponse> provider)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

JettyResponseService

public JettyResponseService()

JettyResponseService

public JettyResponseService(int status,
                            java.lang.String contentType)

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

buildProducer

protected StandardResponseProducer buildProducer(AdaptrisMessage msg)

getHttpStatus

public java.lang.String getHttpStatus()

setHttpStatus

public void setHttpStatus(java.lang.String s)

Parameters:

s - the status, supports metadata resolution via InterlokMessage.resolve(String).

withHttpStatus

public JettyResponseService withHttpStatus(java.lang.String status)

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String ct)

Parameters:

ct - the content-type, supports metadata resolution via InterlokMessage.resolve(String).

withContentType

public JettyResponseService withContentType(java.lang.String type)

getResponseHeaderProvider

public ResponseHeaderProvider<javax.servlet.http.HttpServletResponse> getResponseHeaderProvider()

setResponseHeaderProvider

public void setResponseHeaderProvider(ResponseHeaderProvider<javax.servlet.http.HttpServletResponse> provider)

withResponseHeaderProvider

public JettyResponseService withResponseHeaderProvider(ResponseHeaderProvider<javax.servlet.http.HttpServletResponse> provider)