weblogic.j2ee.descriptor.wl
Interface DestinationBean

All Superinterfaces:

NamedEntityBean, SettableBean, TargetableBean

All Known Subinterfaces:

QueueBean, TopicBean, UniformDistributedDestinationBean, UniformDistributedQueueBean, UniformDistributedTopicBean

public interface DestinationBean
extends TargetableBean

This bean contains all the attributes of destinations that are common between queues and topics.

getTemplate

TemplateBean getTemplate()

The JMS template from which the destination is derived. A template provides an efficient means of defining multiple destinations with similar configuration values.

If a JMS template is specified, destination parameters that are set to their default values will instead inherit their values from the JMS template at run-time. However, if a JMS template is not defined, then the configuration values for the destination must be specified as part of the destination.

Although you can dynamically modify the configuration of a JMS template, the configuration values on a destination are static.

Returns:

The name of the template bean associated with this destination.

Default Value:

null

setTemplate

void setTemplate(TemplateBean template)
                 throws IllegalArgumentException

Sets the value of the Template attribute.

Parameters:

template - The name of the template bean to associated with this destination

Throws:

IllegalArgumentException

See Also:

DestinationBean.getTemplate()

getDestinationKeys

String[] getDestinationKeys()

The list of potential destination keys for sorting the messages that arrive on a JMS destination.

The keys are ordered from most significant to least significant. If more than one key is specified, a key based on the JMSMessageID can only be the last key in the list.

Note: If JMSMessageID is not defined in the key, it is implicitly assumed to be the last key and is set as "Ascending" (FIFO) for the sort order.

Returns:

An array of destination keys, ordered from most signifigant to least significant.

addDestinationKey

void addDestinationKey(String destinationKey)

Adds a destination key.

Adds a string to the list of keys to be used for sorting destinations. The string given will be added to the end of the list.

Parameters:

destinationKey - The string to be added as a key. The string is added added to the end of the list of keys.

removeDestinationKey

void removeDestinationKey(String destinationKey)

Removes a destination key.

If the given string is in the list of keys used for sorting destinations, it will be removed from the list.

Parameters:

destinationKey - The string to be removed from the list of sorting keys.

setDestinationKeys

void setDestinationKeys(String[] destinationKeyArray)
                        throws IllegalArgumentException

Sets the value of the DestinationKeys attribute.

Parameters:

destinationKeyArray - An array of keys to be used with this template.

Throws:

IllegalArgumentException

See Also:

DestinationBean.getDestinationKeys()

getThresholds

ThresholdParamsBean getThresholds()

A threshold is an action point that must be exceeded in order to produce a given effect. These action points may cause logging, flow control, or other actions, as defined by the specific points whose values have been exceeded.

Returns:

The threshold bean describing the threshold parameters.

getDeliveryParamsOverrides

DeliveryParamsOverridesBean getDeliveryParamsOverrides()

Many delivery parameters can be set by the JMS client. Setting an override causes the current value of a delivery parameter to be ignored and replaced by the value set here.

Returns:

The delivery parameters override bean describing the override parameters.

getDeliveryFailureParams

DeliveryFailureParamsBean getDeliveryFailureParams()

DeliveryFailureParams control what should happen to messages when failures occur. They allow the adminstrator to control error destinations, logging and other actions that might be taken when a message can not be delivered or when other failures are detected.

Returns:

The delivery failure parameters bean that describing the actions to take on failures.

getMessageLoggingParams

MessageLoggingParamsBean getMessageLoggingParams()

These parameters control how the WebLogic Server performs message logging.

They allow the adminstrator to configure the server to change message logging when a message life cycle changes are detected.

Returns:

The message logging parameters bean that describing the actions to take on message life cycle change

getAttachSender

String getAttachSender()

Specifies whether messages landing on this destination should attach the credential of the sending user. You should consult the JMSXUserID documentation in Programming WebLogic JMS before using this feature.

• Supports The JMSXUserID property is set with the security principal of the sending user if requested. The sender can request its identity to be attached to its messages by using a connection factory with the AttachJMSXUserID security property enabled.
• Never The JMSXUserID property is never set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.
• Always The JMSXUserID property is always set with the security principal of the sending user no matter how the AttachJMSXUserID property is configured on connection factories.

This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.

Returns:

The attach sender mode the destination is in. (Supports, Always, or Never)

Changes take effect after you redeploy the module or restart the server.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.SUPPORTS

setAttachSender

void setAttachSender(String attachSender)
                     throws IllegalArgumentException

Sets the value of the AttachSender attribute.

Parameters:

attachSender - The attach sender mode the destination is set to. (Supports, Always, or Never)

Throws:

IllegalArgumentException

See Also:

DestinationBean.getAttachSender()

Changes take effect after you redeploy the module or restart the server.

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.SUPPORTS,weblogic.j2ee.descriptor.wl.constants.JMSConstants.NEVER,weblogic.j2ee.descriptor.wl.constants.JMSConstants.AUTH_PRINS

isProductionPausedAtStartup

boolean isProductionPausedAtStartup()

Specifies whether new message production is paused on a destination at startup.

• default If a JMS template is specified, then this value inherits the template's Production Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
• false Production Paused is explicitly disabled for this destination.
• true Production Paused is explicitly turned on for this destination.

Returns:

true if production of messages is paused when the destination is started; false otherwise

Default Value:

false

setProductionPausedAtStartup

void setProductionPausedAtStartup(boolean productionPausedAtStartup)
                                  throws IllegalArgumentException

Sets the value of the ProductonPausedAtStartup attribute.

Parameters:

productionPausedAtStartup - true if production should be paused when the destination starts up

Throws:

IllegalArgumentException

See Also:

DestinationBean.isProductionPausedAtStartup()

isInsertionPausedAtStartup

boolean isInsertionPausedAtStartup()

Specifies whether new message insertion is paused on a destination at startup.

• default If a JMS template is specified, then this value inherits the template's Insertion Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
• false Insertion Paused is explicitly disabled for this destination.
• true Insertion Paused is explicitly turned on for this destination.

Returns:

true if insertion into the destination is paused when the destination starts up; false otherwise.

Default Value:

false

setInsertionPausedAtStartup

void setInsertionPausedAtStartup(boolean insertionPausedAtStartup)
                                 throws IllegalArgumentException

Sets the value of the InsertionPausedAtStartup attribute.

Parameters:

insertionPausedAtStartup - true if insertion into the destination should be paused when the destination starts

Throws:

IllegalArgumentException

See Also:

DestinationBean.isInsertionPausedAtStartup()

isConsumptionPausedAtStartup

boolean isConsumptionPausedAtStartup()

Specifies whether consumption is paused on a destination at startup.

• default If a JMS template is specified, then this value inherits the template's Consumption Paused At Startup value. If no JMS template is configured for the destination, then the Default value is equivalent to false.
• false Consumption Paused is explicitly disabled for this destination.
• true Consumption Paused is explicitly turned on for this destination.

Returns:

true if consumption from this destination is paused when the destination starts. false otherwise.

Default Value:

false

setConsumptionPausedAtStartup

void setConsumptionPausedAtStartup(boolean consumptionPausedAtStartup)
                                   throws IllegalArgumentException

Sets the value of the ConsumptionPausedAtStartup attribute.

Parameters:

consumptionPausedAtStartup - true if consumption from this destination is paused when the destination starts.

Throws:

IllegalArgumentException

See Also:

DestinationBean.isConsumptionPausedAtStartup()

getMaximumMessageSize

int getMaximumMessageSize()

The maximum size of a message that is accepted from producers on this destination.

The message size includes the message body, any user-defined properties, and the user-defined JMS header fields: JMSCorrelationID and JMSType . Producers sending messages that exceed the configured maximum message size for the destination receive a ResourceAllocationException .

The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.

This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.

Returns:

The maximum message size allowed for this destination

Changes take effect after you redeploy the module or restart the server.

Default Value:

java.lang.Integer.MAX_VALUE

setMaximumMessageSize

void setMaximumMessageSize(int maximumMessageSize)
                           throws IllegalArgumentException

Sets the value of the MaximumMessageSize attribute.

Parameters:

maximumMessageSize - The maximum size allowed by this destination

Throws:

IllegalArgumentException

See Also:

DestinationBean.getMaximumMessageSize()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getQuota

