ConfigurationMBean, DeploymentMBean, DescriptorBean, javax.management.DynamicMBean, JMSConstants, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, TargetMBean, WebLogicMBean@SingleTargetOnly public interface JMSServerMBean extends DeploymentMBean, TargetMBean, JMSConstants
This class represents a JMS server. A JMS server manages connections and message requests on behalf of clients.
DEFAULT_EMPTY_BYTE_ARRAYDEFAULT_ORDER, MAX_ORDER, MIN_ORDERACKNOWLEDGE_ALL, ACKNOWLEDGE_MODE_AUTO, ACKNOWLEDGE_MODE_CLIENT, ACKNOWLEDGE_MODE_DUPS_OK, ACKNOWLEDGE_MODE_NONE, ACKNOWLEDGE_ONE, ACKNOWLEDGE_PREVIOUS, ALWAYSFORWARD, AT_LEAST_ONCE, AT_MOST_ONCE, AUTH_PRINS, CLIENT_ID_POLICY_UNRESTRICTED, CONSUMPTION_ENABLED, CONSUMPTION_PAUSED, CONSUMPTION_PAUSING, DEFAULT_MESSAGE_BUFFER_SIZE, DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_SAFID, DESTINATION_TYPE_TOPIC, DESTINATION_TYPE_UDQUEUE, DESTINATION_TYPE_UDTOPIC, DISABLED, DISCARD, ENABLED_DEFAULT, ENABLED_FALSE, ENABLED_TRUE, ERRORDESTINATION, EXACTLY_ONCE, EXPORT_TO_ALL, EXPORT_TO_NONE, FIFO, FORWARDING_POLICY_PARTITIONED, FORWARDING_POLICY_REPLICATED, INITIALCONTEXTFACTORY, INSERTION_ENABLED, INSERTION_PAUSED, INSERTION_PAUSING, KEEP_NEW, KEEP_OLD, KEY_DIRECTION_ASCENDING, KEY_DIRECTION_DESCENDING, KEY_TYPE_BOOLEAN, KEY_TYPE_BYTE, KEY_TYPE_DOUBLE, KEY_TYPE_FLOAT, KEY_TYPE_INT, KEY_TYPE_LONG, KEY_TYPE_SHORT, KEY_TYPE_STRING, LOGGING, NEVER, NO_DELIVERY, NO_OVERRIDE, NON_PERSISTENT, NON_XML, PAUSED_AT_STARTUP_DEFAULT, PAUSED_AT_STARTUP_FALSE, PERSISTENT, PREEMPTIVE, PRIORITY_DEFAULT, PRIORITY_MAXIMUM, PRIORITY_MINIMUM, PRODUCTION_ENABLED, PRODUCTION_PAUSED, PRODUCTION_PAUSING, QUEUE, RANDOM, ROUND_ROBIN, SEND_QUOTA_BLOCKING_TIMEOUT, SINGLE_MESSAGE, STORE_ENABLED_DEFAULT, STORE_ENABLED_FALSE, STORE_ENABLED_TRUE, STORE_TYPE_FILE, STORE_TYPE_JDBC, SUBSCRIPTION_EXCLUSIVE, SUBSCRIPTION_SHARABLE, SUPPORTS, SYNCWRITE_CACHEFLUSH, SYNCWRITE_DIRECTWRITE, SYNCWRITE_DISABLED, TOPIC, TOPIC_SUBSCRIBER_ONLY, TRANSACTION_MODE_51, TRANSACTION_MODE_NONE, TRANSACTION_MODE_XA, UNITOFORDER_STANDARD, UNITOFORDER_SYSTEM, XML, XMLALL| Modifier and Type | Method | Description |
|---|---|---|
boolean |
addSessionPool(JMSSessionPoolMBean sessionPool) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
boolean |
addTarget(TargetMBean target) |
Targets the JMSServer to the specified target instance.
|
JMSSessionPoolMBean |
createJMSSessionPool(java.lang.String name) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
JMSSessionPoolMBean |
createJMSSessionPool(java.lang.String name,
JMSSessionPoolMBean toClone) |
Deprecated.
9.0.0.0 Replaced with the JMS module functionality.
|
void |
destroyJMSSessionPool(JMSSessionPoolMBean sessionPool) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
java.lang.String |
getBlockingSendPolicy() |
Determines whether the JMS server delivers smaller messages
before larger ones when a destination has exceeded its maximum
number of messages.
|
long |
getBytesMaximum() |
The maximum number of bytes that can be stored in this JMS server.
|
long |
getBytesThresholdHigh() |
The upper threshold (number of bytes stored in this JMS server)
that triggers flow control and logging events.
|
long |
getBytesThresholdLow() |
The lower threshold (number of bytes stored in this JMS server)
that triggers flow control and logging events.
|
java.lang.String |
getConsumptionPausedAtStartup() |
Indicates whether consumption is paused at startup on destinations
targeted to this JMS server at startup.
|
int |
getExpirationScanInterval() |
The number of seconds
between this JMS server's cycles of scanning local destinations for
expired messages.
|
java.lang.String |
getInsertionPausedAtStartup() |
Indicates whether insertion is paused at startup on destinations
targeted to this JMS server.
|
JMSMessageLogFileMBean |
getJMSMessageLogFile() |
Deprecated.
|
JMSSessionPoolMBean[] |
getJMSSessionPools() |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
int |
getMaximumMessageSize() |
The maximum number of bytes allowed in individual messages on this JMS server.
|
long |
getMessageBufferSize() |
The amount of memory (in bytes) that this JMS server can use
to store message bodies before it writes them 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 number of messages that can be stored in this JMS server.
|
long |
getMessagesThresholdHigh() |
The upper threshold (number of messages stored in this JMS
server) that triggers flow control and logging events.
|
long |
getMessagesThresholdLow() |
The lower threshold (number of messages stored in this JMS
server) that triggers flow control and logging events.
|
java.lang.String |
getName() |
The user-specified name of this MBean instance.
|
int |
getPagingBlockSize() |
The smallest addressable block, in bytes, of a file.
|
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.
|
int |
getPagingIoBufferSize() |
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
|
long |
getPagingMaxFileSize() |
The paging maximum file size, in bytes.
|
int |
getPagingMaxWindowBufferSize() |
The maximum amount of data, in bytes and rounded down to the nearest power of 2,
mapped into the JVM's address space per paging store file.
|
int |
getPagingMinWindowBufferSize() |
The minimum amount of data, in bytes and rounded down to the nearest power of 2,
mapped into the JVM's address space per paging store file.
|
PersistentStoreMBean |
getPersistentStore() |
The file or database in which this JMS server stores persistent
messages.
|
java.lang.String |
getProductionPausedAtStartup() |
Specifies whether production is paused at server startup on destinations
targeted to this JMS server.
|
JMSSessionPoolMBean[] |
getSessionPools() |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
boolean |
getStoreEnabled() |
Specifies whether message persistence is supported for this JMS server.
|
TargetMBean[] |
getTargets() |
The server instances, clusters, or a migratable targets defined in the current domain that are
candidates for hosting the JMSSerer.
|
java.lang.String |
getTemporaryTemplateName() |
The name of a configured JMS template that this JMS server uses to create
temporary destinations.
|
java.lang.String |
getTemporaryTemplateResource() |
The name of a JMS module that contains a template that this JMS
server can use to create temporary destinations.
|
boolean |
isAllowsPersistentDowngrade() |
Specifies whether JMS clients will get an exception when
sending persistent messages to a destination targeted to a JMS server
that does not have a persistent store configured.
|
boolean |
isBytesPagingEnabled() |
Deprecated.
9.0.0.0 Replaced by defaulting the paging to always be enabled.
|
boolean |
isHostingTemporaryDestinations() |
Specifies whether this JMS server can be used to host temporary destinations.
|
boolean |
isMessagesPagingEnabled() |
Deprecated.
9.0.0.0 Replaced by defaulting the paging to always be enabled.
|
boolean |
isPagingFileLockingEnabled() |
Determines whether OS file locking is used.
|
boolean |
isPagingMessageCompressionEnabled() |
Enables the JMS paging store to perform message body
compression on persistent and non-persistent messages.
|
boolean |
isStoreMessageCompressionEnabled() |
Enables the JMS store to perform message body
compression.
|
JMSSessionPoolMBean |
lookupJMSSessionPool(java.lang.String name) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
boolean |
removeSessionPool(JMSSessionPoolMBean sessionPool) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
boolean |
removeTarget(TargetMBean target) |
Untargets the JMSServer instance from the current target.
|
void |
setAllowsPersistentDowngrade(boolean allows) |
Sets the value of the isAllowsPersistentDowngrade attribute.
|
void |
setBlockingSendPolicy(java.lang.String blockingSendPolicy) |
Sets the value of the BlockingSendPolicy attribute.
|
void |
setBytesMaximum(long bytesMaximum) |
Sets the value of the BytesMaximum attribute.
|
void |
setBytesPagingEnabled(boolean enabled) |
Deprecated.
9.0.0.0 Replaced by defaulting the paging to always be enabled.
|
void |
setBytesThresholdHigh(long bytesThresholdHigh) |
Sets the value of the BytesThresholdHigh attribute.
|
void |
setBytesThresholdLow(long bytesThresholdLow) |
Sets the value of the BytesThresholdLow attribute.
|
void |
setConsumptionPausedAtStartup(java.lang.String enabled) |
Sets the value of the ConsumptionPausedAtStartup attribute.
|
void |
setExpirationScanInterval(int scanPeriod) |
Sets the value of the ExpirationScanInterval attribute.
|
void |
setHostingTemporaryDestinations(boolean hosting) |
Sets the value of the HostingTemporaryDestinations attribute.
|
void |
setInsertionPausedAtStartup(java.lang.String enabled) |
Sets the value of the InsertionPausedAtStartup 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 |
setMessagesPagingEnabled(boolean enabled) |
Deprecated.
9.0.0.0 Replaced by defaulting the paging to always be enabled.
|
void |
setMessagesThresholdHigh(long messagesThresholdHigh) |
Sets the value of the MessagesThresholdHigh attribute.
|
void |
setMessagesThresholdLow(long messagesThresholdLow) |
Sets the value of the MessagesThresholdLow attribute.
|
void |
setPagingBlockSize(int pagingBlockSize) |
|
void |
setPagingDirectory(java.lang.String directory) |
Sets the value of the PagingDirectory attribute.
|
void |
setPagingFileLockingEnabled(boolean pagingFileLockingEnabled) |
|
void |
setPagingIoBufferSize(int pagingIoBufferSize) |
|
void |
setPagingMaxFileSize(long pagingMaxFileSize) |
|
void |
setPagingMaxWindowBufferSize(int pagingMaxWindowBufferSize) |
|
void |
setPagingMessageCompressionEnabled(boolean allows) |
Sets the value of the isPagingMessageCompressionEnabled attribute.
|
void |
setPagingMinWindowBufferSize(int pagingMinWindowBufferSize) |
|
void |
setPersistentStore(PersistentStoreMBean store) |
Sets the value of the PersistentStore attribute.
|
void |
setProductionPausedAtStartup(java.lang.String enabled) |
Sets the value of the ProductionPausedAtStartup attribute.
|
void |
setSessionPools(JMSSessionPoolMBean[] pools) |
Deprecated.
9.0.0.0 Replaced by message-driven beans.
|
void |
setStoreEnabled(boolean enabled) |
|
void |
setStoreMessageCompressionEnabled(boolean allows) |
Sets the value of the isStoreMessageCompressionEnabled attribute.
|
void |
setTargets(TargetMBean[] Targets) |
Sets the value of the getTargets attribute.
|
void |
setTemporaryTemplateName(java.lang.String templateName) |
Sets the value of the TemporaryTemplateName attribute.
|
void |
setTemporaryTemplateResource(java.lang.String resource) |
Sets the value of the TemporaryTemplateResource attribute.
|
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSetgetDeploymentOrder, setDeploymentOrderaddPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListenergetAttribute, getAttributes, invoke, setAttribute, setAttributespostDeregister, postRegister, preDeregister, preRegisteraddNotificationListener, getNotificationInfo, removeNotificationListenergetMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParentjava.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 ConfigurationMBeangetName in interface WebLogicMBeanTargetMBean[] getTargets()
The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer.
In a clustered environment, a recommended best practice is to use a cluster as a target or target a JMSServer to the same migratable target as the Persistent Store that it uses, so that a member server will not be a single point of failure. A JMSServer can also be configured to automatically migrate from an unhealthy server instance to a healthy server instance with the help of the automatic service migration feature.
getTargets in interface DeploymentMBeanvoid setTargets(TargetMBean[] Targets) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Sets the value of the getTargets attribute.
setTargets in interface DeploymentMBeanTargets - The new targets valuejavax.management.InvalidAttributeValueExceptionDistributedManagementExceptiongetTargets()boolean addTarget(TargetMBean target) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Targets the JMSServer to the specified target instance. The target must be either a server, cluster, or a migratable target.
addTarget in interface DeploymentMBeantarget - The target where the JMSServer needs to be deployedjavax.management.InvalidAttributeValueExceptionDistributedManagementExceptionboolean removeTarget(TargetMBean target) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Untargets the JMSServer instance from the current target.
removeTarget in interface DeploymentMBeantarget - The target that has to be removed from the JMSServerjavax.management.InvalidAttributeValueExceptionDistributedManagementExceptionaddTarget(weblogic.management.configuration.TargetMBean)@Deprecated JMSSessionPoolMBean[] getSessionPools()
The session pools defined for the JMS server. This method is provided for backward compatibility.
@Deprecated void setSessionPools(JMSSessionPoolMBean[] pools) throws javax.management.InvalidAttributeValueException
The session pools defined for the JMS server. This method is provided for backward compatibility.
javax.management.InvalidAttributeValueException@Deprecated boolean addSessionPool(JMSSessionPoolMBean sessionPool) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Add a session pool to the JMS server. This method is provided for backward compatibility.
sessionPool - the sessionPool to add to the JMS serverjavax.management.InvalidAttributeValueExceptionDistributedManagementException@Deprecated boolean removeSessionPool(JMSSessionPoolMBean sessionPool) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Remove a session pool from the JMS server. This method is provided for backward compatibility.
sessionPool - the sessionPool to remove from the JMS serverjavax.management.InvalidAttributeValueExceptionDistributedManagementException@Deprecated JMSSessionPoolMBean[] getJMSSessionPools()
The session pools defined for the JMS server.
@Deprecated JMSSessionPoolMBean createJMSSessionPool(java.lang.String name) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Add a session pool to the JMS server.
name - the name of the sessionPool to add to the JMS serverjavax.management.InvalidAttributeValueExceptionDistributedManagementException@Deprecated JMSSessionPoolMBean createJMSSessionPool(java.lang.String name, JMSSessionPoolMBean toClone) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Factory method to create JMSTopic object
name - toClone - the JMSSessionPool that is being cloned.javax.management.InvalidAttributeValueExceptionDistributedManagementException@Deprecated void destroyJMSSessionPool(JMSSessionPoolMBean sessionPool)
Remove a session pool from the JMS server.
sessionPool - the sessionPool to remove from the JMS server@Deprecated JMSSessionPoolMBean lookupJMSSessionPool(java.lang.String name)
Get a session pool by name from the JMS server.
PersistentStoreMBean getPersistentStore()
The file or database in which this JMS server stores persistent messages. If unspecified, the JMS server uses the default persistent store that is configured on each targeted WebLogic Server instance. If the JMS server has a store configured, then the configured store is used to store persistent messages.
The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server, cluster, or migratable target instance as this JMS server. Multiple services on the same WebLogic Server instance, including multiple JMS servers, may share the same persistent store. Each service's persistent data will be kept apart.
If you specify a PersistentStore, the deprecated Store field must not be set. If neither the PersistentStore field nor the Store field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.
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).
PersistentStoreMBeanvoid setPersistentStore(PersistentStoreMBean store) throws javax.management.InvalidAttributeValueException
Sets the value of the PersistentStore attribute.
store - The new store valuejavax.management.InvalidAttributeValueExceptiongetPersistentStore()boolean getStoreEnabled()
Specifies whether message persistence is supported for this JMS server.
true: If the JMS server has no store configured,
the targeted WebLogic Server instance's default store is used to store persistent messages.
If the JMS server has a store configured, then the configured store is used to store persistent messages. false, then this JMS server does not support persistent messages,
and instead downgrades them to non-persistent.true.Oracle recommends not setting this parameter to false. It is available to
provide compatibility with older releases.
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 setStoreEnabled(boolean enabled)
getStoreEnabled()boolean isAllowsPersistentDowngrade()
Specifies whether JMS clients will get an exception when sending persistent messages to a destination targeted to a JMS server that does not have a persistent store configured. This parameter only has effect when the Store Enabled parameter is disabled (false).
When set to false, the default, clients will get an exception when sending persistent messages to a JMS server with no store configured. When set to true, then persistent messages are downgraded to non-persistent; however, the send operations are allowed to continue.
void setAllowsPersistentDowngrade(boolean allows)
Sets the value of the isAllowsPersistentDowngrade attribute.
allows - true if downgrading persistent messages sent to destinations
hosted by this JMS server is allowableisAllowsPersistentDowngrade()boolean isHostingTemporaryDestinations()
Specifies whether this JMS server can be used to host temporary destinations.
If this field is enabled and no Temporary Template Name is defined, then the temporary destinations created on this JMS server will use all default destination values. If this field is enabled, then the JMS template to be used for creating temporary destinations is specified by the Temporary Template Name field. If this field is disabled, then this JMS server will not host temporary destinations.
void setHostingTemporaryDestinations(boolean hosting)
Sets the value of the HostingTemporaryDestinations attribute.
hosting - if true this JMSServer may host temporary destinationsisHostingTemporaryDestinations()java.lang.String getTemporaryTemplateResource()
The name of a JMS module that contains a template that this JMS server can use to create temporary destinations.
Entering a JMS module name requires you to specify a temporary template name. However, a module name cannot be specified if the Hosting Temporary Destinations field is disabled.
JMSSystemResourceMBean,
TemplateBeanvoid setTemporaryTemplateResource(java.lang.String resource)
throws javax.management.InvalidAttributeValueException
Sets the value of the TemporaryTemplateResource attribute.
resource - The name of the JMSSystemResource in which the temporary template definition can be foundjavax.management.InvalidAttributeValueExceptiongetTemporaryTemplateResource(),
JMSSystemResourceMBean,
TemplateBeanjava.lang.String getTemporaryTemplateName()
The name of a configured JMS template that this JMS server uses to create temporary destinations.
Entering a template name, requires you to specify the JMS module that contains this template. However, a template name cannot be specified if the Hosting Temporary Destinations field is disabled.
Note: If the specified JMS template provides persistent store values, they are ignored because temporary destinations do not support persistent messaging.
JMSSystemResourceMBean,
TemplateBeanvoid setTemporaryTemplateName(java.lang.String templateName)
throws javax.management.InvalidAttributeValueException
Sets the value of the TemporaryTemplateName attribute.
templateName - The name of the TemplateBean to use when creating temporary destinations on this JMSServerjavax.management.InvalidAttributeValueExceptiongetTemporaryTemplateName(),
JMSSystemResourceMBean,
TemplateBeanlong getBytesMaximum()
The maximum number of bytes that can be stored in this JMS server. A value of
-1 removes any WebLogic Server limits.
Because excessive bytes volume can cause memory saturation, Oracle recommends that this maximum corresponds to the total amount of system memory available after accounting for the rest of your application load.
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.InvalidAttributeValueExceptionDistributedManagementExceptiongetBytesMaximum()long getBytesThresholdHigh()
The upper threshold (number of bytes stored in this JMS server)
that triggers flow control and logging events. A value of
-1 disables the events for this JMS server.
The triggered events are:
Log Messages
- A message is logged on the server indicating a high threshold
condition.
Flow Control
- If flow control is enabled, the JMS server 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.InvalidAttributeValueExceptionDistributedManagementExceptiongetBytesThresholdHigh()long getBytesThresholdLow()
The lower threshold (number of bytes stored in this JMS server)
that triggers flow control and logging events. A value of
-1 disables the events for this JMS server.
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
- If flow control is enabled, the JMS server 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.InvalidAttributeValueExceptionDistributedManagementExceptiongetBytesThresholdLow()long getMessagesMaximum()
The maximum number of messages that can be stored in this JMS server. A value of
-1 removes any WebLogic Server limits.
Because excessive message volume can cause memory saturation, Oracle recommends that this value corresponds to the total amount of system memory available after accounting for the rest of your application load.
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.InvalidAttributeValueExceptionDistributedManagementExceptiongetMessagesMaximum()long getMessagesThresholdHigh()
The upper threshold (number of messages stored in this JMS
server) that triggers flow control and logging events. A value of
-1 disables the events for this JMS server.
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
- If flow control is enabled, the JMS server 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.InvalidAttributeValueExceptiongetMessagesThresholdHigh()long getMessagesThresholdLow()
The lower threshold (number of messages stored in this JMS
server) that triggers flow control and logging events. A value of
-1 disables the events for this JMS server.
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
- If flow control is enabled, the JMS server becomes disarmed and
instructs producers to begin increasing their message flow.
Note: This attribute is dynamically configurable.
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.InvalidAttributeValueExceptionDistributedManagementExceptiongetMessagesThresholdLow()@Deprecated boolean isMessagesPagingEnabled()
This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.
getMessageBufferSize()@Deprecated
void setMessagesPagingEnabled(boolean enabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the MessagesPagingEnabled attribute.
enabled - The new messagesPagingEnabled valuejavax.management.InvalidAttributeValueExceptionsetMessageBufferSize(long)@Deprecated boolean isBytesPagingEnabled()
This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.
getMessageBufferSize()@Deprecated
void setBytesPagingEnabled(boolean enabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the BytesPagingEnabled attribute.
enabled - The new bytesPagingEnabled valuejavax.management.InvalidAttributeValueExceptionsetMessageBufferSize(long)long getMessageBufferSize()
The amount of memory (in bytes) that this JMS server can use to store message bodies before it writes them to disk. When the JMS server writes the message bodies to disk, it clears them from memory.
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.
Paging is always supported.
getPagingDirectory()void setMessageBufferSize(long bufferSize)
throws javax.management.InvalidAttributeValueException
Sets the value of the MessageBufferSize attribute.
javax.management.InvalidAttributeValueExceptiongetMessageBufferSize()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 default tmp
directory inside the server-name
subdirectory of a domain's root directory.
For example, domain-name/servers/server-name/tmp,
where domain-name is the root directory of your domain.
For best performance, this directory should not be the same as the directory used by the JMS server's persistent store.
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.InvalidAttributeValueExceptiongetPagingDirectory()boolean isPagingFileLockingEnabled()
Determines whether OS file locking is used.
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
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 setPagingFileLockingEnabled(boolean pagingFileLockingEnabled)
pagingFileLockingEnabled - The new PagingFileLockingEnabled valuejavax.management.InvalidAttributeValueExceptionint getPagingMinWindowBufferSize()
The minimum amount of data, in bytes and rounded down to the nearest power of 2,
mapped into the JVM's address space per paging store file. Applies
only when a native wlfileio library is loaded.
See
Paging Maximum Window Buffer Size.
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 setPagingMinWindowBufferSize(int pagingMinWindowBufferSize)
javax.management.InvalidAttributeValueExceptionint getPagingMaxWindowBufferSize()
The maximum amount of data, in bytes and rounded down to the nearest power of 2,
mapped into the JVM's address space per paging store file.
Applies only when a native wlfileio library is loaded.
A window buffer does
not consume Java heap memory, but does consume off-heap (native) memory. If the
paging store is unable to allocate the requested buffer size, it allocates smaller and
smaller buffers until it reaches PagingMinWindowBufferSize, and then fails
if it cannot honor PagingMinWindowBufferSize.
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
See the JMS server runtime MBean attribute PagingAllocatedWindowBufferBytes to find out the
actual allocated Window Buffer Size.
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 setPagingMaxWindowBufferSize(int pagingMaxWindowBufferSize)
pagingMaxWindowBufferSize - The new PagingMaxWindowBufferSize valuejavax.management.InvalidAttributeValueExceptionint getPagingIoBufferSize()
The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.
wlfileio driver is available, the setting applies to off-heap (native) memory.wlfileio driver is not available,
the setting applies to JAVA heap memory.PagingIOBufferSize so that it is larger than the largest
write (multiple concurrent store requests may be combined into a single write).PagingAllocatedIOBufferBytes to find out the actual allocated
off-heap (native) memory amount.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 setPagingIoBufferSize(int pagingIoBufferSize)
pagingIoBufferSize - The new PagingIOBufferSize valuejavax.management.InvalidAttributeValueExceptionlong getPagingMaxFileSize()
The paging maximum file size, in bytes.
PagingMaxFileSize value affects the number of files needed to accommodate
a paging store of a particular size (number of files = paging store size/MaxFileSize rounded up).PagingMaxFileSize if there is not enough space for a new
record. If there is no space left in exiting files for a new record, a paging store creates an additional file.PagingMaxFileSize is larger than 2^24 * PagingBlockSize, then MaxFileSize is
ignored, and the value becomes 2^24 * PagingBlockSize. The default PagingBlockSize is 512,
and 2^24 * 512 is 8 GB. Oracle recommends not setting the Paging Max File Size above the default value of 1,342,177,280.
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 setPagingMaxFileSize(long pagingMaxFileSize)
pagingMaxFileSize - The new PagingMaxFileSize valuejavax.management.InvalidAttributeValueExceptionint getPagingBlockSize()
The smallest addressable block, in bytes, of a file.
When a native wlfileio driver is available
and the paging block size has not been configured by the user,
the store selects the minimum OS specific value for unbuffered
(direct) I/O, if it is within the range [512, 8192].
A paging store's block size does not change once the paging store creates its files. Changes to block size only take effect for new paging stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server.
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 setPagingBlockSize(int pagingBlockSize)
pagingBlockSize - The new PagingBlockSize valuejavax.management.InvalidAttributeValueExceptionvoid setExpirationScanInterval(int scanPeriod)
throws javax.management.InvalidAttributeValueException
Sets the value of the ExpirationScanInterval attribute.
scanPeriod - The new expirationScanInterval valuejavax.management.InvalidAttributeValueExceptiongetExpirationScanInterval()int getExpirationScanInterval()
The number of seconds
between this JMS server's cycles of scanning local destinations for
expired messages. A value of 0 disables active scanning. A
very large scan interval effectively disables active scanning.
With scanning disabled, users still do not receive expired messages and any expired messages that are discovered by other system activities are removed. However, expired messages sitting in idle destinations (such as an inactive queue or disconnected durable subscriber) are not removed and continue to consume system resources.
The scanning cycle for expired messages occurs as follows:
Note: Because a new scan does not start until the current one is finished and until the specified waiting period ends, an expired message could still remain in the system for the maximum scan waiting period plus the amount of time it takes to perform the scan.
int getMaximumMessageSize()
The maximum number of bytes allowed in individual messages on this JMS server.
The size of a message includes the message body, any user-defined
properties, and the user-defined JMS header fields
JMSCorrelationID and JMSType.
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.
Note: Any change to this maximum 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.InvalidAttributeValueExceptionDistributedManagementExceptiongetMaximumMessageSize()java.lang.String getBlockingSendPolicy()
Determines whether the JMS server delivers smaller messages
before larger ones when a destination has exceeded its maximum
number of messages. FIFO prevents the JMS server from
delivering smaller messages when larger ones are already waiting
for space. Preemptive allows smaller send requests to
preempt previous larger ones when there is sufficient space for
smaller messages on the destination.
This policy is defined only for the JMS server; it cannot be set on individual destinations.
Additional information on the FIFO and
Preemptive policies is provided below.
FIFO (first in, first out) indicates that all send requests
for the same destination are queued up one behind the other until
space is available. No send request is permitted to successfully
complete if there is another send request waiting for space before
it. When space is limited, the FIFO policy prevents the starvation
of larger requests because smaller requests cannot continuously use
the remaining available space. Smaller requests are delayed, though
not starved, until the larger request can be completed. When space
does become available, requests are considered in the order in
which they were made.
If there is sufficient space for a given request, then that
request is completed and the next request is considered. If there
is insufficient space for a given request, then no further requests
are considered until sufficient space becomes available for the
current request to complete.
Preemptive indicates that a send operation can preempt other blocking send
operations if space is available. That is, if there is sufficient
space for the current request, then that space is used even if
there are other requests waiting for space. When space is limited,
the Preemptive policy can result in the starvation of larger
requests. For example, if there is insufficient available space for
a large request, then it is queued up behind other existing
requests. When space does become available, all requests are
considered in the order in which they were originally made.
If there is sufficient space for a given request, then that
request is allowed to continue and the next request is considered.
If there is insufficient space for a given request, then that
request is skipped and the next request is considered.
void setBlockingSendPolicy(java.lang.String blockingSendPolicy)
throws javax.management.InvalidAttributeValueException
Sets the value of the BlockingSendPolicy attribute.
blockingSendPolicy - The new blockingSendPolicy valuejavax.management.InvalidAttributeValueExceptiongetBlockingSendPolicy()void setProductionPausedAtStartup(java.lang.String enabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the ProductionPausedAtStartup attribute.
enabled - The new ProductionPausedAtStartup valuejavax.management.InvalidAttributeValueExceptiongetProductionPausedAtStartup()java.lang.String getProductionPausedAtStartup()
Specifies whether production is paused at server startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host
server instance is rebooted, then this JMS server and its
targeted destinations are modified such that they are in a "production paused"
state, which results in preventing new message
production activities on those destinations.
To resume normal new message production activity, later you will
have to change the state of this JMS server to a
"production enabled" state by setting this value to false,
and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Production Paused At Startup
is determined based on the corresponding setting on the individual destination.
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).
JMSServerRuntimeMBean.resumeProduction(),
JMSDestinationRuntimeMBean.resumeProduction()void setInsertionPausedAtStartup(java.lang.String enabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the InsertionPausedAtStartup attribute.
enabled - The new InsertionPausedAtStartup valuejavax.management.InvalidAttributeValueExceptiongetInsertionPausedAtStartup()java.lang.String getInsertionPausedAtStartup()
Indicates whether insertion is paused at startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host
server instance is booted, then this JMS server and its
targeted destinations are modified such that they are in a "insertion paused"
state, which results preventing messages that are result of
the "in-flight" work completion to arrive on those destinations.
Note: For a detailed definition of "in-flight" work/messages, see weblogic.management.runtime.JMSServerRuntimeMBean#resumeInsertion and weblogic.management.runtime.JMSDestinationRuntime#resumeInsertion
To allow in-flight work messages to appear on the destinations,
later you will have to change the state of this JMS server to an
"insertion enabled" state by setting this value to false,
and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Insertion Paused At Startup
is determined based on the corresponding setting on the individual destination.
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 setConsumptionPausedAtStartup(java.lang.String enabled)
throws javax.management.InvalidAttributeValueException
Sets the value of the ConsumptionPausedAtStartup attribute.
enabled - The new ConsumptionPausedAtStartup valuejavax.management.InvalidAttributeValueExceptiongetConsumptionPausedAtStartup()java.lang.String getConsumptionPausedAtStartup()
Indicates whether consumption is paused at startup on destinations targeted to this JMS server at startup. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host
server instance is booted, then this JMS server and its
targeted destinations are modified such that they are in a "consumption paused"
state, which prevents any message consuming activity on those destinations.
To allow normal message consumption on the destinations,
later you will have to change the state of this JMS server to a
"consumption enabled" state by setting this value to false,
and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Consumption Paused At Startup
is determined based on the corresponding setting on the individual destination.
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).
JMSServerRuntimeMBean.resumeConsumption(),
JMSDestinationRuntimeMBean.resumeConsumption()@Deprecated JMSMessageLogFileMBean getJMSMessageLogFile()
The message log file configuration for this JMS Server.
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()