com.adaptris.core.http.jetty

Class StandardResponseProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.ProduceOnlyProducerImp

com.adaptris.core.http.jetty.ResponseProducerImpl

com.adaptris.core.http.jetty.StandardResponseProducer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

@ComponentProfile(summary="Write and commit the HTTP Response",
                  tag="producer,http,https",
                  recommended=NullConnection.class)
public class StandardResponseProducer
extends ResponseProducerImpl

Implementation of AdaptrisMessageProducer writes to the HttpServletResponse object metadata provided by the Jetty engine.

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

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
StandardResponseProducer()
StandardResponseProducer(HttpStatusProvider.HttpStatus status)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the component.
void	init() Initialises the component.
void	prepare() Prepare for initialisation.
void	produce(AdaptrisMessage msg, ProduceDestination destination) Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.
void	start() Starts the component.
void	stop() Stop the component

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

flushBuffers, forwardConnectionException, getContentTypeProvider, getFlushBuffer, getForwardConnectionException, getResponseHeaderProvider, getSendPayload, getStatus, getStatusProvider, sendPayload, setContentTypeProvider, setFlushBuffer, setForwardConnectionException, setResponseHeaderProvider, setSendPayload, setStatusProvider, withContentTypeProvider, withFlushBuffer, withForwardConnectionException, withResponseHeaderProvider, withSendPayload, withStatusProvider

Methods inherited from class com.adaptris.core.ProduceOnlyProducerImp

produce, request, request, request, request

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, 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

StandardResponseProducer

public StandardResponseProducer()

StandardResponseProducer

public StandardResponseProducer(HttpStatusProvider.HttpStatus status)

Method Detail

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

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

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

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

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination destination)
             throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.

Parameters:

msg - the AdaptrisMessage to produce

destination - the ProduceDestination to produce to

Throws:

ProduceException - wrapping any underlying Exceptions