oracle.fmwplatform.envspec.model.blueprint.jms

Class Topic

java.lang.Object

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

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

oracle.fmwplatform.envspec.model.blueprint.jms.Topic

public class Topic
extends Destination

A Topic is a JMS destination for publish and subscribe-style messaging.

Since:

12.2.2.0

Field Summary

Fields

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

Method Summary

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

public static final String JMS_TOPIC_TOKEN

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

See Also:

Constant Field Values

Constructor Detail

Topic

public Topic()

Method Detail

setId

public Topic setId(String id)

Set the id.

Overrides:

setId in class Destination

Parameters:

id - the new id

Returns:

the current Destination object

setAttachSender

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

Set the name.

Overrides:

setName in class DestinationTunables

Parameters:

name - the new name

Returns:

the current DestinationTunables object

setNotes

public Topic setNotes(String notes)

Set the notes.

Overrides:

setNotes in class DestinationTunables

Parameters:

notes - the new value

Returns:

the current DestinationTunables object

setProductionPausedAtStartup

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

Set the quota.

Overrides:

setQuota in class DestinationTunables

Parameters:

quota - the new quota

Returns:

the current DestinationTunables object

setSafExportPolicy

public Topic 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 Topic 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 Topic setTemplate(String template)

Set the template.

Overrides:

setTemplate in class Destination

Parameters:

template - the new template

Returns:

the current Destination object

setUnitOfWorkHandlingPolicy

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

Set the error destination.

Overrides:

setErrorDestination in class DestinationTunables

Parameters:

errorDestination - the new value

Returns:

the current DestinationTunables object

setExpirationLoggingPolicy

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