|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DestinationBean
This bean contains all the attributes of destinations that are common between queues and topics.
Method Summary | |
---|---|
void |
addDestinationKey(String destinationKey)
Adds a destination key. |
String |
getAttachSender()
Specifies whether messages landing on this destination should attach the credential of the sending user. |
DeliveryFailureParamsBean |
getDeliveryFailureParams()
DeliveryFailureParams control what should happen to
messages when failures occur. |
DeliveryParamsOverridesBean |
getDeliveryParamsOverrides()
Many delivery parameters can be set by the JMS client. |
String[] |
getDestinationKeys()
The list of potential destination keys for sorting the messages that arrive on a JMS destination. |
int |
getIncompleteWorkExpirationTime()
Specifies the maximum length of time, in milliseconds, before undelivered messages in an incomplete UOW are expired. |
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 . |
String |
getJNDIName()
The global JNDI name used to look up the destination within the JNDI namespace. |
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. |
int |
getMaximumMessageSize()
The maximum size of a message that is accepted from producers on this destination. |
MessageLoggingParamsBean |
getMessageLoggingParams()
These parameters control how the WebLogic Server performs message logging. |
int |
getMessagingPerformancePreference()
Controls how long destinations are willing to wait to create full batches of available messages (if at all) for delivery to consumers. |
QuotaBean |
getQuota()
A Quota controls the allotment of system resources available to destinations. |
String |
getSAFExportPolicy()
Specifies whether a user can send messages to a destination using Store-and-Forward. |
TemplateBean |
getTemplate()
The JMS template from which the destination is derived. |
ThresholdParamsBean |
getThresholds()
A threshold is an action point that must be exceeded in order to produce a given effect. |
String |
getUnitOfWorkHandlingPolicy()
Specifies whether the Unit-of-Work (UOW) feature is enabled for this destination. |
boolean |
isConsumptionPausedAtStartup()
Specifies whether consumption is paused on a destination at startup. |
boolean |
isDefaultUnitOfOrder()
Specifies whether WebLogic Server creates a system-generated unit-of-order name based on the domain, JMS server, and destination name. |
boolean |
isInsertionPausedAtStartup()
Specifies whether new message insertion is paused on a destination at startup. |
boolean |
isProductionPausedAtStartup()
Specifies whether new message production is paused on a destination at startup. |
void |
removeDestinationKey(String destinationKey)
Removes a destination key. |
void |
setAttachSender(String attachSender)
Sets the value of the AttachSender attribute. |
void |
setConsumptionPausedAtStartup(boolean consumptionPausedAtStartup)
Sets the value of the ConsumptionPausedAtStartup attribute. |
void |
setDefaultUnitOfOrder(boolean defaultUnitOfOrderFlag)
Sets the value of the DefaultUnitOfOrder attribute. |
void |
setDestinationKeys(String[] destinationKeyArray)
Sets the value of the DestinationKeys attribute. |
void |
setIncompleteWorkExpirationTime(int incompleteWorkExpirationTime)
Sets the value of the IncompleteWorkExpirationTime. |
void |
setInsertionPausedAtStartup(boolean insertionPausedAtStartup)
Sets the value of the InsertionPausedAtStartup attribute. |
void |
setJMSCreateDestinationIdentifier(String destinationName)
Sets the value of the JMSCreateDestinationIdentifier attribute. |
void |
setJNDIName(String jndiName)
Sets the value of the JNDIName attribute. |
void |
setLocalJNDIName(String localJndiName)
Sets the value of the LocalJNDIName attribute. |
void |
setMaximumMessageSize(int maximumMessageSize)
Sets the value of the MaximumMessageSize attribute. |
void |
setMessagingPerformancePreference(int throughputEmphasis)
Sets the value of the MessagingPerformancePreference attribute. |
void |
setProductionPausedAtStartup(boolean productionPausedAtStartup)
Sets the value of the ProductonPausedAtStartup attribute. |
void |
setQuota(QuotaBean quota)
Sets the value of the Quota attribute. |
void |
setSAFExportPolicy(String safExportPolicy)
Sets the value of the SafExportPolicy attribute. |
void |
setTemplate(TemplateBean template)
Sets the value of the Template attribute. |
void |
setUnitOfWorkHandlingPolicy(String unitOfWorkHandlingPolicy)
Sets the value of the UnitOfWorkHandlingPolicy attribute. |
Methods inherited from interface weblogic.j2ee.descriptor.wl.TargetableBean |
---|
getSubDeploymentName, isDefaultTargetingEnabled, setDefaultTargetingEnabled, setSubDeploymentName |
Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean |
---|
getId, getName, getNotes, setName, setNotes |
Methods inherited from interface weblogic.descriptor.SettableBean |
---|
isSet, unSet |
Method Detail |
---|
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.
void setTemplate(TemplateBean template) throws IllegalArgumentException
Sets the value of the Template attribute.
template
- The name of the template bean to associated with this destination
IllegalArgumentException
DestinationBean.getTemplate()
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.
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.
destinationKey
- The string to be added as a key. The string is added added to the end of the list of keys.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.
destinationKey
- The string to be removed from the list of sorting keys.void setDestinationKeys(String[] destinationKeyArray) throws IllegalArgumentException
Sets the value of the DestinationKeys attribute.
destinationKeyArray
- An array of keys to be used with this template.
IllegalArgumentException
DestinationBean.getDestinationKeys()
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.
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.
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.
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.
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.
This attribute is dynamically configurable. A dynamic change of this attribute will affect only messages received after the update has been made.
void setAttachSender(String attachSender) throws IllegalArgumentException
Sets the value of the AttachSender attribute.
attachSender
- The attach sender mode the destination is set to. (Supports, Always, or Never)
IllegalArgumentException
DestinationBean.getAttachSender()
boolean isProductionPausedAtStartup()
Specifies whether new message production is paused on a destination at startup.
void setProductionPausedAtStartup(boolean productionPausedAtStartup) throws IllegalArgumentException
Sets the value of the ProductonPausedAtStartup attribute.
productionPausedAtStartup
- true if production should be paused when the destination starts up
IllegalArgumentException
DestinationBean.isProductionPausedAtStartup()
boolean isInsertionPausedAtStartup()
Specifies whether new message insertion is paused on a destination at startup.
void setInsertionPausedAtStartup(boolean insertionPausedAtStartup) throws IllegalArgumentException
Sets the value of the InsertionPausedAtStartup attribute.
insertionPausedAtStartup
- true if insertion into the destination should be paused when the destination starts
IllegalArgumentException
DestinationBean.isInsertionPausedAtStartup()
boolean isConsumptionPausedAtStartup()
Specifies whether consumption is paused on a destination at startup.
void setConsumptionPausedAtStartup(boolean consumptionPausedAtStartup) throws IllegalArgumentException
Sets the value of the ConsumptionPausedAtStartup attribute.
consumptionPausedAtStartup
- true if consumption from this destination is paused when the destination starts.
IllegalArgumentException
DestinationBean.isConsumptionPausedAtStartup()
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.
void setMaximumMessageSize(int maximumMessageSize) throws IllegalArgumentException
Sets the value of the MaximumMessageSize attribute.
maximumMessageSize
- The maximum size allowed by this destination
IllegalArgumentException
DestinationBean.getMaximumMessageSize()
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.
void setQuota(QuotaBean quota) throws IllegalArgumentException
Sets the value of the Quota attribute.
quota
- The quota bean to be associated with this destination.
IllegalArgumentException
DestinationBean.getQuota()
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.
void setJNDIName(String jndiName) throws IllegalArgumentException
Sets the value of the JNDIName attribute.
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
IllegalArgumentException
DestinationBean.getJNDIName()
String getLocalJNDIName()
A destination can have both a local JNDI name and a (global) JNDI name.
void setLocalJNDIName(String localJndiName) throws IllegalArgumentException
Sets the value of the LocalJNDIName attribute.
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
IllegalArgumentException
DestinationBean.getLocalJNDIName()
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.
void setJMSCreateDestinationIdentifier(String destinationName) throws IllegalArgumentException
Sets the value of the JMSCreateDestinationIdentifier attribute.
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
IllegalArgumentException
DestinationBean.getJMSCreateDestinationIdentifier()
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.
void setDefaultUnitOfOrder(boolean defaultUnitOfOrderFlag) throws IllegalArgumentException
Sets the value of the DefaultUnitOfOrder attribute.
defaultUnitOfOrderFlag
- true or false
IllegalArgumentException
DestinationBean.isDefaultUnitOfOrder()
String getSAFExportPolicy()
Specifies whether a user can 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.
void setSAFExportPolicy(String safExportPolicy)
Sets the value of the SafExportPolicy attribute.
DestinationBean.getSAFExportPolicy()
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.
void setMessagingPerformancePreference(int throughputEmphasis) throws IllegalArgumentException
Sets the value of the MessagingPerformancePreference attribute.
throughputEmphasis
- The level of emphasis on throughput over latency
IllegalArgumentException
DestinationBean.getMessagingPerformancePreference()
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.
ObjectMessage
containing the list.
void setUnitOfWorkHandlingPolicy(String unitOfWorkHandlingPolicy) throws IllegalArgumentException
Sets the value of the UnitOfWorkHandlingPolicy attribute.
unitOfWorkHandlingPolicy
- The way unit of work messages are processed for this destination
IllegalArgumentException
DestinationBean.getUnitOfWorkHandlingPolicy()
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.
void setIncompleteWorkExpirationTime(int incompleteWorkExpirationTime) throws IllegalArgumentException
Sets the value of the IncompleteWorkExpirationTime.
incompleteWorkExpirationTime
- The number of milliseconds before messages will be expired
IllegalArgumentException
DestinationBean.getIncompleteWorkExpirationTime()
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |