Class MessageEventProducer
java.lang.Object
com.appiancorp.suiteapi.process.events.Event
com.appiancorp.suiteapi.process.events.EventProducer
com.appiancorp.suiteapi.process.events.MessageEventProducer
- All Implemented Interfaces:
JSONable
,JSONCacheable
,Serializable
Represents a send message event.
- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.suiteapi.process.events.Event
ERROR_EVENT_TRIGGER, MESSAGE_EVENT_PRODUCER, MESSAGE_EVENT_TRIGGER, RULE_EVENT_TRIGGER, SORT_BY_DESC, SORT_BY_ID, SORT_BY_NAME, TERMINATE_EVENT_PRODUCER, TIMER_EVENT_TRIGGER
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
fillInAppianTypes
(AppianTypeCache cache_) Adds the primary keys of any Appian-typed objects that are used by the mapping of this node to the given cache.getBody()
Gets the body of the message that will be sent.Gets the message type (stored in the property mappings at keyInternalMessage.JMS_TYPE_KEY
).Mapping[]
Gets the property mappings.getTopic()
Gets the JMS topic.void
Sets the body of the message that will be sent.void
setPropertyMappings
(Mapping[] propertyMappings_) Sets the property mappings.void
Sets the JMS topic.toString()
Methods inherited from class com.appiancorp.suiteapi.process.events.EventProducer
createEventProducer, eventProducerClass
Methods inherited from class com.appiancorp.suiteapi.process.events.Event
getDesc, getHiddenAttributes, getId, getName, getPersistentId, getType, isProducerType, isTriggerType, setDesc, setId, setName, setPersistentId, setType
-
Field Details
-
LOG
protected static final org.apache.log4j.Logger LOG
-
-
Constructor Details
-
MessageEventProducer
public MessageEventProducer()Constructs a new MessageEventProducer. If you do not know the specific event producer type, useEventProducer.createEventProducer(Long)
.
-
-
Method Details
-
getBody
Gets the body of the message that will be sent.- Returns:
- the body
- See Also:
-
setBody
Sets the body of the message that will be sent.- Parameters:
body_
- the body- See Also:
-
getPropertyMappings
Gets the property mappings.- Returns:
- the property mappings
- See Also:
-
setPropertyMappings
Sets the property mappings. If the Process Model UUID mapping or Process Model ID mapping is passed in and the value of either isnull
, both are set to empty arrays.- Parameters:
propertyMappings_
- the property mappings- See Also:
-
getTopic
Gets the JMS topic.- Returns:
- the JMS topic
- See Also:
-
setTopic
Sets the JMS topic. Use the topic defined atcom.appiancorp.suiteapi.messaging.MessagingProperties#PROCESS_TOPIC
to send a message to Appian Process.- Parameters:
topic_
- the JMS topic- See Also:
-
getMessageType
Gets the message type (stored in the property mappings at keyInternalMessage.JMS_TYPE_KEY
).- Returns:
- the message type
-
toString
-
fillInAppianTypes
Adds the primary keys of any Appian-typed objects that are used by the mapping of this node to the given cache.- Parameters:
cache_
- the cache that will hold the values
-