weblogic.management.configuration
Interface JMSServerMBean

All Superinterfaces:

ConfigurationMBean, DeploymentMBean, JMSConstants, TargetMBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

Access limited to the following security roles:

Deployer

getTargets

TargetMBean[] getTargets()

The server instances 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 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.

Specified by:

getTargets in interface DeploymentMBean

Returns:

The targets value

setTargets

void setTargets(TargetMBean[] Targets)
                throws InvalidAttributeValueException,
                       DistributedManagementException

Sets the value of the getTargets attribute.

Specified by:

setTargets in interface DeploymentMBean

Parameters:

Targets - The new targets value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getTargets()

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

addTarget

boolean addTarget(TargetMBean target)
                  throws InvalidAttributeValueException,
                         DistributedManagementException

Targets the JMSServer to the specified target instance. The target must be either a server or a migratable target.

Specified by:

addTarget in interface DeploymentMBean

Parameters:

target - The target where the JMSServer needs to be deployed

Returns:

Throws:

InvalidAttributeValueException

DistributedManagementException

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

removeTarget

boolean removeTarget(TargetMBean target)
                     throws InvalidAttributeValueException,
                            DistributedManagementException

Untargets the JMSServer instance from the current target.

Specified by:

removeTarget in interface DeploymentMBean

Parameters:

target - The target that has to be removed from the JMSServer

Returns:

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.addTarget(weblogic.management.configuration.TargetMBean)

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

getSessionPools

JMSSessionPoolMBean[] getSessionPools()

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

The session pools defined for the JMS server. This method is provided for backward compatibility.

Returns:

The sessionPools value

setSessionPools

void setSessionPools(JMSSessionPoolMBean[] pools)
                     throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

The session pools defined for the JMS server. This method is provided for backward compatibility.

Throws:

InvalidAttributeValueException

addSessionPool

boolean addSessionPool(JMSSessionPoolMBean sessionPool)
                       throws InvalidAttributeValueException,
                              DistributedManagementException

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

Add a session pool to the JMS server. This method is provided for backward compatibility.

Parameters:

sessionPool - the sessionPool to add to the JMS server

Throws:

InvalidAttributeValueException

DistributedManagementException

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

removeSessionPool

boolean removeSessionPool(JMSSessionPoolMBean sessionPool)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

Remove a session pool from the JMS server. This method is provided for backward compatibility.

Parameters:

sessionPool - the sessionPool to remove from the JMS server

Throws:

InvalidAttributeValueException

DistributedManagementException

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

getJMSSessionPools

JMSSessionPoolMBean[] getJMSSessionPools()

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

The session pools defined for the JMS server.

Returns:

The sessionPools value

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

createJMSSessionPool

JMSSessionPoolMBean createJMSSessionPool(String name)
                                         throws InvalidAttributeValueException,
                                                DistributedManagementException

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

Add a session pool to the JMS server.

Parameters:

name - the name of the sessionPool to add to the JMS server

Throws:

InvalidAttributeValueException

DistributedManagementException

destroyJMSSessionPool

void destroyJMSSessionPool(JMSSessionPoolMBean sessionPool)

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

Remove a session pool from the JMS server.

Parameters:

sessionPool - the sessionPool to remove from the JMS server

lookupJMSSessionPool

JMSSessionPoolMBean lookupJMSSessionPool(String name)

Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information.

Get a session pool by name from the JMS server.

getDestinations

JMSDestinationMBean[] getDestinations()

Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

All defined destinations and their associated JNDI names.

Returns:

The destinations value

setDestinations

void setDestinations(JMSDestinationMBean[] destinations)
                     throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

Sets the value of the Destinations attribute.

Parameters:

destinations - The new destinations value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getDestinations()

addDestination

boolean addDestination(JMSDestinationMBean destination)
                       throws InvalidAttributeValueException,
                              DistributedManagementException

Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

Add a JMS destination to the JMS server.

Parameters:

destination - the destination to be added to the JMS server

Throws:

InvalidAttributeValueException

DistributedManagementException

IllegalArgumentException - if destination is null or exists

removeDestination

boolean removeDestination(JMSDestinationMBean destination)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules.

Removes a destination from the JNDI tree.

Parameters:

destination - the destination to be removed from the JMS server

Throws:

InvalidAttributeValueException

DistributedManagementException

IllegalArgumentException - if destination is null or does not exist

getStore

JMSStoreMBean getStore()

Deprecated. 9.0.0.0 Replaced with the PersistentStore attribute.

The persistent disk-based file or JDBC-accessible database for the JMS server.

