flux.j2ee
Interface JmsAction

All Superinterfaces:

Action, java.lang.Cloneable, J2eeAction, RuntimeDataMap, java.io.Serializable

public interface JmsAction
extends J2eeAction

Publishes a JMS message to a JMS queue or JMS topic.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.Object	getBody() Returns the body of the message.
java.lang.String	getConnectionFactory() Returns the JMS queue or topic factory.
java.lang.String	getCorrelationId() Returns the JMS correlation ID for this JMS message.
java.lang.String	getDestinationName() Returns the name of the destination (queue or topic) for this JMS message.
JmsMessageType	getMessageType() Returns the kind of JMS message to be sent.
int	getPriority() Returns the JMS priority of this JMS message.
java.util.Map	getProperties() Returns the message properties.
java.lang.String	getReplyToName() Returns the name of the JMS reply-to destination (queue or topic) for this JMS message.
long	getTimeToLive() Returns the JMS time-to-live for this JMS message.
java.lang.String	getType() Returns the JMS type for this JMS message.
boolean	isDeliveryModePersistent() Indicates whether this JMS message is delivered as a persistent or non-persistent message.
boolean	isQueueMessages() Indicates whether this JMS action sends JMS queue messages or JMS topic messages.
void	setBody(java.lang.Object body) Sets the body of the message.
void	setConnectionFactory(java.lang.String connectionFactory) Sets the JMS queue or topic factory.
void	setCorrelationId(java.lang.String correlationId) Sets the JMS correlation ID for this JMS message.
void	setDeliveryModePersistent(boolean deliveryModePersistent) Sets whether this JMS message is delivered as a persistent or non-persistent message.
void	setDestinationName(java.lang.String destinationName) Sets the name of the destination (queue or topic) for this JMS message.
void	setMessageType(JmsMessageType messageType) Sets the kind of JMS message to be sent.
void	setPriority(int priority) Sets the JMS priority of this JMS message.
void	setProperties(java.util.Map properties) Sets the message properties.
void	setQueueMessages(boolean queueMessages) Sets whether this JMS action sends JMS queue messages or JMS topic messages.
void	setReplyToName(java.lang.String replyToName) Sets the name of the JMS reply-to destination (queue or topic) for this JMS message.
void	setTimeToLive(long timeToLive) Sets the JMS time-to-live for this JMS message.
void	setType(java.lang.String type) Sets the JMS type for this JMS message.

Methods inherited from interface flux.j2ee.J2eeAction

getExtraInitialContextProperties, getInitialContextFactory, getPassword, getProviderUrl, getUsername, setExtraInitialContextProperties, setInitialContextFactory, setPassword, setProviderUrl, setUsername

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getBody

java.lang.Object getBody()

Returns the body of the message. By default, body is null.

The actual type of the body argument depends on the message type. Text messages require a string body. Object messages require a serializable object. Bytes messages require a byte array. Stream messages require an array or list of Java primitives, strings, and byte arrays. Map messages require a map where each key must be a non-null and non-empty string and each value must be a Java primitive, string, or byte array.

Returns:

The body of the message.

getConnectionFactory

java.lang.String getConnectionFactory()

Returns the JMS queue or topic factory.

Returns:

The JMS queue or topic factory.

getCorrelationId

java.lang.String getCorrelationId()

Returns the JMS correlation ID for this JMS message. Defaults to null.

Returns:

The JMS correlation ID for this JMS message.

getDestinationName

java.lang.String getDestinationName()

Returns the name of the destination (queue or topic) for this JMS message.

Returns:

The name of the destination (queue or topic) for this JMS message.

getMessageType

JmsMessageType getMessageType()

Returns the kind of JMS message to be sent. By default, JMS text messages are sent.

Returns:

The kind of JMS message to be sent.

getPriority

int getPriority()

Returns the JMS priority of this JMS message. JMS defines priority values from 0 to 9. By default, the JMS priority is 4.

Returns:

The priority of this JMS message.

getProperties

java.util.Map getProperties()

Returns the message properties. By default, properties is null.

Returns:

The message properties. Each key must be a non-null and non-empty string. Each value must be a Java primitive or a string.

getReplyToName

java.lang.String getReplyToName()

Returns the name of the JMS reply-to destination (queue or topic) for this JMS message. Defaults to null.

Returns:

The name of the JMS reply-to destination (queue or topic) for this JMS message.

getTimeToLive

long getTimeToLive()

Returns the JMS time-to-live for this JMS message. By default, time-to-live is 0.

Returns:

The JMS time-to-live for this JMS message.

getType

java.lang.String getType()

Returns the JMS type for this JMS message. By default, type is null.

Returns:

The JMS type for this JMS message.

isDeliveryModePersistent

boolean isDeliveryModePersistent()

Indicates whether this JMS message is delivered as a persistent or non-persistent message. By default, delivery mode is persistent.

Returns:

Whether this JMS message is delivered as a persistent or non-persistent message.

isQueueMessages

boolean isQueueMessages()

Indicates whether this JMS action sends JMS queue messages or JMS topic messages. A true value means that JMS queue messages are sent. Otherwise, JMS topic messages are sent. By default, JMS queue messages are sent.

Returns:

Whether this JMS action sends JMS queue messages or JMS topic messages.

setBody

void setBody(java.lang.Object body)

Sets the body of the message. By default, body is null.

The actual type of the body argument depends on the message type. Text messages require a string body. Object messages require a serializable object. Bytes messages require a byte array. Stream messages require an array or list of Java primitives, strings, and byte arrays. Map messages require a map where each key must be a non-null and non-empty string and each value must be a Java primitive, string, or byte array.

Parameters:

body - The body of the message.

setConnectionFactory

void setConnectionFactory(java.lang.String connectionFactory)

Sets the JMS queue or topic factory.

Parameters:

connectionFactory - The JMS queue or topic factory.

setCorrelationId

void setCorrelationId(java.lang.String correlationId)

Sets the JMS correlation ID for this JMS message. Defaults to null.

Parameters:

correlationId - The JMS correlation ID for this JMS message.

setDeliveryModePersistent

void setDeliveryModePersistent(boolean deliveryModePersistent)

Sets whether this JMS message is delivered as a persistent or non-persistent message.

Parameters:

deliveryModePersistent - Whether this JMS message is delivered as a persistent or non-persistent message.

setDestinationName

void setDestinationName(java.lang.String destinationName)

Sets the name of the destination (queue or topic) for this JMS message.

Parameters:

destinationName - The name of the destination (queue or topic) for this JMS message.

setMessageType

void setMessageType(JmsMessageType messageType)

Sets the kind of JMS message to be sent. Changing a message type resets the body to null.

Parameters:

messageType - The kind of JMS message to be sent.

setProperties

void setProperties(java.util.Map properties)

Sets the message properties. By default, properties is null.

Parameters:

properties - The message properties. Each key must be a non-null and non-empty string. Each value must be a Java primitive or a string.

setQueueMessages

void setQueueMessages(boolean queueMessages)

Sets whether this JMS action sends JMS queue messages or JMS topic messages. A true value means that JMS queue messages are sent. Otherwise, JMS topic messages are sent. By default, JMS queue messages are sent.

Parameters:

queueMessages - Whether this JMS action sends JMS queue messages or JMS topic messages.

setPriority

void setPriority(int priority)

Sets the JMS priority of this JMS message. JMS defines priority values from 0 to 9.

Parameters:

priority - The priority of this JMS message.

setReplyToName

void setReplyToName(java.lang.String replyToName)

Sets the name of the JMS reply-to destination (queue or topic) for this JMS message.

Parameters:

replyToName - The name of the JMS reply-to destination (queue or topic) for this JMS message.

setTimeToLive

void setTimeToLive(long timeToLive)

Sets the JMS time-to-live for this JMS message. Must be greater than or equal to 0.

Parameters:

timeToLive - The JMS time-to-live for this JMS message.

setType

void setType(java.lang.String type)

Sets the JMS type for this JMS message.

Parameters:

type - The JMS type for this JMS message.