com.adaptris.core

Interface AdaptrisMessageProducer

All Superinterfaces:

AdaptrisComponent, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

All Known Implementing Classes:

AdaptrisMessageProducerImp, DefinedJmsProducer, FsProducer, FtpProducer, HttpProducer, JdbcStoredProcedureProducer, JmsAsyncProducer, JmsProducer, JmsProducerImpl, LargeFsProducer, NullMessageProducer, PasProducer, ProduceOnlyProducerImp, PtpProducer, RelaxedFtpProducer, RequestReplyProducerImp, ResponseProducerImpl, StandardHttpProducer, StandardResponseProducer

public interface AdaptrisMessageProducer
extends AdaptrisMessageWorker, AdaptrisMessageSender

Implementations of AdaptrisMessageProducer produce messages to a destination (such as a JMS Queue or file system directory).

See Also:

AdaptrisMessageSender

Field Summary

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Method Summary

Modifier and Type	Method and Description
ProduceDestination	getDestination() Returns the default ProduceDestination for this instance.
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 to the configured ProduceDestination and blocks for the specified timeout for a reply.
AdaptrisMessage	request(AdaptrisMessage msg, ProduceDestination destination) Produces the AdaptrisMessage to the passed supplied ProduceDestination and blocks indefinitely for a reply.
AdaptrisMessage	request(AdaptrisMessage msg, ProduceDestination destination, long timeoutMs) Produces the AdaptrisMessage to the passed supplied ProduceDestination and blocks for the specified timeout for a reply.
void	setDestination(ProduceDestination destination) Set the default ProduceDestination.

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

close, init, start, stop

Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension

prepare

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.AdaptrisMessageSender

produce, produce

Method Detail

request

AdaptrisMessage request(AdaptrisMessage msg)
                 throws ProduceException

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

AdaptrisMessage request(AdaptrisMessage msg,
                        ProduceDestination destination)
                 throws ProduceException

Produces the AdaptrisMessage to the passed supplied ProduceDestination and blocks indefinitely for a reply.

Parameters:

msg - the AdaptrisMessage to produce

destination - the ProduceDestination to produce to

Returns:

a reply AdaptrisMessage which is generally the same as supplied parameter

Throws:

ProduceException - wrapping any underlying Exceptions

request

AdaptrisMessage request(AdaptrisMessage msg,
                        ProduceDestination destination,
                        long timeoutMs)
                 throws ProduceException

Produces the AdaptrisMessage to the passed supplied ProduceDestination and blocks for the specified timeout for a reply.

Parameters:

msg - the AdaptrisMessage to produce

destination - the ProduceDestination to produce to

timeoutMs - 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

request

AdaptrisMessage request(AdaptrisMessage msg,
                        long timeout)
                 throws ProduceException

Produces the AdaptrisMessage to the configured ProduceDestination 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

getDestination

ProduceDestination getDestination()

Returns the default ProduceDestination for this instance.

Returns:

the ProduceDestination used in the absence of any other information.

setDestination

void setDestination(ProduceDestination destination)

Set the default ProduceDestination.

Parameters:

destination - the ProduceDestination to use