A persistent store may only be used by one JMS server. If this value is unset, the value set by the "PersistentStore" attribute is used. If neither attribute is set, the default persistent store for the targeted managed server is used. It is an error to set both attributes.

This attribute has been deprecated. New configurations should use the "PersistentStore" attribute, which allows multiple subsystems, including multiple JMS servers on the same managed server, to share the same persistent store.

Returns:

The store value

See Also:

JMSServerMBean.getPersistentStore()

setStore

void setStore(JMSStoreMBean store)
              throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced with the PersistentStore attribute.

Sets the value of the Store attribute.

Parameters:

store - The new store value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getStore()

Default Value:

null

getPersistentStore

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.

The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server 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.

Returns:

the store value

See Also:

weblogic.management.configuration.PersistentStoreMBean

setPersistentStore

void setPersistentStore(PersistentStoreMBean store)
                        throws InvalidAttributeValueException

Sets the value of the PersistentStore attribute.

Parameters:

store - The new store value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getPersistentStore()

Default Value:

null

getStoreEnabled

boolean getStoreEnabled()

Specifies whether message persistence is supported for this JMS server.

When set to true, the default, then if the JMS server has no store configured, the targeted WebLogic Server instance's default store is used to store persistent messages. When set to false, then this JMS server does not support persistent messages, and instead downgrades them to non-persistent.

Oracle recommends not setting this parameter to false. It is available to provide compatibility with older releases.

setStoreEnabled

void setStoreEnabled(boolean enabled)

See Also:

JMSServerMBean.getStoreEnabled()

Default Value:

true

isAllowsPersistentDowngrade

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.

Returns:

true if downgrading persistent messages sent to destinations hosted by this JMS server is allowable

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

Default Value:

false

setAllowsPersistentDowngrade

void setAllowsPersistentDowngrade(boolean allows)

Sets the value of the isAllowsPersistentDowngrade attribute.

Parameters:

allows - true if downgrading persistent messages sent to destinations hosted by this JMS server is allowable

See Also:

JMSServerMBean.isAllowsPersistentDowngrade()

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

Default Value:

false

getTemporaryTemplate

JMSTemplateMBean getTemporaryTemplate()

Deprecated. 9.0.0.0 Replaced with the TemporaryTemplateName and TemporaryTemplateResource attributes.

The name of an existing JMS template to use when creating all temporary queues and topics for this JMS server. Specifying a value for this field allows JMS applications to create temporary destinations. If Store values are provided as part of a temporary template, they are ignored, because temporary destinations do not support persistent messaging.

Note: If this attribute is set to none, attempts to create a temporary destination (queue or topic) will fail.

Returns:

The temporaryTemplate value

setTemporaryTemplate

void setTemporaryTemplate(JMSTemplateMBean temporaryTemplate)
                          throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced with the TemporaryTemplateName and TemporaryTemplateResource attributes.

Sets the value of the TemporaryTemplate attribute.

Parameters:

temporaryTemplate - the temporary template for the JMS server

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getTemporaryTemplate()

Default Value:

null

isHostingTemporaryDestinations

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.

Returns:

true if this JMSServer may host temporary destinations

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

Default Value:

true

setHostingTemporaryDestinations

void setHostingTemporaryDestinations(boolean hosting)

Sets the value of the HostingTemporaryDestinations attribute.

Parameters:

hosting - if true this JMSServer may host temporary destinations

See Also:

JMSServerMBean.isHostingTemporaryDestinations()

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

Default Value:

true

getTemporaryTemplateResource

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.

Returns:

The name of the JMSSystemResource where the temporary template can be found

See Also:

JMSSystemResourceMBean, weblogic.j2ee.descriptor.wl.TemplateBean

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

setTemporaryTemplateResource

void setTemporaryTemplateResource(String resource)
                                  throws InvalidAttributeValueException

Sets the value of the TemporaryTemplateResource attribute.

Parameters:

resource - The name of the JMSSystemResource in which the temporary template definition can be found

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getTemporaryTemplateResource(), JMSSystemResourceMBean, weblogic.j2ee.descriptor.wl.TemplateBean

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

getTemporaryTemplateName

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.

Returns:

The name of the TemplateBean to use for temporary destinations

See Also:

JMSSystemResourceMBean, weblogic.j2ee.descriptor.wl.TemplateBean

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

setTemporaryTemplateName

void setTemporaryTemplateName(String templateName)
                              throws InvalidAttributeValueException

Sets the value of the TemporaryTemplateName attribute.

