@ComponentProfile(summary="Place message on a JMS Queue",
tag="producer,jms",
recommended=JmsConnection.class)
public class PtpProducer
extends DefinedJmsProducer
AdaptrisMessageProducer implementation for Queue based JMS.
This implementation baselines to JMS 1.1 for minimum API support and its behaviour and support for standard JMS Headers can be controlled in a number of ways.
When converting from an AdaptrisMessage into a standard Message; you
should choose an implementation of MessageTypeTranslator. The more common types are
BytesMessageTranslator, TextMessageTranslator, ObjectMessageTranslator
and MapMessageTranslator which correspond to BytesMessage,
TextMessage, ObjectMessage and MapMessage
respectively. Each MessageTypeTranslator will allow you to move some or all metadata from
the AdaptrisMessage to the JMS Message. Of course, there are other vendor specific JMS message
types can be used.
The Message.getJMSCorrelationID() field is generally used for linking one
message to with another. It typically links a reply message with the originating request message.
If you need to handle the correlation id in some fashion then typically you would choose an
implementation of CorrelationIdSource that explicitly handles the correlation ID; for
instance MetadataCorrelationIdSource.
Synchronous request/reply messaging behaviour is available for this producer and relies heavily
on the Message.getJMSReplyTo() field. Normally if the adapter is initiating the
request then a temporary destination is created and this is used as the JMSReplyTo field.
Sometimes you may wish to specify your own JMSReplyTo field (where the JMS Vendor doesn't play
nice with temporary queues). To do this, then you need to ensure that the metadata key
"JMSAsyncStaticReplyTo" is set with the appropriate
queue name; this will cause that message to be produced to the queue with a JMSReplyTo set to
that queue. You may also use
"JMSAsyncStaticReplyTo" in an asynchronous
workflow; if the metadata key exists in the message then it will be used to populate the
JMSReplyTo Field.
By convention, the Message.getJMSPriority(),
Message.getJMSDeliveryMode(), and Message.getJMSExpiration()
are configured directly (expiration here is semantically equivalent to the element
JmsProducerImpl.setTtl(Long) on the producer. It is possible to control it dynamically on a per message
basis using the element JmsProducerImpl.setPerMessageProperties(Boolean). If you opt to control these
fields on a per message basis then the following metadata keys are used :
DeliveryModeIn the adapter configuration file this class is aliased as jms-queue-producer which is the preferred alternative to the fully qualified classname when building your configuration.
producerSessionlogCONFIRMATION_ID_KEY| Constructor and Description |
|---|
PtpProducer() |
PtpProducer(ProduceDestination d) |
| Modifier and Type | Method and Description |
|---|---|
protected javax.jms.Queue |
createDestination(java.lang.String name) |
protected javax.jms.Destination |
createTemporaryDestination() |
doRequest, produce, produceacknowledge, calculateDeliveryMode, calculatePriority, calculateTimeToLive, captureOutgoingMessageDetails, captureOutgoingMessageDetails, close, commit, configuredAcknowledgeMode, configuredCorrelationIdSource, configuredMessageListener, configuredMessageTranslator, createDestination, currentLogger, currentSession, defaultTimeout, getAcknowledgeMode, getCaptureOutgoingMessageDetails, getCorrelationIdSource, getDeliveryMode, getMessageTranslator, getPerMessageProperties, getPriority, getSessionFactory, getTimeToLive, getTtl, init, isManagedTransaction, logLinkedException, messagePriority, perMessageProperties, prepare, rollback, rollbackTimeout, setAcknowledgeMode, setCaptureOutgoingMessageDetails, setCorrelationIdSource, setDeliveryMode, setMessageTranslator, setPerMessageProperties, setPriority, setSessionFactory, setTtl, setupSession, start, stop, timeToLive, translategetIgnoreReplyMetadata, produce, request, request, request, request, setIgnoreReplyMetadata, shouldIgnoreReplyMetadatagetDestination, setDestinationcreateName, createQualifier, decode, encode, getEncoder, getIsConfirmation, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isConfirmation, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsConfirmation, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactoryclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdecode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactorygetUniqueIdcreateName, createQualifier, isConfirmation, isTrackingEndpointpublic PtpProducer()
public PtpProducer(ProduceDestination d)
protected javax.jms.Queue createDestination(java.lang.String name)
throws javax.jms.JMSException
createDestination in class DefinedJmsProducerjavax.jms.JMSExceptionprotected javax.jms.Destination createTemporaryDestination()
throws javax.jms.JMSException
createTemporaryDestination in class DefinedJmsProducerjavax.jms.JMSException