com.appiancorp.suiteapi.process.events

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, java.io.Serializable

public class MessageEventProducer
extends EventProducer

Represents a send message event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

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

Constructors

Constructor and Description
MessageEventProducer() Constructs a new MessageEventProducer.

Method Summary

Modifier and Type	Method and Description
void	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.
java.lang.String	getBody() Gets the body of the message that will be sent.
java.lang.String	getMessageType() Gets the message type (stored in the property mappings at key InternalMessage.JMS_TYPE_KEY).
Mapping[]	getPropertyMappings() Gets the property mappings.
java.lang.String	getTopic() Gets the JMS topic.
void	setBody(java.lang.String body_) Sets the body of the message that will be sent.
void	setPropertyMappings(Mapping[] propertyMappings_) Sets the property mappings.
void	setTopic(java.lang.String topic_) Sets the JMS topic.
java.lang.String	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

MessageEventProducer

public MessageEventProducer()

Constructs a new MessageEventProducer. If you do not know the specific event producer type, use EventProducer.createEventProducer(Long).

Method Detail

getBody

public java.lang.String getBody()

Gets the body of the message that will be sent.

Returns:

the body

See Also:

setBody(String)

setBody

public void setBody(java.lang.String body_)

Sets the body of the message that will be sent.

Parameters:

body_ - the body

See Also:

getBody()

getPropertyMappings

public Mapping[] getPropertyMappings()

Gets the property mappings.

Returns:

the property mappings

See Also:

setPropertyMappings(Mapping[])

setPropertyMappings

public void setPropertyMappings(Mapping[] propertyMappings_)

Sets the property mappings. If the Process Model UUID mapping or Process Model ID mapping is passed in and the value of either is null, both are set to empty arrays.

Parameters:

propertyMappings_ - the property mappings

See Also:

getPropertyMappings()

getTopic

public java.lang.String getTopic()

Gets the JMS topic.

Returns:

the JMS topic

See Also:

setTopic(String)

setTopic

public void setTopic(java.lang.String topic_)

Sets the JMS topic. Use the topic defined at com.appiancorp.suiteapi.messaging.MessagingProperties#PROCESS_TOPIC to send a message to Appian Process.

Parameters:

topic_ - the JMS topic

See Also:

getTopic()

getMessageType

public java.lang.String getMessageType()

Gets the message type (stored in the property mappings at key InternalMessage.JMS_TYPE_KEY).

Returns:

the message type

toString

public java.lang.String toString()

Overrides:

toString in class Event

fillInAppianTypes

public void 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.

Parameters:

cache_ - the cache that will hold the values