Parameters:

templateName - The name of the TemplateBean to use when creating temporary destinations on this JMSServer

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getTemporaryTemplateName(), JMSSystemResourceMBean, weblogic.j2ee.descriptor.wl.TemplateBean

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

getBytesMaximum

long 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

Returns:

The bytesMaximum value

setBytesMaximum

void setBytesMaximum(long bytesMaximum)
                     throws InvalidAttributeValueException,
                            DistributedManagementException

Sets the value of the BytesMaximum attribute.

Parameters:

bytesMaximum - The new bytesMaximum value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getBytesMaximum()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getBytesThresholdHigh

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

Returns:

The bytesThresholdHigh value

setBytesThresholdHigh

void setBytesThresholdHigh(long bytesThresholdHigh)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Sets the value of the BytesThresholdHigh attribute.

Parameters:

bytesThresholdHigh - The new bytesThresholdHigh value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getBytesThresholdHigh()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getBytesThresholdLow

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

Returns:

The bytesThresholdLow value

setBytesThresholdLow

void setBytesThresholdLow(long bytesThresholdLow)
                          throws InvalidAttributeValueException,
                                 DistributedManagementException

Sets the value of the BytesThresholdLow attribute.

Parameters:

bytesThresholdLow - The new bytesThresholdLow value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getBytesThresholdLow()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesMaximum

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.

Returns:

The messagesMaximum value

setMessagesMaximum

void setMessagesMaximum(long messagesMaximum)
                        throws InvalidAttributeValueException,
                               DistributedManagementException

Sets the value of the MessagesMaximum attribute.

Parameters:

messagesMaximum - The new messagesMaximum value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getMessagesMaximum()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesThresholdHigh

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.

Returns:

The messagesThresholdHigh value

setMessagesThresholdHigh

void setMessagesThresholdHigh(long messagesThresholdHigh)
                              throws InvalidAttributeValueException

Sets the value of the MessagesThresholdHigh attribute.

Parameters:

messagesThresholdHigh - The new messagesThresholdHigh value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getMessagesThresholdHigh()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getMessagesThresholdLow

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

Returns:

The messagesThresholdLow value

setMessagesThresholdLow

void setMessagesThresholdLow(long messagesThresholdLow)
                             throws InvalidAttributeValueException,
                                    DistributedManagementException

Sets the value of the MessagesThresholdLow attribute.

Parameters:

messagesThresholdLow - The new messagesThresholdLow value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getMessagesThresholdLow()

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

Default Value:

-1

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getPagingStore

JMSStoreMBean getPagingStore()

Deprecated. 9.0.0.0 Replaced with the PagingDirectory attribute.

This parameter has been deprecated. New configurations should use the "PagingDirectory" parameter if they wish to control where non-persistent messages will be temporarily stored.

Returns:

The pagingStore value

See Also:

JMSServerMBean.getPagingDirectory()

setPagingStore

void setPagingStore(JMSStoreMBean store)
                    throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced with the PagingDirectory attribute.

Sets the value of the PagingStore attribute.

Parameters:

store - The new pagingStore value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.setPagingDirectory(java.lang.String)

Default Value:

null

isMessagesPagingEnabled

boolean isMessagesPagingEnabled()

Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.

Returns:

The MessagesPagingEnabled value

See Also:

JMSServerMBean.getMessageBufferSize()

setMessagesPagingEnabled

void setMessagesPagingEnabled(boolean enabled)
                              throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

Sets the value of the MessagesPagingEnabled attribute.

Parameters:

enabled - The new messagesPagingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.setMessageBufferSize(long)

Default Value:

false

isBytesPagingEnabled

boolean isBytesPagingEnabled()

Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.

Returns:

The BytesPagingEnabled value

See Also:

JMSServerMBean.getMessageBufferSize()

setBytesPagingEnabled

void setBytesPagingEnabled(boolean enabled)
                           throws InvalidAttributeValueException

Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled.

Sets the value of the BytesPagingEnabled attribute.

Parameters:

enabled - The new bytesPagingEnabled value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.setMessageBufferSize(long)

Default Value:

false

getMessageBufferSize

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.

See Also:

JMSServerMBean.getPagingDirectory()

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

Default Value:

JMSConstants.DEFAULT_MESSAGE_BUFFER_SIZE

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

setMessageBufferSize

void setMessageBufferSize(long bufferSize)
                          throws InvalidAttributeValueException

Sets the value of the MessageBufferSize attribute.

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getMessageBufferSize()

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

Default Value:

JMSConstants.DEFAULT_MESSAGE_BUFFER_SIZE

Maximum Value:

java.lang.Long.MAX_VALUE

Minimum Value:

-1

getPagingDirectory

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.

See Also:

JMSServerMBean.getMessageBufferSize()

Default Value:

null

setPagingDirectory

void setPagingDirectory(String directory)
                        throws InvalidAttributeValueException

Sets the value of the PagingDirectory attribute.

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getPagingDirectory()

Default Value:

null

isPagingFileLockingEnabled

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.

Returns:

PagingFileLockingEnabled value

setPagingFileLockingEnabled

void setPagingFileLockingEnabled(boolean pagingFileLockingEnabled)

See GenericFileStoreMBean.setFileLockingEnabled.

Parameters:

pagingFileLockingEnabled - The new PagingFileLockingEnabled value

Throws:

InvalidAttributeValueException

Default Value:

true

getPagingMinWindowBufferSize

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. Applies only when a native wlfileio library is loaded. See Paging Maximum Window Buffer Size.

Returns:

The PagingMinWindowBufferSize value

setPagingMinWindowBufferSize

void setPagingMinWindowBufferSize(int pagingMinWindowBufferSize)

See GenericFileStoreMBean.setMinWindowBufferSize.

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

1073741824

Minimum Value:

-1

getPagingMaxWindowBufferSize

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. 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.

• Returns:

  The PagingMaxWindowBufferSize value

setPagingMaxWindowBufferSize

void setPagingMaxWindowBufferSize(int pagingMaxWindowBufferSize)

See GenericFileStoreMBean.setMaxWindowBufferSize.

Parameters:

pagingMaxWindowBufferSize - The new PagingMaxWindowBufferSize value

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

1073741824

Minimum Value:

-1

getPagingIoBufferSize

int getPagingIoBufferSize()

The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.

• When a native wlfileio driver is available, the setting applies to off-heap (native) memory.
• When a native wlfileio driver is not available, the setting applies to JAVA heap memory.
• For the best runtime performance, Oracle recommends setting PagingIOBufferSize so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).
• See the JMS server runtime MBean attribute PagingAllocatedIOBufferBytes to find out the actual allocated off-heap (native) memory amount.

Returns:

The PagingIoBufferSize value

setPagingIoBufferSize

void setPagingIoBufferSize(int pagingIoBufferSize)

See GenericFileStoreMBean.IoBufferSize.

Parameters:

pagingIoBufferSize - The new PagingIOBufferSize value

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

67108864

Minimum Value:

-1

getPagingMaxFileSize

long getPagingMaxFileSize()

The paging maximum file size, in bytes.

• The 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).
• A paging store automatically reuses space freed by deleted records and automatically expands individual files up to 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.
• A small number of larger files is normally preferred over a large number of smaller files as each file allocates Window Buffer and file handles.
• If 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.

Returns:

The PagingMaxFileSize value

setPagingMaxFileSize

void setPagingMaxFileSize(long pagingMaxFileSize)

See GenericFileStoreMBean.setMaxFileSize.

Parameters:

pagingMaxFileSize - The new PagingMaxFileSize value

Throws:

InvalidAttributeValueException

Default Value:

1342177280

Minimum Value:

10485760

getPagingBlockSize

int 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.

Returns:

The PagingBlockSize value

setPagingBlockSize

void setPagingBlockSize(int pagingBlockSize)

See GenericFileStoreMBean.setBlockSize.

Parameters:

pagingBlockSize - The new PagingBlockSize value

Throws:

InvalidAttributeValueException

Default Value:

-1

Maximum Value:

8192

Minimum Value:

-1

setExpirationScanInterval

void setExpirationScanInterval(int scanPeriod)
                               throws InvalidAttributeValueException

Sets the value of the ExpirationScanInterval attribute.

Parameters:

scanPeriod - The new expirationScanInterval value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getExpirationScanInterval()

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

Default Value:

30

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getExpirationScanInterval

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:

• After the specified waiting period, the JMS server devotes a separate thread to scan all of its local destinations for expired messages.
• After the scanning is completed, all located expired messages are processed according to the specified Expiration Policy on the destination (Discard, Log, or Redirect).
• The entire process repeats after another specified waiting period.

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.

Returns:

The ExpirationScanInterval value

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

getMaximumMessageSize

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.

Returns:

The maximumMessageSize value

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

Default Value:

java.lang.Integer.MAX_VALUE

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setMaximumMessageSize

void setMaximumMessageSize(int maxMessageSize)
                           throws InvalidAttributeValueException,
                                  DistributedManagementException

Sets the value of the MaximumMessageSize attribute.

Parameters:

maxMessageSize - The new maximumMessageSize value

Throws:

InvalidAttributeValueException

DistributedManagementException

See Also:

JMSServerMBean.getMaximumMessageSize()

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

Default Value:

java.lang.Integer.MAX_VALUE

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

getBlockingSendPolicy

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.

Returns:

The blockingSendPolicy value

setBlockingSendPolicy

void setBlockingSendPolicy(String blockingSendPolicy)
                           throws InvalidAttributeValueException

Sets the value of the BlockingSendPolicy attribute.

Parameters:

blockingSendPolicy - The new blockingSendPolicy value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getBlockingSendPolicy()

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

Default Value:

JMSConstants.FIFO

Valid Values:

JMSConstants.FIFO,JMSConstants.PREEMPTIVE

setProductionPausedAtStartup

void setProductionPausedAtStartup(String enabled)
                                  throws InvalidAttributeValueException

Sets the value of the ProductionPausedAtStartup attribute.

Parameters:

enabled - The new ProductionPausedAtStartup value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getProductionPausedAtStartup()

Default Value:

JMSConstants.PAUSED_AT_STARTUP_DEFAULT

getProductionPausedAtStartup

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.

See Also:

JMSServerRuntimeMBean.resumeProduction(), JMSDestinationRuntimeMBean.resumeProduction()

setInsertionPausedAtStartup

void setInsertionPausedAtStartup(String enabled)
                                 throws InvalidAttributeValueException

Sets the value of the InsertionPausedAtStartup attribute.

Parameters:

enabled - The new InsertionPausedAtStartup value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getInsertionPausedAtStartup()

Default Value:

JMSConstants.PAUSED_AT_STARTUP_DEFAULT

getInsertionPausedAtStartup

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.

See Also:

JMSServerRuntimeMBean.resumeInsertion(), JMSDestinationRuntimeMBean.resumeInsertion()

setConsumptionPausedAtStartup

void setConsumptionPausedAtStartup(String enabled)
                                   throws InvalidAttributeValueException

Sets the value of the ConsumptionPausedAtStartup attribute.

Parameters:

enabled - The new ConsumptionPausedAtStartup value

Throws:

InvalidAttributeValueException

See Also:

JMSServerMBean.getConsumptionPausedAtStartup()

Default Value:

JMSConstants.PAUSED_AT_STARTUP_DEFAULT

getConsumptionPausedAtStartup

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.

Returns:

current value

See Also:

JMSServerRuntimeMBean.resumeConsumption(), JMSDestinationRuntimeMBean.resumeConsumption()

getJMSQueues

JMSQueueMBean[] getJMSQueues()

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Acquire JMSQueues for this JMSServer

createJMSQueue

JMSQueueMBean createJMSQueue(String name)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Factory method to create JMSQueue object

Parameters:

name -

Returns:

JMSQueue object

createJMSQueue

JMSQueueMBean createJMSQueue(String name,
                             JMSQueueMBean toClone)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Factory method to create JMSQueue object

Parameters:

name -

toClone - is the JMSQueueMBean that is being moved from the DomainMBean

Returns:

JMSQueue object

destroyJMSQueue

void destroyJMSQueue(JMSQueueMBean queue)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Removes a JMSQueue from this domain

Parameters:

queue -

lookupJMSQueue

JMSQueueMBean lookupJMSQueue(String name)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Parameters:

name -

Returns:

JMSQueue object

getJMSTopics

JMSTopicMBean[] getJMSTopics()

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Define JMSTopics for this Domain

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

createJMSTopic

JMSTopicMBean createJMSTopic(String name)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Factory method to create JMSTopic object

Parameters:

name -

Returns:

JMSTopic object

createJMSTopic

JMSTopicMBean createJMSTopic(String name,
                             JMSTopicMBean toClone)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Factory method to create JMSTopic object

Parameters:

name -

Returns:

JMSTopic object

destroyJMSTopic

void destroyJMSTopic(JMSTopicMBean topic)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Removes a JMSTopic from this domain

Parameters:

topic -

lookupJMSTopic

JMSTopicMBean lookupJMSTopic(String name)

Deprecated. 9.0.0.0 Replaced with the JMS module functionality.

Parameters:

name -

Returns:

JMSTopic object

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

getJMSMessageLogFile

JMSMessageLogFileMBean getJMSMessageLogFile()

The message log file configuration for this JMS Server.

Returns: