Interface MessagePublisherService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
public interface MessagePublisherService
extends com.appiancorp.services.ContextSensitiveService
Service to publish messages to Appian Process and JMS. To get a new instance of
this service, call
ServiceLocator.getMessagePublisherService(ServiceContext)
-
Field Summary
Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
publishMessage
(InternalJmsMessage message_) Publishes a message to the appropriate location.void
publishMessages
(InternalJmsMessage[] messages_) Publishes the provided messages to the appropriate locations.void
publishMessagesToJms
(InternalJmsMessage[] messages_) Publish the provided messages to JMS.void
publishMessagesToProcess
(InternalMessage[] messages_) Publishes the provided internal messages to Process.void
publishMessageToJms
(InternalJmsMessage message_) Publishes the message to JMS.void
publishMessageToProcess
(InternalMessage message_) Publishes an internal message to Process (ignores the JMS topic) on the message.void
publishMessageToProcess
(jakarta.mail.Message message_) Publishes a mail message to Process (ignores the JMS topic) on the message.void
publishMessageToProcess
(javax.jms.Message message_) Publishes a JMS message to Process (ignores the JMS topic) on the message.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Method Details
-
publishMessage
void publishMessage(InternalJmsMessage message_) throws NamingException, javax.jms.JMSException, InvalidJMSDestinationException Publishes a message to the appropriate location.- Parameters:
message_
- the message to publish- Throws:
javax.jms.JMSException
- if there is a problem involving the JMS providerNamingException
- if there is a JNDI problemInvalidJMSDestinationException
- See Also:
-
publishMessages
void publishMessages(InternalJmsMessage[] messages_) throws NamingException, javax.jms.JMSException, InvalidJMSDestinationException Publishes the provided messages to the appropriate locations. If the topic for a message is the configured Process topic (in jms.properties), that message is sent topublishMessagesToProcess(com.appiancorp.suiteapi.messaging.InternalMessage[])
, otherwise it is sent topublishMessagesToJms(com.appiancorp.suiteapi.messaging.InternalJmsMessage[])
- Parameters:
messages_
- the messages to publish- Throws:
javax.jms.JMSException
- if there is a problem involving the JMS providerNamingException
- if there is a JNDI problemInvalidJMSDestinationException
-
publishMessageToProcess
Publishes an internal message to Process (ignores the JMS topic) on the message.- Parameters:
message_
- the message to publish to process- Throws:
InvalidJMSDestinationException
- See Also:
-
publishMessageToProcess
void publishMessageToProcess(javax.jms.Message message_) throws javax.jms.JMSException, com.appiancorp.messaging.ProcessRouteMissingException, InvalidJMSDestinationException Publishes a JMS message to Process (ignores the JMS topic) on the message.- Parameters:
message_
- the message to publish to process- Throws:
javax.jms.JMSException
com.appiancorp.messaging.ProcessRouteMissingException
InvalidJMSDestinationException
- See Also:
-
#publishMessages(Message[])
-
publishMessageToProcess
void publishMessageToProcess(jakarta.mail.Message message_) throws jakarta.mail.MessagingException, com.appiancorp.messaging.ProcessRouteMissingException, InvalidJMSDestinationException Publishes a mail message to Process (ignores the JMS topic) on the message.- Parameters:
message_
- the message to publish to process- Throws:
jakarta.mail.MessagingException
com.appiancorp.messaging.ProcessRouteMissingException
InvalidJMSDestinationException
- See Also:
-
publishMessagesToProcess
Publishes the provided internal messages to Process. Currently, this sends the messages directly to the appropriate Process servers. For each message, if the message has any process model or event destinations, it is sent to all of the process destination servers (Process Design and all Process Execution servers). If the message only has process destinations, it is only sent to that process.- Parameters:
messages_
- the messages to publish- Throws:
InvalidJMSDestinationException
-
publishMessageToJms
void publishMessageToJms(InternalJmsMessage message_) throws NamingException, javax.jms.JMSException, InvalidJMSDestinationException Publishes the message to JMS.- Parameters:
message_
- the message to publish- Throws:
javax.jms.JMSException
- if there is a problem involving the JMS providerNamingException
- if there is a JNDI problemInvalidJMSDestinationException
- See Also:
-
publishMessagesToJms
void publishMessagesToJms(InternalJmsMessage[] messages_) throws NamingException, javax.jms.JMSException, InvalidJMSDestinationException Publish the provided messages to JMS. The topic that it publishes to is the topic specified byInternalJmsMessage.getTopic()
.- Parameters:
messages_
- the messages to publish- Throws:
javax.jms.JMSException
- if there is a problem involving the JMS providerNamingException
- if there is a JNDI problemInvalidJMSDestinationException
-