|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class represents common JMS destination and JMS template methods.
A JMS destination identifies either a queue (Point-To-Point) or a topic (Pub/Sub) for a JMS server. A JMS template provides an efficient means of defining multiple destinations with similar attribute settings.
Fields inherited from class weblogic.management.configuration.ConfigurationMBean |
CACHING_STUB_SVUID,
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
boolean |
addDestinationKey(JMSDestinationKeyMBean destinationKey)
Add a destination key to the JMS template or destination. |
long |
getBytesMaximum()
The maximum bytes quota (total amount of bytes) that can be stored in this destination. |
long |
getBytesThresholdHigh()
The upper threshold value that triggers events based on the number of bytes stored in the destination. |
long |
getBytesThresholdLow()
The lower threshold value that triggers events based on the number of bytes stored in the destination. |
java.lang.String |
getDeliveryModeOverride()
The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer. |
JMSDestinationKeyMBean[] |
getDestinationKeys()
Return a read-only array of the destination keys of the JMS template or destination. |
JMSDestinationMBean |
getErrorDestination()
The name of the target error destination for messages that have reached their redelivery limit. |
java.lang.String |
getExpirationLoggingPolicy()
The policy that defines what information about the message is logged when the Expiration Policy is set to Log. |
java.lang.String |
getExpirationPolicy()
The message Expiration Policy to use when an expired message is encountered on a destination. |
int |
getMaximumMessageSize()
The maximum size of a message that will be accepted from producers on this destination. |
long |
getMessagesMaximum()
The maximum message quota (total amount of messages) that can be stored in this destination. |
long |
getMessagesThresholdHigh()
The upper threshold value that triggers events based on the number of messages stored in the destination. |
long |
getMessagesThresholdLow()
The lower threshold value that triggers events based on the number of messages stored in the destination. |
int |
getPriorityOverride()
The priority assigned to all messages that arrive at the destination, regardless of the Priority specified by the message producer. |
long |
getRedeliveryDelayOverride()
Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. |
int |
getRedeliveryLimit()
The number of redelivery tries a message can have before it is moved to the error destination. |
java.lang.String |
getTimeToDeliverOverride()
Defines the default delay, either in milliseconds or as a schedule, between when a message is produced and when it is made visible on its target destination, regardless of the delivery time specified by the producer and/or connection factory. |
long |
getTimeToLiveOverride()
The time-to-live value assigned to all messages that arrive at the destination, regardless of the TimeToLive specified by the message producer. |
boolean |
removeDestinationKey(JMSDestinationKeyMBean destinationKey)
Remove a destination key from the JMS template or destination. |
void |
setBytesMaximum(long bytesMaximum)
The maximum bytes quota (total amount of bytes) that can be stored in this destination. |
void |
setBytesThresholdHigh(long bytesThresholdHigh)
The upper threshold value that triggers events based on the number of bytes stored in the destination. |
void |
setBytesThresholdLow(long bytesThresholdLow)
The lower threshold value that triggers events based on the number of bytes stored in the destination. |
void |
setCreationTime(long time)
|
void |
setDeliveryModeOverride(java.lang.String deliveryModeOverride)
The delivery mode assigned to all messages that arrive at the destination regardless of the DeliveryMode specified by the message producer. |
void |
setDestinationKeys(JMSDestinationKeyMBean[] keys)
The list of potential destination keys for for sorting the messages that arrive on the JMS template or destination. |
void |
setErrorDestination(JMSDestinationMBean errorDestination)
The name of the target error destination for messages that have reached their redelivery limit. |
void |
setExpirationLoggingPolicy(java.lang.String jmsPolicyString)
The policy that defines what information about the message is logged when the Expiration Policy is set to Log. |
void |
setExpirationPolicy(java.lang.String policy)
The message Expiration Policy to use when an expired message is encountered on a destination. |
void |
setMaximumMessageSize(int maxMessageSize)
The maximum size of a message that will be accepted from producers on this destination. |
void |
setMessagesMaximum(long messagesMaximum)
The maximum message quota (total amount of messages) that can be stored in this destination. |
void |
setMessagesThresholdHigh(long messagesThresholdHigh)
The upper threshold value that triggers events based on the number of messages stored in the destination. |
void |
setMessagesThresholdLow(long messagesThresholdLow)
The lower threshold value that triggers events based on the number of messages stored in the destination. |
void |
setPriorityOverride(int priorityOverride)
The priority assigned to all messages that arrive at the destination regardless of the Priority specified by the message producer. |
void |
setRedeliveryDelayOverride(long redeliveryDelayOverride)
Defines the delay, in milliseconds, before rolled back or recovered messages are redelivered, regardless of the RedeliveryDelay specified by the consumer and/or connection factory. |
void |
setRedeliveryLimit(int redeliveryLimit)
The number of redelivery tries a message can have before it is moved to the error destination. |
void |
setTimeToDeliverOverride(java.lang.String timeToDeliverOverride)
Defines the default delay, in milliseconds or as a schedule, between when a message is produced and when it is made visible on its target destination, regardless of the TimeToDeliver specified by the producer and/or connection factory. |
void |
setTimeToLiveOverride(long timeToLiveOverride)
The time-to-live value assigned to all messages that arrive at the destination, regardless of the TimeToLive specified by the message producer. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue,
getNotes,
restoreDefaultValue,
setComments,
setDefaultedMBean,
setNotes,
setPersistenceEnabled |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo,
getName,
getObjectName,
getParent,
getType,
isCachingDisabled,
isRegistered,
setName,
setParent |
Methods inherited from interface javax.management.DynamicMBean |
getAttribute,
getAttributes,
invoke,
setAttribute,
setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
postDeregister,
postRegister,
preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener,
getNotificationInfo,
removeNotificationListener |
Method Detail |
public JMSDestinationKeyMBean[] getDestinationKeys()
public boolean addDestinationKey(JMSDestinationKeyMBean destinationKey)
destinationKey
- a reference to JMSDestinationKeyMBeanpublic void setDestinationKeys(JMSDestinationKeyMBean[] keys) throws javax.management.InvalidAttributeValueException
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.
destinationKeys
- an array of
JMSDestinationKeyMBeanpublic boolean removeDestinationKey(JMSDestinationKeyMBean destinationKey)
destinationKey
- a reference to
JMSDestinationKeyMBeanpublic long getBytesMaximum()
Range of Values: >= BytesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.
public void setBytesMaximum(long bytesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Range of Values: >= BytesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.
public long getBytesThresholdHigh()
A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: <= BytesMaximum; >BytesThresholdLow
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Bytes paging cannot be dynamically disabled by resetting the value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered.
public void setBytesThresholdHigh(long bytesThresholdHigh) throws javax.management.InvalidAttributeValueException, DistributedManagementException
A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: <= BytesMaximum; >BytesThresholdLow
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Bytes paging cannot be dynamically disabled by resetting the value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered.
public long getBytesThresholdLow()
A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: < BytesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setBytesThresholdLow(long bytesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: < BytesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public long getMessagesMaximum()
Range of Values: >= MessagesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.
public void setMessagesMaximum(long messagesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Range of Values: >= MessagesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: If a JMS template is used for distributed destination members, then this setting applies only to those specific members and not the distributed destination set as a whole.
public long getMessagesThresholdHigh()
Messages Paging - If messages paging is enabled (and a paging store has been configured), then destination-level messages paging is started.
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: <= MessagesMaximum; >MessagesThresholdLow
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Messages paging cannot be dynamically disabled by resetting the the value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered.
public void setMessagesThresholdHigh(long messagesThresholdHigh) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Messages Paging - If messages paging is enabled (and a paging store has been configured), then destination-level messages paging is started.
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: <= MessagesMaximum; >MessagesThresholdLow
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Messages paging cannot be dynamically disabled by resetting the the value to -1. To dynamically disable paging, you could set the value to a very large number, so that paging would not be triggered.
public long getMessagesThresholdLow()
Messages Paging - If messages paging is enabled, paging is stopped (if paging is occurring).
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: < MessagesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setMessagesThresholdLow(long messagesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Messages Paging - If messages paging is enabled, paging is stopped (if paging is occurring).
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the destination.
Range of Values: < MessagesThresholdHigh
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public int getPriorityOverride()
The default value (-1) specifies that the destination will not override the Priority setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setPriorityOverride(int priorityOverride) throws javax.management.InvalidAttributeValueException, DistributedManagementException
The default value (-1) specifies that the destination will not override the Priority setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public java.lang.String getTimeToDeliverOverride()
The default value (-1) specifies that the destination will not override the TimeToDeliver setting. The TimeToDeliverOverride can be specified either as a long or as a schedule.
Note: Changing the TimeToDeliverOverride only affects future message delivery, it does not affect message delivery of already produced messages.
Schedule
public void setTimeToDeliverOverride(java.lang.String timeToDeliverOverride) throws javax.management.InvalidAttributeValueException, DistributedManagementException
The default value (-1) specifies that the destination will not override the TimeToDeliver setting. The TimeToDeliverOverride can be specified either as a long or as a schedule.
Note: Changing the TimeToDeliverOverride only affects future message delivery, it does not affect message delivery of already produced messages.
Schedule
public long getRedeliveryDelayOverride()
The default value (-1) specifies that the destination will not override the RedeliveryDelay setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Changing the RedeliveryDelayOverride only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred.
public void setRedeliveryDelayOverride(long redeliveryDelayOverride) throws javax.management.InvalidAttributeValueException, DistributedManagementException
The default value (-1) specifies that the destination will not override the RedeliveryDelay setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
Note: Changing the RedeliveryDelayOverride only affects future rollbacks and recovers, it does not affect rollbacks and recovers that have already occurred.
public void setErrorDestination(JMSDestinationMBean errorDestination) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Note: The error destination must be a destination that is configured on the local JMS server.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public JMSDestinationMBean getErrorDestination()
Note: The error destination must be a destination that is configured on the local JMS server.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public int getRedeliveryLimit()
Note: The redelivery limit with no error destination behavior also applies to transactional messages, which are not rolled back for future redelivery and no exception is thrown.
The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting. When the value is set to zero, messages are received at-most once. No redelivery attempts are made in the event of a rollback or receive. Instead, messages are either moved to the configured error destination or are simply deleted.
This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.
Note: The number of times a message has been redelivered is not persisted. This means that after a restart, the number of delivery attempts on each message is reset to zero.
public void setRedeliveryLimit(int redeliveryLimit) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Note: The redelivery limit with no error destination behavior also applies to transactional messages, which are not rolled back for future redelivery and no exception is thrown.
The default value (-1) specifies that the destination will not override the message sender's redelivery limit setting. When the value is set to zero, messages are received at-most once. No redelivery attempts are made in the event of a rollback or receive. Instead, messages are either moved to the configured error destination or are simply deleted.
This attribute is dynamically configurable, but only incoming messages are impacted; previously sent messages continue to use their original redelivery limit.
Note: The number of times a message has been redelivered is not persisted. This means that after a restart, the number of delivery attempts on each message is reset to zero.
public long getTimeToLiveOverride()
The default value (-1) specifies that the destination will not override the TimeToLive setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setTimeToLiveOverride(long timeToLiveOverride) throws javax.management.InvalidAttributeValueException, DistributedManagementException
The default value (-1) specifies that the destination will not override the TimeToLive setting.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public java.lang.String getDeliveryModeOverride()
A value of No-Delivery specifies that the DeliveryMode will not be overridden.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setDeliveryModeOverride(java.lang.String deliveryModeOverride) throws javax.management.InvalidAttributeValueException, DistributedManagementException
A value of No-Delivery specifies that the DeliveryMode will not be overridden.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setExpirationPolicy(java.lang.String policy) throws javax.management.InvalidAttributeValueException
None - Same as the Discard policy; expired messages are simply removed from the destination.
Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.
Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.
Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:
It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.
Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.
public java.lang.String getExpirationPolicy()
None - Same as the Discard policy; expired messages are simply removed from the destination.
Discard - Removes expired messages from the messaging system. The removal is not logged and the message is not redirected to another location. If no value is defined for a given destination (i.e., None), then expired messages are discarded.
Log - Removes expired messages from the system and writes an entry to the server log file indicating that the messages have been removed from the system. The actual information that is logged is defined by the Expiration Logging Policy.
Redirect - Moves expired messages from their current location to the Error Destination defined for the destination. The message retains its body, and all of its properties. The message also retains all of its header fields, but with the following exceptions:
It is illegal to use the Redirect policy when there is no valid error destination defined for the destination. Similarly, it is illegal to remove the error destination for a destination that is using the Redirect policy.
Note: The Maximum Message quota is only enforced for sending new messages. It is ignored when moving messages because of the Redirect policy.
public void setExpirationLoggingPolicy(java.lang.String jmsPolicyString)
When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip".
Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message.
public java.lang.String getExpirationLoggingPolicy()
When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% values are not case sensitive. For example, you could use "%header%,%properties%" for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use "%header, name, address, city, state, zip".
Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Expiration Logging Policy is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message.
public int getMaximumMessageSize()
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.
public void setMaximumMessageSize(int maxMessageSize) throws javax.management.InvalidAttributeValueException, DistributedManagementException
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.
public void setCreationTime(long time)
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |