oracle.fmwplatform.envspec.model.blueprint.jms

Class Queue

java.lang.Object

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

oracle.fmwplatform.envspec.model.blueprint.jms.Destination

oracle.fmwplatform.envspec.model.blueprint.jms.Queue

public class Queue
extends Destination

A Queue is JMS destination for point-to-point messaging.

Since:

12.2.2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMS_QUEUE_TOKEN The alias token used in the alias' WLST path for replacing with the Queue 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
Queue()

Method Summary

Modifier and Type	Method and Description
Queue	setAttachSender(AttachSender attachSender) Set the attach sender configuration.
Queue	setBytesHigh(Long bytesHigh) Set the number of bytes high threshold.
Queue	setBytesLow(Long bytesLow) Set the number of bytes low threshold.
Queue	setConsumptionPausedAtStartup(Boolean consumptionPausedAtStartup) Set whether or not message consumption is paused at server startup.
Queue	setDefaultTargetingEnabled(Boolean defaultTargetingEnabled) Set whether or not default targeting is enabled.
Queue	setDefaultUnitOfOrder(Boolean defaultUnitOfOrder) Set the default unit of order.
Queue	setDeliveryMode(DeliveryMode deliveryMode) Set the message delivery mode.
Queue	setDestinationKeys(List<String> destinationKeys) Set the list of destination keys.
Queue	setErrorDestination(String errorDestination) Set the error destination.
Queue	setExpirationLoggingPolicy(String expirationLoggingPolicy) Set the message expiration logging policy.
Queue	setExpirationPolicy(ExpirationPolicy expirationPolicy) Set the message expiration policy.
Queue	setId(String id) Set the id.
Queue	setIncompleteWorkExpirationTime(Integer incompleteWorkExpirationTime) Set the incomplete work expiration time.
Queue	setInsertionPausedAtStartup(Boolean insertionPausedAtStartup) Set whether or not message insertion is paused at server startup.
Queue	setJmsCreateDestinationIdentifier(String jmsCreateDestinationIdentifier) Set the JMS create destination identifier.
Queue	setJndiName(String jndiName) Set the JNDI name.
Queue	setLocalJndiName(String localJndiName) Set the local JNDI name
Queue	setMaximumMessageSize(Integer maximumMessageSize) Set the maximum message size.
Queue	setMessageLoggingEnabled(Boolean messageLoggingEnabled) Set whether or not message logging is enabled.
Queue	setMessageLoggingFormat(String messageLoggingFormat) Set the message logging format.
Queue	setMessagePerformancePreference(MessagePerformancePreference messagePerformancePreference) Set the message performance preference.
Queue	setMessagesHigh(Long messagesHigh) Set the number of messages high threshold.
Queue	setMessagesLow(Long messagesLow) Set the number of messages low threshold.
Queue	setName(String name) Set the name.
Queue	setNotes(String notes) Set the notes.
Queue	setPriority(Integer priority) Set the message priority.
Queue	setProductionPausedAtStartup(Boolean productionPausedAtStartup) Set whether or not message production is paused at server startup.
Queue	setQuota(String quota) Set the quota.
Queue	setRedeliveryDelay(Long redeliveryDelay) Set the message redelivery delay.
Queue	setRedeliveryLimit(Integer redeliveryLimit) Set the message redelivery limit.
Queue	setSafExportPolicy(SAFExportPolicy safExportPolicy) Set the SAF export policy.
Queue	setSubDeploymentName(String subDeploymentName) Set the sub-deployment name.
Queue	setTemplate(String template) Set the template.
Queue	setTimeToDeliver(String timeToDeliver) Set the time to deliver.
Queue	setTimeToLive(Long timeToLive) Set the time to live.
Queue	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.Destination

getDefaultTargetingEnabled, getId, getJmsCreateDestinationIdentifier, getJndiName, getLocalJndiName, getSubDeploymentName, getTemplate

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_QUEUE_TOKEN

public static final String JMS_QUEUE_TOKEN

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

See Also:

Constant Field Values

Constructor Detail

Queue

public Queue()

Method Detail

setId

public Queue setId(String id)

Set the id.

Overrides:

setId in class Destination

Parameters:

id - the new id

Returns:

the current Destination object

setAttachSender

public Queue 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 Queue 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

setDefaultTargetingEnabled

public Queue setDefaultTargetingEnabled(Boolean defaultTargetingEnabled)

Set whether or not default targeting is enabled.

Overrides:

setDefaultTargetingEnabled in class Destination

Parameters:

defaultTargetingEnabled - the new value

Returns:

the current Destination object

setDefaultUnitOfOrder

public Queue 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 Queue 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 Queue 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 Queue 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

setJndiName

public Queue setJndiName(String jndiName)

Set the JNDI name.

Overrides:

setJndiName in class Destination

Parameters:

jndiName - the new JNDI name

Returns:

the current Destination object

setJmsCreateDestinationIdentifier

public Queue setJmsCreateDestinationIdentifier(String jmsCreateDestinationIdentifier)

Set the JMS create destination identifier.

Overrides:

setJmsCreateDestinationIdentifier in class Destination

Parameters:

jmsCreateDestinationIdentifier - the new JMS create destination identifier

Returns:

the current Destination object

setLocalJndiName

public Queue setLocalJndiName(String localJndiName)

Set the local JNDI name

Overrides:

setLocalJndiName in class Destination

Parameters:

localJndiName - the new local JNDI name

Returns:

the current Destination object

setMaximumMessageSize

public Queue 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 Queue 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 Queue setName(String name)

Set the name.

Overrides:

setName in class DestinationTunables

Parameters:

name - the new name

Returns:

the current DestinationTunables object

setNotes

public Queue setNotes(String notes)

Set the notes.

Overrides:

setNotes in class DestinationTunables

Parameters:

notes - the new value

Returns:

the current DestinationTunables object

setProductionPausedAtStartup

public Queue 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 Queue setQuota(String quota)

Set the quota.

Overrides:

setQuota in class DestinationTunables

Parameters:

quota - the new quota

Returns:

the current DestinationTunables object

setSafExportPolicy

public Queue 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

setSubDeploymentName

public Queue setSubDeploymentName(String subDeploymentName)

Set the sub-deployment name.

Overrides:

setSubDeploymentName in class Destination

Parameters:

subDeploymentName - the new sub-deployment name

Returns:

the current Destination object

setTemplate

public Queue setTemplate(String template)

Set the template.

Overrides:

setTemplate in class Destination

Parameters:

template - the new template

Returns:

the current Destination object

setUnitOfWorkHandlingPolicy

public Queue 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 Queue setErrorDestination(String errorDestination)

Set the error destination.

Overrides:

setErrorDestination in class DestinationTunables

Parameters:

errorDestination - the new value

Returns:

the current DestinationTunables object

setExpirationLoggingPolicy

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

Overrides:

toXmlCompactString in class Destination

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.

Overrides:

toXmlString in class Destination

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.

Overrides:

toJsonCompactString in class Destination

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.

Overrides:

toJsonString in class Destination

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.

Overrides:

toCompactString in class Destination

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 Destination

Returns:

a string representation of the object in XML format