ConfigurationMBean
, DeploymentMBean
, DescriptorBean
, javax.management.DynamicMBean
, javax.management.MBeanRegistration
, javax.management.NotificationBroadcaster
, SettableBean
, TargetMBean
, WebLogicMBean
@SingleTargetOnly public interface SAFAgentMBean extends DeploymentMBean, TargetMBean
This class represents a Store-and-Forward (SAF) agent. A SAF sending agent takes care of storing messages to a persistent storage, forwarding messages to the receiving side, and re-transmitting messages when acknowledgements do not come back in time. A SAF receiving agent takes care of detecting and eliminating duplicate messages sent by the receiving agent, and deliver messages to the final endpoint.
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
BOTH |
|
static java.lang.String |
RECEIVING_ONLY |
|
static java.lang.String |
SENDING_ONLY |
DEFAULT_EMPTY_BYTE_ARRAY
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER
Modifier and Type | Method | Description |
---|---|---|
long |
getAcknowledgeInterval() |
The maximum interval between two successive acknowledgements
sent by the receiving side.
|
long |
getBytesMaximum() |
The maximum bytes quota (total amount of bytes) that can be
stored in this SAF agent.
|
long |
getBytesThresholdHigh() |
The upper threshold value that triggers events based on the
number of bytes stored in the SAF agent.
|
long |
getBytesThresholdLow() |
The lower threshold that triggers events based on the number of
bytes stored in the SAF agent.
|
long |
getConversationIdleTimeMaximum() |
The maximum amount of time allowed, in milliseconds, before a sending side
releases the resources used by a conversation.
|
long |
getDefaultRetryDelayBase() |
The amount of time, in milliseconds, between the original
delivery attempt and the first retry.
|
long |
getDefaultRetryDelayMaximum() |
The maximum amount of time, in milliseconds, between two
successive delivery retry attempts.
|
double |
getDefaultRetryDelayMultiplier() |
The factor used to multiply the previous delay time to calculate
the next delay time to be used.
|
long |
getDefaultTimeToLive() |
The default amount of time, in milliseconds, that the agent
guarantees to reliably send messages.
|
JMSSAFMessageLogFileMBean |
getJMSSAFMessageLogFile() |
The jms message log file configuration for this saf agent
|
int |
getMaximumMessageSize() |
The maximum number of bytes allowed in individual messages on
this SAF agent.
|
long |
getMessageBufferSize() |
The amount of memory used to store message bodies in memory
before they are paged out to disk.
|
java.lang.String |
getMessageCompressionOptions() |
Specifies the type of message compression used when JMS message body
compression is enabled for Persistent Stores and JMS Paging Stores.
|
long |
getMessagesMaximum() |
The maximum message quota (total amount of messages) that can be
stored in this SAF agent.
|
long |
getMessagesThresholdHigh() |
The upper threshold that triggers events based on the number of
messages stored in the SAF agent.
|
long |
getMessagesThresholdLow() |
The low threshold that triggers events based on the number of
messages stored in the SAF agent.
|
java.lang.String |
getName() |
The user-specified name of this MBean instance.
|
java.lang.String |
getPagingDirectory() |
Specifies where message bodies are written when the size
of the message bodies in the JMS server exceeds the message
buffer size.
|
java.lang.String |
getServiceType() |
The type of service that this SAF agent provides.
|
PersistentStoreMBean |
getStore() |
The persistent disk-based file store or JDBC-accessible database
for the SAF agent.
|
TargetMBean[] |
getTargets() |
You must select a target on which an MBean will be deployed from
this list of the targets in the current domain on which this item
can be deployed.
|
long |
getWindowInterval() |
The maximum amount of time, in milliseconds, that a JMS sending agent
waits before forwarding messages in a single batch.
|
int |
getWindowSize() |
For JMS messages, the number of messages in a batch.
|
boolean |
isForwardingPausedAtStartup() |
Specifies whether the agent is paused for forwarding messages at
the startup time.
|
boolean |
isIncomingPausedAtStartup() |
Specifies whether the agent is paused for incoming messages at
startup time.
|
boolean |
isLoggingEnabled() |
Specifies whether a message is logged in the server log file
when a message fails to be forwarded.
|
boolean |
isPagingMessageCompressionEnabled() |
Enables the JMS paging store to perform message body
compression on persistent and non-persistent messages.
|
boolean |
isReceivingPausedAtStartup() |
Specifies whether the agent is paused for receiving messages at
the startup time.
|
boolean |
isStoreMessageCompressionEnabled() |
Enables the JMS store to perform message body
compression.
|
void |
setAcknowledgeInterval(long interval) |
Sets the value of the
AcknowledgeInterval
attribute. |
void |
setBytesMaximum(long bytesMaximum) |
Sets the value of the
BytesMaximum attribute. |
void |
setBytesThresholdHigh(long bytesThresholdHigh) |
Sets the value of the
BytesThresholdHigh
attribute. |
void |
setBytesThresholdLow(long bytesThresholdLow) |
Sets the value of the
BytesThresholdLow
attribute. |
void |
setConversationIdleTimeMaximum(long conversationIdleTimeMaximum) |
Sets the value of the
ConversationIdleTimeMaximum
attribute. |
void |
setDefaultRetryDelayBase(long base) |
Sets the value of the
DefaultRetryDelayBase
attribute. |
void |
setDefaultRetryDelayMaximum(long maximum) |
Sets the value of the
DefaultRetryDelayMaximum
attribute. |
void |
setDefaultRetryDelayMultiplier(double multiplier) |
Sets the value of the
DefaultRetryDelayMultiplier
attribute. |
void |
setDefaultTimeToLive(long ttl) |
Sets the value of the
DefaultTimeToLive
attribute. |
void |
setForwardingPausedAtStartup(boolean forwardingPaused) |
Sets the value of the
ForwardingPausedAtStartup
attribute. |
void |
setIncomingPausedAtStartup(boolean incomingPaused) |
Sets the value of the
IncomingPausedAtStartup
attribute. |
void |
setLoggingEnabled(boolean loggingEnabled) |
Sets the value of the
LoggingEnabled attribute. |
void |
setMaximumMessageSize(int maxMessageSize) |
Sets the value of the
MaximumMessageSize
attribute. |
void |
setMessageBufferSize(long bufferSize) |
Sets the value of the
MessageBufferSize
attribute. |
void |
setMessageCompressionOptions(java.lang.String option) |
Sets the type of message compression used.
|
void |
setMessagesMaximum(long messagesMaximum) |
Sets the value of the
MessagesMaximum
attribute. |
void |
setMessagesThresholdHigh(long messagesThresholdHigh) |
Sets the value of the
MessagesThresholdHigh
attribute. |
void |
setMessagesThresholdLow(long messagesThresholdLow) |
Sets the value of the
MessagesThresholdLow
attribute. |
void |
setPagingDirectory(java.lang.String directory) |
Sets the value of the
PagingDirectory
attribute. |
void |
setPagingMessageCompressionEnabled(boolean allows) |
Sets the value of the isPagingMessageCompressionEnabled attribute.
|
void |
setReceivingPausedAtStartup(boolean receivingPaused) |
Sets the value of the
ReceivingPausedAtStartup
attribute. |
void |
setServiceType(java.lang.String type) |
Sets the value of the
ServiceType attribute. |
void |
setStore(PersistentStoreMBean store) |
Sets the value of the
Store attribute. |
void |
setStoreMessageCompressionEnabled(boolean allows) |
Sets the value of the isStoreMessageCompressionEnabled attribute.
|
void |
setTargets(TargetMBean[] Targets) |
Sets the value of the getTargets attribute.
|
void |
setWindowInterval(long windowInterval) |
Sets the value of the
WindowInterval
attribute. |
void |
setWindowSize(int size) |
Sets the value of the
WindowSize attribute. |
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
addTarget, getDeploymentOrder, removeTarget, setDeploymentOrder
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
static final java.lang.String SENDING_ONLY
static final java.lang.String RECEIVING_ONLY
static final java.lang.String BOTH
java.lang.String getName()
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
getName
in interface ConfigurationMBean
getName
in interface WebLogicMBean
TargetMBean[] getTargets()
DeploymentMBean
You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
getTargets
in interface DeploymentMBean
void setTargets(TargetMBean[] Targets) throws javax.management.InvalidAttributeValueException, DistributedManagementException
DeploymentMBean
Sets the value of the getTargets attribute.
setTargets
in interface DeploymentMBean
Targets
- The new targets valuejavax.management.InvalidAttributeValueException
DistributedManagementException
DeploymentMBean.getTargets()
PersistentStoreMBean getStore()
The persistent disk-based file store or JDBC-accessible database for the SAF agent.
If a store is not configured, the server's default store is used.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
void setStore(PersistentStoreMBean store) throws javax.management.InvalidAttributeValueException
Sets the value of the Store
attribute.
store
- The new store valuejavax.management.InvalidAttributeValueException
getStore()
long getBytesMaximum()
The maximum bytes quota (total amount of bytes) that can be stored in this SAF agent.
The default value of -1
specifies that there is no
WebLogic-imposed limit on the number of bytes that can be stored.
However, excessive bytes volume can cause memory saturation, so
this value should correspond to the total amount of available
system memory relative to the rest of your application load.
Applies only to agents with sending capability.
Updating BytesMaximum
affects only new
requests.
Range of Values: >= BytesThresholdHigh
void setBytesMaximum(long bytesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesMaximum
attribute.
bytesMaximum
- The new bytesMaximum valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getBytesMaximum()
long getBytesThresholdHigh()
The upper threshold value that triggers events based on the number of bytes stored in the SAF agent.
The default value of -1
disables the events for this
SAF agent.
Applies only to agents with sending capability.
Updating BytesThresholdHigh
affects only new
requests.
If the number of bytes exceeds this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating a high threshold condition.
Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= BytesMaximum; >= BytesThresholdLow
void setBytesThresholdHigh(long bytesThresholdHigh) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesThresholdHigh
attribute.
bytesThresholdHigh
- The new bytesThresholdHigh valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getBytesThresholdHigh()
long getBytesThresholdLow()
The lower threshold that triggers events based on the number of bytes stored in the SAF agent.
The default value of -1
disables the events for this
SAF agent.
Applies only to agents with sending capability.
Updating BytesThresholdLow
affects only new
requests.
If the number of bytes falls below this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: <= BytesThresholdHigh
void setBytesThresholdLow(long bytesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesThresholdLow
attribute.
bytesThresholdLow
- The new bytesThresholdLow valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getBytesThresholdLow()
long getMessagesMaximum()
The maximum message quota (total amount of messages) that can be stored in this SAF agent.
The default value of -1
specifies that the server
instance has no limit on the number of messages that can be stored.
However, excessive message volume can cause memory saturation, so
this value should correspond to the total amount of available
system memory relative to the rest of your application load.
Applies only to sending agents.
Updating the maximum message quota resets the message count so that only requests arriving after the update are charged against the new quota.
Range of Values: >= MessagesThresholdHigh
void setMessagesMaximum(long messagesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the MessagesMaximum
attribute.
messagesMaximum
- The new messagesMaximum valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getBytesThresholdLow()
long getMessagesThresholdHigh()
The upper threshold that triggers events based on the number of messages stored in the SAF agent.
The default value of -1
disables the events for this
SAF agent.
Applies only to agents with sending capability.
Updating MessagesThresholdHigh
affects only new
requests.
If the number of messages exceeds this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating a high threshold condition.
Flow Control: The agent becomes armed and instructs producers to begin decreasing their message flow.
Range of Values: <= MessagesMaximum; >= MessagesThresholdLow
void setMessagesThresholdHigh(long messagesThresholdHigh) throws javax.management.InvalidAttributeValueException
Sets the value of the MessagesThresholdHigh
attribute.
messagesThresholdHigh
- The new messagesThresholdHigh valuejavax.management.InvalidAttributeValueException
getMessagesThresholdHigh()
long getMessagesThresholdLow()
The low threshold that triggers events based on the number of messages stored in the SAF agent.
The default value of -1
disables the events for this
SAF agent.
Applies only to agents with sending capability.
Updating MessagesThresholdLow
affects only new
requests.
If the number of messages falls below this threshold, the triggered events are:
Log Messages: A message is logged on the server indicating that the threshold condition has cleared.
Flow Control: The agent becomes disarmed and instructs producers to begin increasing their message flow.
Range of Values: <= MessagesThresholdHigh.
void setMessagesThresholdLow(long messagesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the MessagesThresholdLow
attribute.
messagesThresholdLow
- The new messagesThresholdLow valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getMessagesThresholdLow()
int getMaximumMessageSize()
The maximum number of bytes allowed in individual messages on this SAF agent.
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 SAF agent will 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.
Applies only to agents with sending capability.
Updating MaximumMessageSize
affects only incoming
messages; stored messages are not affected.
void setMaximumMessageSize(int maxMessageSize) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the MaximumMessageSize
attribute.
maxMessageSize
- The new maximumMessageSize valuejavax.management.InvalidAttributeValueException
DistributedManagementException
getMaximumMessageSize()
long getDefaultRetryDelayBase()
The amount of time, in milliseconds, between the original delivery attempt and the first retry.
If RetryDelayMultiplier
is set to 1
,
this defines the interval between any two successive retry
attempts.
Applies only to agents with sending capability.
Updating DefaultRetryDelayBase
causes connections
starting after the update to use the new value.
Range of Values: <= RetryDelayMaximum if RetryDelayMultiplier is not 1.0.
void setDefaultRetryDelayBase(long base) throws javax.management.InvalidAttributeValueException
Sets the value of the DefaultRetryDelayBase
attribute.
base
- The new defaultRetryDelayBase valuejavax.management.InvalidAttributeValueException
getDefaultRetryDelayBase()
long getDefaultRetryDelayMaximum()
The maximum amount of time, in milliseconds, between two successive delivery retry attempts.
Applies only to agents with sending capability.
Updating DefaultRetryDelayMaximum
causes
connections starting after the update to use the new value.
Range of Values: > = RetryDelayBase if RetryDelayMultiplier is not 1.0.
void setDefaultRetryDelayMaximum(long maximum) throws javax.management.InvalidAttributeValueException
Sets the value of the DefaultRetryDelayMaximum
attribute.
maximum
- The new defaultRetryDelayMaximum valuejavax.management.InvalidAttributeValueException
getDefaultRetryDelayMaximum()
double getDefaultRetryDelayMultiplier()
The factor used to multiply the previous delay time to calculate the next delay time to be used.
Applies only to agents with sending capability.
Updating DefaultRetryDelayMuliplier
causes
connections starting after the update to use the new value.
Range of Values: >= 1.
void setDefaultRetryDelayMultiplier(double multiplier) throws javax.management.InvalidAttributeValueException
Sets the value of the DefaultRetryDelayMultiplier
attribute.
multiplier
- The new defaultRetryDelayMultiplier valuejavax.management.InvalidAttributeValueException
getDefaultRetryDelayMultiplier()
java.lang.String getServiceType()
The type of service that this SAF agent provides. JMS requires only a Sending agent on the sending side for messages. Whereas, Web Services Reliable Messaging requires both a Sending and Receiving agent for messages.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
void setServiceType(java.lang.String type) throws javax.management.InvalidAttributeValueException
Sets the value of the ServiceType
attribute.
type
- The valuejavax.management.InvalidAttributeValueException
getServiceType()
int getWindowSize()
For JMS messages, the number of messages in a batch. A sending agent
waits to forward a message batch until the source destination
message count is greater than or equal to this value. For a distributed queue or topic,
WindowSize
setting is ignored and always internally set to 1 message.
For WSRM, the maximum number of unacknowledged messages allowed between a source destination and a target destination during a conversation.
void setWindowSize(int size) throws javax.management.InvalidAttributeValueException
Sets the value of the WindowSize
attribute.
size
- The new windowSize valuejavax.management.InvalidAttributeValueException
getWindowSize()
boolean isLoggingEnabled()
Specifies whether a message is logged in the server log file when a message fails to be forwarded.
If selected, this applies to messages that fail to be forwarded and delivered to the final destination when there is no error handling in a SAF application or the application's error handling fails.
Applies only to agents with receiving capability.
Updating LoggingEnabled
causes connections starting
after the update to use the new value.
void setLoggingEnabled(boolean loggingEnabled) throws javax.management.InvalidAttributeValueException
Sets the value of the LoggingEnabled
attribute.
loggingEnabled
- The new loggingEnabled valuejavax.management.InvalidAttributeValueException
isLoggingEnabled()
long getConversationIdleTimeMaximum()
The maximum amount of time allowed, in milliseconds, before a sending side releases the resources used by a conversation.
If there is no activity for a conversation for the specified amount of time, the sending agent releases all resources for that conversation and notifies the receiving agent to do the same.
A value of 0
specifies that resources for a
conversation are not released unless the application explicitly
closes the conversation.
Updating ConversationIdleTimeMaximum
causes
connections starting after the update to use the new value.
void setConversationIdleTimeMaximum(long conversationIdleTimeMaximum) throws javax.management.InvalidAttributeValueException
Sets the value of the ConversationIdleTimeMaximum
attribute.
conversationIdleTimeMaximum
- The new conversationIdleTimeMaximum valuejavax.management.InvalidAttributeValueException
getConversationIdleTimeMaximum()
long getAcknowledgeInterval()
The maximum interval between two successive acknowledgements sent by the receiving side.
Applies only to agents with receiving capability.
A value of -1
specifies that there is no time limit
between successive acknowledgement.
Updating AcknowlegeInterval
causes connections
starting after the update to use the new value.
void setAcknowledgeInterval(long interval) throws javax.management.InvalidAttributeValueException
Sets the value of the AcknowledgeInterval
attribute.
interval
- The new acknowledgeInterval valuejavax.management.InvalidAttributeValueException
getAcknowledgeInterval()
long getDefaultTimeToLive()
The default amount of time, in milliseconds, that the agent guarantees to reliably send messages.
A value of 0 means the agent guarantees to reliably send messages for the duration of the conversation.
Updating DefaultTimeToLive
causes conversations
starting after the update to use the new value.
void setDefaultTimeToLive(long ttl) throws javax.management.InvalidAttributeValueException
Sets the value of the DefaultTimeToLive
attribute.
ttl
- The new defaultTimeToLive valuejavax.management.InvalidAttributeValueException
getDefaultTimeToLive()
boolean isIncomingPausedAtStartup()
Specifies whether the agent is paused for incoming messages at startup time.
When enabled, the sending agent accepts new messages. Otherwise, the sending agent does not accept any new messages.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
void setIncomingPausedAtStartup(boolean incomingPaused) throws javax.management.InvalidAttributeValueException
Sets the value of the IncomingPausedAtStartup
attribute.
incomingPaused
- if the agent is paused for incoming messagesjavax.management.InvalidAttributeValueException
isIncomingPausedAtStartup()
boolean isForwardingPausedAtStartup()
Specifies whether the agent is paused for forwarding messages at the startup time.
When enabled, the sending agent forwards messages. Otherwise, the sending agent does not forward any messages.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
void setForwardingPausedAtStartup(boolean forwardingPaused) throws javax.management.InvalidAttributeValueException
Sets the value of the ForwardingPausedAtStartup
attribute.
forwardingPaused
- if agent is paused for forwarding messagesjavax.management.InvalidAttributeValueException
isForwardingPausedAtStartup()
boolean isReceivingPausedAtStartup()
Specifies whether the agent is paused for receiving messages at the startup time.
When enabled, the sending agent receives messages. Otherwise, the sending agent does not receive any messages.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
void setReceivingPausedAtStartup(boolean receivingPaused) throws javax.management.InvalidAttributeValueException
Sets the value of the ReceivingPausedAtStartup
attribute.
receivingPaused
- if agent is paused for receiving messagesjavax.management.InvalidAttributeValueException
isReceivingPausedAtStartup()
long getMessageBufferSize()
The amount of memory used to store message bodies in memory before they are paged out to disk.
A value of -1 (the default) specifies that the server will automatically determine a size based on the maximum heap size of the JVM. This default will be set to either one-third the maximum heap size, or 512 megabytes, whichever is smaller.
The larger the buffer, the more memory JMS will consume when many messages are waiting on queues or topics. Once the buffer is surpassed, JMS may write message bodies to the directory specified by PagingDirectory in an effort to reduce memory usage below this buffer.
Surpassing the buffer size does not stop the JMS server from accepting new messages. It is still possible to run out of memory if messages are arriving faster than they can be written to disk. Users with high messaging loads who wish to support the highest possible availability should consider setting a quota or setting a threshold and enabling flow control.
Applies only to agents with sending capability.
Paging is always supported.
Updating the memory size resets the message count so that only requests arriving after the update are charged against the new memory size.
getPagingDirectory()
void setMessageBufferSize(long bufferSize) throws javax.management.InvalidAttributeValueException
Sets the value of the MessageBufferSize
attribute.
javax.management.InvalidAttributeValueException
getMessageBufferSize()
java.lang.String getPagingDirectory()
Specifies where message bodies are written when the size
of the message bodies in the JMS server exceeds the message
buffer size. If unspecified, messages are written to the
tmp
directory in the host WebLogic Server
instance's directory. For example,
domainName/servers/servername/tmp
.
For best performance, this directory should not be the same as the directory used by the SAF agent's persistent store.
Applies only to agents with sending capability.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
getMessageBufferSize()
void setPagingDirectory(java.lang.String directory) throws javax.management.InvalidAttributeValueException
Sets the value of the PagingDirectory
attribute.
javax.management.InvalidAttributeValueException
getPagingDirectory()
long getWindowInterval()
The maximum amount of time, in milliseconds, that a JMS sending agent
waits before forwarding messages in a single batch. For a distributed queue or topic,
WindowInterval
setting is ignored.
A sending agent
waits to forward the message batch until either: (A) the source destination
message count is greater than or equal to the configured Window Size
;
(B) it has waited a specified Window Interval
, whichever comes first.
void setWindowInterval(long windowInterval) throws javax.management.InvalidAttributeValueException
Sets the value of the WindowInterval
attribute.
windowInterval
- The new windowInterval valuejavax.management.InvalidAttributeValueException
getWindowInterval()
JMSSAFMessageLogFileMBean getJMSSAFMessageLogFile()
boolean isStoreMessageCompressionEnabled()
Enables the JMS store to perform message body
compression.
When set to false
, the default value, no compression
is performed.
getMessageCompressionOptions()
void setStoreMessageCompressionEnabled(boolean allows)
Sets the value of the isStoreMessageCompressionEnabled attribute.
allows
- true if JMS store should perform message body compressionisStoreMessageCompressionEnabled()
boolean isPagingMessageCompressionEnabled()
Enables the JMS paging store to perform message body
compression on persistent and non-persistent messages.
When false
, the default value, no compression is performed.
getMessageCompressionOptions()
void setPagingMessageCompressionEnabled(boolean allows)
Sets the value of the isPagingMessageCompressionEnabled attribute.
allows
- true if JMS paging store should perform compressionisPagingMessageCompressionEnabled()
void setMessageCompressionOptions(java.lang.String option)
Sets the type of message compression used.
option
- the supported compression machanismjava.lang.String getMessageCompressionOptions()
Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
GZIP_DEFAULT_COMPRESSION
to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION
level.GZIP_BEST_COMPRESSION
to enable message compression using the JDK GZIP API with BEST_COMPRESSION
level.GZIP_BEST_SPEED
to enable message compression using the JDK GZIP API with BEST_SPEED
level.LZF
to enable message compression using Open Source LZF.isStoreMessageCompressionEnabled()
,
isPagingMessageCompressionEnabled()