|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.commerce.messaging.SourceSinkTemplate atg.commerce.messaging.MessageSender
public class MessageSender
This class is a generci MessageSender. It can be configured to
send over a specific port through patchbay. It is a convenient way
to send messages from request scoped comnponents. Just create a nucleus instance
of this component, configure it in patchbay (/atg/dynamo/messaging/dynamoMessageSystem.xml)
and reference it from the request scoped component. Use sendCommerceMessage
to send the message.
MessageSource
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
DEFAULT_MESSAGE_SOURCE_NAME
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
MessageSender()
|
Method Summary | |
---|---|
IdGenerator |
getMessageIdGenerator()
The service that generates Ids for all messages. |
java.lang.String |
getMessageIdSpaceName()
The name of the idspace to get our message ids from |
MessageSourceContext |
getMessageSourceContext()
Return the message source context for this source. |
java.lang.String |
getMessageSourceName()
The string used as the source of messages. |
java.lang.String |
getNextMessageId()
Uses the id generator to get the next message id. |
java.lang.String |
getPortName()
The name of the PortName to send messages out of. |
boolean |
isAllowMessageSending()
This class cannot send messages if this is false. |
void |
sendCommerceMessage(CommerceMessage pMessage)
Uses the SourceSinkTemplate to send a commerce message
over portName |
void |
setAllowMessageSending(boolean pAllowMessageSending)
|
void |
setMessageIdGenerator(IdGenerator pMessageIdGenerator)
|
void |
setMessageIdSpaceName(java.lang.String pMessageIdSpaceName)
|
void |
setMessageSourceContext(MessageSourceContext pMessageSourceContext)
Set the message source context for this source. |
void |
setMessageSourceName(java.lang.String pMessageSourceName)
|
void |
setPortName(java.lang.String pPortName)
|
void |
startMessageSource()
This is called to tell the MessageSource that it may begin sending messages. |
void |
stopMessageSource()
This is called to tell the MessageSource that it should stop sending messages. |
Methods inherited from class atg.commerce.messaging.SourceSinkTemplate |
---|
getDelayOnSendRetry, getTransactionManager, receiveMessage, sendCommerceMessage, sendObjectMessage, setDelayOnSendRetry, setTransactionManager |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String DEFAULT_MESSAGE_SOURCE_NAME
Constructor Detail |
---|
public MessageSender()
Method Detail |
---|
public void setPortName(java.lang.String pPortName)
public java.lang.String getPortName()
public void setMessageSourceName(java.lang.String pMessageSourceName)
setMessageSourceName
in class SourceSinkTemplate
public java.lang.String getMessageSourceName()
getMessageSourceName
in class SourceSinkTemplate
public void setMessageSourceContext(MessageSourceContext pMessageSourceContext)
SourceSinkTemplate
setMessageSourceContext
in interface MessageSource
setMessageSourceContext
in class SourceSinkTemplate
MessageSource
public MessageSourceContext getMessageSourceContext()
getMessageSourceContext
in class SourceSinkTemplate
public void setMessageIdGenerator(IdGenerator pMessageIdGenerator)
public IdGenerator getMessageIdGenerator()
public void setMessageIdSpaceName(java.lang.String pMessageIdSpaceName)
public java.lang.String getMessageIdSpaceName()
public void setAllowMessageSending(boolean pAllowMessageSending)
setAllowMessageSending
in class SourceSinkTemplate
public boolean isAllowMessageSending()
SourceSinkTemplate
isAllowMessageSending
in class SourceSinkTemplate
public void startMessageSource()
startMessageSource
in interface MessageSource
startMessageSource
in class SourceSinkTemplate
public void stopMessageSource()
stopMessageSource
in interface MessageSource
stopMessageSource
in class SourceSinkTemplate
public void sendCommerceMessage(CommerceMessage pMessage) throws javax.jms.JMSException
SourceSinkTemplate
to send a commerce message
over portName
pMessage
- The message to be sent
javax.jms.JMSException
public java.lang.String getNextMessageId()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |