Package com.adaptris.core

Class RequestReplyProducerImp

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.RequestReplyProducerBase

com.adaptris.core.RequestReplyProducerImp

All Implemented Interfaces:

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

Direct Known Subclasses:

HttpProducer, JdbcStoredProcedureProducer

public abstract class RequestReplyProducerImp
extends RequestReplyProducerBase

Abstract Request Reply enabled producer that may be extended by concrete sub-classes.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
RequestReplyProducerImp()

Method Summary

Modifier and Type	Method	Description
protected abstract void	doProduce(AdaptrisMessage msg, java.lang.String endpoint)	Actually do the produce.
protected abstract AdaptrisMessage	doRequest(AdaptrisMessage msg, java.lang.String endpoint, long timeout)	Actually do the request.
void	produce(AdaptrisMessage msg)	Produces the AdaptrisMessage to the default destination.
AdaptrisMessage	request(AdaptrisMessage msg)	Produce the AdaptrisMessage to the configured destination and blocks indefinitely for a reply.
AdaptrisMessage	request(AdaptrisMessage msg, long timeout)	Produces the AdaptrisMessage and blocks for the specified timeout for a reply.

Methods inherited from class com.adaptris.core.RequestReplyProducerBase

copyReplyContents, defaultTimeout, getIgnoreReplyMetadata, mergeReply, setIgnoreReplyMetadata

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

createName, endpoint

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

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

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.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

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

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init, start, stop

Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension

prepare

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createQualifier, isTrackingEndpoint

Constructor Detail

RequestReplyProducerImp

public RequestReplyProducerImp()

Method Detail

produce

public final void produce(AdaptrisMessage msg)
                   throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produces the AdaptrisMessage to the default destination.

Parameters:

msg - the @link AdaptrisMessage} to produce

Throws:

ProduceException - wrapping any underlying Exceptions

request

public final AdaptrisMessage request(AdaptrisMessage msg)
                              throws ProduceException

Description copied from interface: AdaptrisMessageProducer

Produce the AdaptrisMessage to the configured destination and blocks indefinitely for a reply.

Parameters:

msg - the AdaptrisMessage to produce

Returns:

a reply AdaptrisMessage which is generally the same as supplied parameter

Throws:

ProduceException - wrapping any underlying Exceptions

request

public final AdaptrisMessage request(AdaptrisMessage msg,
                                     long timeout)
                              throws ProduceException

Description copied from interface: AdaptrisMessageProducer

Produces the AdaptrisMessage and blocks for the specified timeout for a reply.

Parameters:

msg - the AdaptrisMessage to produce

timeout - the time to wait for a reply in milliseconds

Returns:

a reply AdaptrisMessage which is generally the same as supplied parameter

Throws:

ProduceException - wrapping any underlying Exceptions

doRequest

protected abstract AdaptrisMessage doRequest(AdaptrisMessage msg,
                                             java.lang.String endpoint,
                                             long timeout)
                                      throws ProduceException

Actually do the request.

Throws:

ProduceException

doProduce

protected abstract void doProduce(AdaptrisMessage msg,
                                  java.lang.String endpoint)
                           throws ProduceException

Actually do the produce.

Throws:

ProduceException