QuotaBean getQuota()

A Quota controls the allotment of system resources available to destinations. For example, the number of bytes a destination is allowed to store can be configured with a Quota.

Returns:

The quota bean associated with this destination.

Default Value:

null

setQuota

void setQuota(QuotaBean quota)
              throws IllegalArgumentException

Sets the value of the Quota attribute.

Parameters:

quota - The quota bean to be associated with this destination.

Throws:

IllegalArgumentException

See Also:

DestinationBean.getQuota()

Changes take effect after you redeploy the module or restart the server.

getJNDIName

String getJNDIName()

The global JNDI name used to look up the destination within the JNDI namespace.

In a clustered environment, this name is propagated to the entire cluster. If you want the JNDI name to be bound only on the local server, and not propagated to the rest of the cluster, then use the Local JNDI Name parameter.

If not specified, the destination name will not be advertised through the global JNDI namespace.

Returns:

The name used to look up this destination in the JNDI naming context.

Default Value:

null

setJNDIName

void setJNDIName(String jndiName)
                 throws IllegalArgumentException

Sets the value of the JNDIName attribute.

Parameters:

jndiName - The new JNDI name this destination should use. The old name will be unbound from the naming context, but the object returned from a lookup with the old name will continue to work

Throws:

IllegalArgumentException

See Also:

DestinationBean.getJNDIName()

getLocalJNDIName

String getLocalJNDIName()

The local JNDI name used to look up the destination within the JNDI namespace of the server where the destination resource is targeted. In a clustered environment, this name is bound only on the local server instance and is not propagated to the rest of the cluster.

A destination can have both a local JNDI name and a (global) JNDI name.

Returns:

The name used to look up this destination in the JNDI naming context.

Default Value:

null

setLocalJNDIName

void setLocalJNDIName(String localJndiName)
                      throws IllegalArgumentException

Sets the value of the LocalJNDIName attribute.

Parameters:

localJndiName - The new JNDI name this destination should use. The old name will be unbound from the naming context, but the object returned from a lookup with the old name will continue to work

Throws:

IllegalArgumentException

See Also:

DestinationBean.getLocalJNDIName()

getJMSCreateDestinationIdentifier

String getJMSCreateDestinationIdentifier()

A reference name for a destination or a member of a distributed destination that provides a way to lookup that destination without JNDI using javax.jms.Session createQueue or createTopic. See "How to Lookup a Destination" in Programming JMS for more information on how to use this attribute.

This name must be unique within the scope of the JMS server to which this destination is targeted. However, it does not need to be unique within the scope of an entire JMS module or WebLogic Cluster. For example, two queues can have the same destination name as long as those queues are targeted to different JMS servers.

Note: Since this name must be unique within the scope of a JMS server, verify whether other JMS modules may contain destination names that conflict with this name. It is the responsibility of the deployer to resolve the destination names targeted to JMS servers.

Returns:

The destination name that need not be unique inside the module, but which must be unique inside the JMS server it is deployed on

Default Value:

null

setJMSCreateDestinationIdentifier

void setJMSCreateDestinationIdentifier(String destinationName)
                                       throws IllegalArgumentException

Sets the value of the JMSCreateDestinationIdentifier attribute.

Parameters:

destinationName - The destination name that need not be unique inside the module, but which must be unique inside the JMS server it is deployed on

Throws:

IllegalArgumentException

See Also:

DestinationBean.getJMSCreateDestinationIdentifier()

isDefaultUnitOfOrder

boolean isDefaultUnitOfOrder()

Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. Any message arriving at this destination that does not already belong to a unit-of-order is assigned this default name.

This field is recommended for advanced use. Generally, it is recommended to set a message unit-of-order using application calls or connection factory configuration. When relying on a destination default unit order to enforce ordering with a distributed destination, the application must be aware that unit-of-order routing doesn't apply. Instead the application must specifically ensure that any particular set of messages that must be processed in order are all sent to the same specific member destination even in the event of process failures or service migration.

Returns:

true if "default unit of order" is set, false otherwise

Default Value:

false

setDefaultUnitOfOrder

void setDefaultUnitOfOrder(boolean defaultUnitOfOrderFlag)
                           throws IllegalArgumentException

Sets the value of the DefaultUnitOfOrder attribute.

Parameters:

defaultUnitOfOrderFlag - true or false

Throws:

IllegalArgumentException

See Also:

DestinationBean.isDefaultUnitOfOrder()

getSAFExportPolicy

String getSAFExportPolicy()

Specifies whether a user can send messages to a destination using Store-and-Forward.

• All All users can send messages to this destination using Store-and-Forward.
• None Remote users can not send messages to a destination using Store-and-Forward.

This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages sent after the update has been made.

Returns:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXPORT_TO_ALL, or weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXPORT_TO_NONE

setSAFExportPolicy

void setSAFExportPolicy(String safExportPolicy)

Sets the value of the SafExportPolicy attribute.

See Also:

DestinationBean.getSAFExportPolicy()

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXPORT_TO_ALL

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXPORT_TO_ALL, weblogic.j2ee.descriptor.wl.constants.JMSConstants.EXPORT_TO_NONE

getMessagingPerformancePreference

int getMessagingPerformancePreference()

Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. At the minimum value, batching is disabled; at the default value, less-than-full batches will not wait and are delivered immediately with currently available messages; tuning higher than the default value controls the maximum wait time for additional messages before less-than-full batches are delivered to consumers.

The maximum message count of a full batch is controlled by the JMS connection factory's Messages Maximum setting.

Returns:

The level of emphasis on throughput over latency

Changes take effect after you redeploy the module or restart the server.

Default Value:

25

setMessagingPerformancePreference

void setMessagingPerformancePreference(int throughputEmphasis)
                                       throws IllegalArgumentException

Sets the value of the MessagingPerformancePreference attribute.

Parameters:

throughputEmphasis - The level of emphasis on throughput over latency

Throws:

IllegalArgumentException

See Also:

DestinationBean.getMessagingPerformancePreference()

Changes take effect after you redeploy the module or restart the server.

Maximum Value:

100

Minimum Value:

0

getUnitOfWorkHandlingPolicy

String getUnitOfWorkHandlingPolicy()

Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. A UOW is a set of messages that are processed as a single unit.

• Pass-Through By default, this destination does not treat messages as part of a UOW.
• Single Message Delivery This value should only be selected if UOW consumers are receiving messages on this destination. When selected, UOW messages are formed into a list and are consumed as an ObjectMessage containing the list.

Returns:

A string indicating how unit of work messages are handled

Changes take effect after you redeploy the module or restart the server.

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.PASS_THROUGH

setUnitOfWorkHandlingPolicy

void setUnitOfWorkHandlingPolicy(String unitOfWorkHandlingPolicy)
                                 throws IllegalArgumentException

Sets the value of the UnitOfWorkHandlingPolicy attribute.

Parameters:

unitOfWorkHandlingPolicy - The way unit of work messages are processed for this destination

Throws:

IllegalArgumentException

See Also:

DestinationBean.getUnitOfWorkHandlingPolicy()

Changes take effect after you redeploy the module or restart the server.

Valid Values:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.PASS_THROUGH,weblogic.j2ee.descriptor.wl.constants.JMSConstants.SINGLE_MESSAGE

getIncompleteWorkExpirationTime

int getIncompleteWorkExpirationTime()

Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. Such messages will then follow the expiration policy defined for undeliverable messages.

Note: An error destination for UOW messages cannot be configured with a Unit-of-Work Handling Policy of Single Message Delivery value.

This attribute is effective only if the Unit-of-Work Handling Policy is set to Single Message Delivery value. A value of -1 means that UOW messages will never expire.

Returns:

The number of milliseconds before messages will be expired

Changes take effect after you redeploy the module or restart the server.

Default Value:

-1

setIncompleteWorkExpirationTime

void setIncompleteWorkExpirationTime(int incompleteWorkExpirationTime)
                                     throws IllegalArgumentException

Sets the value of the IncompleteWorkExpirationTime.

Parameters:

incompleteWorkExpirationTime - The number of milliseconds before messages will be expired

Throws:

IllegalArgumentException

See Also:

DestinationBean.getIncompleteWorkExpirationTime()

Changes take effect after you redeploy the module or restart the server.