oracle.fmwplatform.envspec.model.blueprint.jms

Class JMSTemplate

java.lang.Object

oracle.fmwplatform.envspec.model.blueprint.jms.DestinationTunables

oracle.fmwplatform.envspec.model.blueprint.jms.JMSTemplate

public class JMSTemplate
extends DestinationTunables

A JMSTemplate is template that applies a set of configuration settings to a JMS artifact.

Since:

12.2.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMS_TEMPLATE_TOKEN The alias token used in the alias' WLST path for replacing with the JMSTemplate name.

Fields inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DestinationTunables

attachSender, consumptionPausedAtStartup, defaultUnitOfOrder, destinationKeys, incompleteWorkExpirationTime, insertionPausedAtStartup, maximumMessageSize, messagePerformancePreference, name, notes, productionPausedAtStartup, quota, safExportPolicy, unitOfWorkHandlingPolicy

Constructor Summary

Constructors

Constructor and Description
JMSTemplate()

Method Summary

Modifier and Type	Method and Description
String	getGroupParamsErrorDestination() Get the Error destination specified as part of the GroupParams folder.
String	getId() Get the id.
String	getSubDeploymentName() Get the sub-deployment name.
boolean	isGroupParamsEmpty() Determines whether or not the fields from the GroupParams folder are empty (i.e., not set).
JMSTemplate	setAttachSender(AttachSender attachSender) Set the attach sender configuration.
JMSTemplate	setBytesHigh(Long bytesHigh) Set the number of bytes high threshold.
JMSTemplate	setBytesLow(Long bytesLow) Set the number of bytes low threshold.
JMSTemplate	setConsumptionPausedAtStartup(Boolean consumptionPausedAtStartup) Set whether or not message consumption is paused at server startup.
JMSTemplate	setDefaultUnitOfOrder(Boolean defaultUnitOfOrder) Set the default unit of order.
JMSTemplate	setDeliveryMode(DeliveryMode deliveryMode) Set the message delivery mode.
JMSTemplate	setDestinationKeys(List<String> destinationKeys) Set the list of destination keys.
JMSTemplate	setErrorDestination(String errorDestination) Set the error destination.
JMSTemplate	setExpirationLoggingPolicy(String expirationLoggingPolicy) Set the message expiration logging policy.
JMSTemplate	setExpirationPolicy(ExpirationPolicy expirationPolicy) Set the message expiration policy.
JMSTemplate	setGroupParamsErrorDestination(String groupParamsErrorDestination) Set the Error destination specified as part of the GroupParams folder.
JMSTemplate	setId(String id) Set the id.
JMSTemplate	setIncompleteWorkExpirationTime(Integer incompleteWorkExpirationTime) Set the incomplete work expiration time.
JMSTemplate	setInsertionPausedAtStartup(Boolean insertionPausedAtStartup) Set whether or not message insertion is paused at server startup.
JMSTemplate	setMaximumMessageSize(Integer maximumMessageSize) Set the maximum message size.
JMSTemplate	setMessageLoggingEnabled(Boolean messageLoggingEnabled) Set whether or not message logging is enabled.
JMSTemplate	setMessageLoggingFormat(String messageLoggingFormat) Set the message logging format.
JMSTemplate	setMessagePerformancePreference(MessagePerformancePreference messagePerformancePreference) Set the message performance preference.
JMSTemplate	setMessagesHigh(Long messagesHigh) Set the number of messages high threshold.
JMSTemplate	setMessagesLow(Long messagesLow) Set the number of messages low threshold.
JMSTemplate	setName(String name) Set the name.
JMSTemplate	setNotes(String notes) Set the notes.
JMSTemplate	setPriority(Integer priority) Set the message priority.
JMSTemplate	setProductionPausedAtStartup(Boolean productionPausedAtStartup) Set whether or not message production is paused at server startup.
JMSTemplate	setQuota(String quota) Set the quota.
JMSTemplate	setRedeliveryDelay(Long redeliveryDelay) Set the message redelivery delay.
JMSTemplate	setRedeliveryLimit(Integer redeliveryLimit) Set the message redelivery limit.
JMSTemplate	setSafExportPolicy(SAFExportPolicy safExportPolicy) Set the SAF export policy.
JMSTemplate	setSubDeploymentName(String subDeploymentName) Set the sub-deployment name.
JMSTemplate	setTimeToDeliver(String timeToDeliver) Set the time to deliver.
JMSTemplate	setTimeToLive(Long timeToLive) Set the time to live.
JMSTemplate	setUnitOfWorkHandlingPolicy(UnitOfWorkHandlingPolicy unitOfWorkHandlingPolicy) Set the unit of work handling policy.
String	toCompactString() Returns a compact string representation of the object in XML format.
String	toJsonCompactString() Returns a compact string representation of the object in JSON format.
String	toJsonString() Returns a string representation of the object in JSON format.
String	toString() Returns a string representation of the object in XML format.
String	toXmlCompactString() Returns a compact string representation of the object in XML format.
String	toXmlString() Returns a string representation of the object in XML format.

Methods inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DestinationTunables

getAttachSender, getBytesHigh, getBytesLow, getConsumptionPausedAtStartup, getDefaultUnitOfOrder, getDeliveryMode, getDestinationKeys, getErrorDestination, getExpirationLoggingPolicy, getExpirationPolicy, getIncompleteWorkExpirationTime, getInsertionPausedAtStartup, getMaximumMessageSize, getMessageLoggingEnabled, getMessageLoggingFormat, getMessagePerformancePreference, getMessagesHigh, getMessagesLow, getName, getNotes, getPriority, getProductionPausedAtStartup, getQuota, getRedeliveryDelay, getRedeliveryLimit, getSafExportPolicy, getTimeToDeliver, getTimeToLive, getUnitOfWorkHandlingPolicy, isDeliveryFailureParamsEmpty, isDeliveryParamsOverridesEmpty, isMessageLoggingParamsEmpty, isThresholdsEmpty

Methods inherited from class java.lang.Object

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

Field Detail

JMS_TEMPLATE_TOKEN

public static final String JMS_TEMPLATE_TOKEN

The alias token used in the alias' WLST path for replacing with the JMSTemplate name.

See Also:

Constant Field Values

Constructor Detail

JMSTemplate

public JMSTemplate()

Method Detail

getId

public String getId()

Get the id.

Returns:

the id

setId

public JMSTemplate setId(String id)

Set the id.

Parameters:

id - the id to set

Returns:

the current JMSTemplate object

getGroupParamsErrorDestination

public String getGroupParamsErrorDestination()

Get the Error destination specified as part of the GroupParams folder.

Returns:

the Error destination specified as part of the GroupParams folder

setGroupParamsErrorDestination

public JMSTemplate setGroupParamsErrorDestination(String groupParamsErrorDestination)

Set the Error destination specified as part of the GroupParams folder.

Parameters:

groupParamsErrorDestination - the new Error destination

Returns:

the current JMSTemplate object

getSubDeploymentName

public String getSubDeploymentName()

Get the sub-deployment name.

Returns:

the sub-depoloyment name

setSubDeploymentName

public JMSTemplate setSubDeploymentName(String subDeploymentName)

Set the sub-deployment name.

Parameters:

subDeploymentName - the new sub-deployment name

Returns:

the current JMSTemplate object

isGroupParamsEmpty

public boolean isGroupParamsEmpty()

Determines whether or not the fields from the GroupParams folder are empty (i.e., not set).

Returns:

whether or not the fields from the GroupParams folder are empty

setAttachSender

public JMSTemplate setAttachSender(AttachSender attachSender)

Set the attach sender configuration.

Overrides:

setAttachSender in class DestinationTunables

Parameters:

attachSender - the new attach sender configuration

Returns:

the current DestinationTunables object

setConsumptionPausedAtStartup

public JMSTemplate setConsumptionPausedAtStartup(Boolean consumptionPausedAtStartup)

Set whether or not message consumption is paused at server startup.

Overrides:

setConsumptionPausedAtStartup in class DestinationTunables

Parameters:

consumptionPausedAtStartup - the new value

Returns:

the current DestinationTunables object

setDefaultUnitOfOrder

public JMSTemplate setDefaultUnitOfOrder(Boolean defaultUnitOfOrder)

Set the default unit of order.

Overrides:

setDefaultUnitOfOrder in class DestinationTunables

Parameters:

defaultUnitOfOrder - the new default unit of order

Returns:

the current DestinationTunables object

setDestinationKeys

public JMSTemplate setDestinationKeys(List<String> destinationKeys)

Set the list of destination keys.

Overrides:

setDestinationKeys in class DestinationTunables

Parameters:

destinationKeys - the new list

Returns:

the current DestinationTunables object

setIncompleteWorkExpirationTime

public JMSTemplate setIncompleteWorkExpirationTime(Integer incompleteWorkExpirationTime)

Set the incomplete work expiration time.

Overrides:

setIncompleteWorkExpirationTime in class DestinationTunables

Parameters:

incompleteWorkExpirationTime - the new value

Returns:

the current DestinationTunables object

setInsertionPausedAtStartup

public JMSTemplate setInsertionPausedAtStartup(Boolean insertionPausedAtStartup)

Set whether or not message insertion is paused at server startup.

Overrides:

setInsertionPausedAtStartup in class DestinationTunables

Parameters:

insertionPausedAtStartup - the new value

Returns:

the current DestinationTunables object

setMaximumMessageSize

public JMSTemplate setMaximumMessageSize(Integer maximumMessageSize)

Set the maximum message size.

Overrides:

setMaximumMessageSize in class DestinationTunables

Parameters:

maximumMessageSize - the new maximum message size

Returns:

the current DestinationTunables object

setMessagePerformancePreference

public JMSTemplate setMessagePerformancePreference(MessagePerformancePreference messagePerformancePreference)

Set the message performance preference.

Overrides:

setMessagePerformancePreference in class DestinationTunables

Parameters:

messagePerformancePreference - the new value

Returns:

the current DestinationTunables object

setName

public JMSTemplate setName(String name)

Set the name.

Overrides:

setName in class DestinationTunables

Parameters:

name - the new name

Returns:

the current DestinationTunables object

setNotes

public JMSTemplate setNotes(String notes)

Set the notes.

Overrides:

setNotes in class DestinationTunables

Parameters:

notes - the new value

Returns:

the current DestinationTunables object

setProductionPausedAtStartup

public JMSTemplate setProductionPausedAtStartup(Boolean productionPausedAtStartup)

Set whether or not message production is paused at server startup.

Overrides:

setProductionPausedAtStartup in class DestinationTunables

Parameters:

productionPausedAtStartup - the new value

Returns:

the current DestinationTunables object

setQuota

public JMSTemplate setQuota(String quota)

Set the quota.

Overrides:

setQuota in class DestinationTunables

Parameters:

quota - the new quota

Returns:

the current DestinationTunables object

setSafExportPolicy

public JMSTemplate setSafExportPolicy(SAFExportPolicy safExportPolicy)

Set the SAF export policy.

Overrides:

setSafExportPolicy in class DestinationTunables

Parameters:

safExportPolicy - the new SAF export policy

Returns:

the current DestinationTunables object

setUnitOfWorkHandlingPolicy

public JMSTemplate setUnitOfWorkHandlingPolicy(UnitOfWorkHandlingPolicy unitOfWorkHandlingPolicy)

Set the unit of work handling policy.

Overrides:

setUnitOfWorkHandlingPolicy in class DestinationTunables

Parameters:

unitOfWorkHandlingPolicy - the new unit of work handling policy

Returns:

the current DestinationTunables object

setErrorDestination

public JMSTemplate setErrorDestination(String errorDestination)

Set the error destination.

Overrides:

setErrorDestination in class DestinationTunables

Parameters:

errorDestination - the new value

Returns:

the current DestinationTunables object

setExpirationLoggingPolicy

public JMSTemplate setExpirationLoggingPolicy(String expirationLoggingPolicy)

Set the message expiration logging policy.

Overrides:

setExpirationLoggingPolicy in class DestinationTunables

Parameters:

expirationLoggingPolicy - the new value

Returns:

the current DestinationTunables object

setExpirationPolicy

public JMSTemplate setExpirationPolicy(ExpirationPolicy expirationPolicy)

Set the message expiration policy.

Overrides:

setExpirationPolicy in class DestinationTunables

Parameters:

expirationPolicy - the new message expiration policy

Returns:

the current DestinationTunables object

setRedeliveryLimit

public JMSTemplate setRedeliveryLimit(Integer redeliveryLimit)

Set the message redelivery limit.

Overrides:

setRedeliveryLimit in class DestinationTunables

Parameters:

redeliveryLimit - the new message redelivery limit

Returns:

the current DestinationTunables object

setDeliveryMode

public JMSTemplate setDeliveryMode(DeliveryMode deliveryMode)

Set the message delivery mode.

Overrides:

setDeliveryMode in class DestinationTunables

Parameters:

deliveryMode - the new message delivery mode

Returns:

the current DestinationTunables object

setPriority

public JMSTemplate setPriority(Integer priority)

Set the message priority.

Overrides:

setPriority in class DestinationTunables

Parameters:

priority - the new message priority

Returns:

the current DestinationTunables object

setRedeliveryDelay

public JMSTemplate setRedeliveryDelay(Long redeliveryDelay)

Set the message redelivery delay.

Overrides:

setRedeliveryDelay in class DestinationTunables

Parameters:

redeliveryDelay - the new message redelivery delay

Returns:

the current DestinationTunables object

setTimeToDeliver

public JMSTemplate setTimeToDeliver(String timeToDeliver)

Set the time to deliver.

Overrides:

setTimeToDeliver in class DestinationTunables

Parameters:

timeToDeliver - the new time to deliver

Returns:

the current DestinationTunables object

setTimeToLive

public JMSTemplate setTimeToLive(Long timeToLive)

Set the time to live.

Overrides:

setTimeToLive in class DestinationTunables

Parameters:

timeToLive - the new time to live

Returns:

the current DestinationTunables object

setMessageLoggingEnabled

public JMSTemplate setMessageLoggingEnabled(Boolean messageLoggingEnabled)

Set whether or not message logging is enabled.

Overrides:

setMessageLoggingEnabled in class DestinationTunables

Parameters:

messageLoggingEnabled - the new value

Returns:

the current DestinationTunables object

setMessageLoggingFormat

public JMSTemplate setMessageLoggingFormat(String messageLoggingFormat)

Set the message logging format.

Overrides:

setMessageLoggingFormat in class DestinationTunables

Parameters:

messageLoggingFormat - the new message logging format

Returns:

the current DestinationTunables object

setBytesHigh

public JMSTemplate setBytesHigh(Long bytesHigh)

Set the number of bytes high threshold.

Overrides:

setBytesHigh in class DestinationTunables

Parameters:

bytesHigh - the new number of bytes high threshold

Returns:

the current DestinationTunables object

setBytesLow

public JMSTemplate setBytesLow(Long bytesLow)

Set the number of bytes low threshold.

Overrides:

setBytesLow in class DestinationTunables

Parameters:

bytesLow - the new number of bytes low threshold

Returns:

the current DestinationTunables object

setMessagesHigh

public JMSTemplate setMessagesHigh(Long messagesHigh)

Set the number of messages high threshold.

Overrides:

setMessagesHigh in class DestinationTunables

Parameters:

messagesHigh - the number of messages high threshold

Returns:

the current DestinationTunables object

setMessagesLow

public JMSTemplate setMessagesLow(Long messagesLow)

Set the number of messages low threshold.

Overrides:

setMessagesLow in class DestinationTunables

Parameters:

messagesLow - the new number of messages low threshold

Returns:

the current DestinationTunables object

toXmlCompactString

public String toXmlCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

toXmlString

public String toXmlString()

Returns a string representation of the object in XML format.

Returns:

a string representation of the object in XML format

toJsonCompactString

public String toJsonCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toJsonString

public String toJsonString()

Returns a string representation of the object in JSON format.

Returns:

a string representation of the object in JSON format

toCompactString

public String toCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

toString

public String toString()

Returns a string representation of the object in XML format.

Overrides:

toString in class Object

Returns:

a string representation of the object in XML format