WebLogic Server 6.1 API Reference

weblogic.management.configuration
Interface JMSServerMBean

public interface JMSServerMBean

extends DeploymentMBean, JMSConstants

This Mbean defines a JMS Server.

Author:

Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Fields inherited from class weblogic.management.configuration.DeploymentMBean

DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

Fields inherited from class weblogic.management.configuration.JMSConstants

ACKNOWLEDGE_ALL, ACKNOWLEDGE_MODE_AUTO, ACKNOWLEDGE_MODE_CLIENT, ACKNOWLEDGE_MODE_DUPS_OK, ACKNOWLEDGE_MODE_NONE, ACKNOWLEDGE_ONE, ACKNOWLEDGE_PREVIOUS, DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC, ENABLED_DEFAULT, ENABLED_FALSE, ENABLED_TRUE, 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, NO_DELIVERY, NON_PERSISTENT, PERSISTENT, PRIORITY_DEFAULT, PRIORITY_MAXIMUM, PRIORITY_MINIMUM, STORE_ENABLED_DEFAULT, STORE_ENABLED_FALSE, STORE_ENABLED_TRUE, STORE_TYPE_FILE, STORE_TYPE_JDBC, TRANSACTION_MODE_51, TRANSACTION_MODE_NONE, TRANSACTION_MODE_XA

Method Summary

boolean	addDestination(JMSDestinationMBean destination) Add a JMSDestination to the JMS Server
boolean	addSessionPool(JMSSessionPoolMBean sessionPool) Add a session pool to the JMS Server.
long	getBytesMaximum() Returns the value of bytesMaximum.
long	getBytesThresholdHigh() Returns the value of bytesThresholdHigh.
long	getBytesThresholdLow() Returns the value of bytesThresholdLow This value is the lower threshold that triggers events based on the number of bytes stored in the JMS server.
JMSDestinationMBean[]	getDestinations() Return map containing all defined destinations and their associated JNDI names.
long	getMessagesMaximum() Returns the value of messagesMaximum.
long	getMessagesThresholdHigh() Returns the value of messagesThresholdHigh.
long	getMessagesThresholdLow() Returns the value of messagesThresholdLow This value is the lower threshold that triggers events based on the number of messages stored in the JMS server.
JMSStoreMBean	getPagingStore() Get the paging store for the JMS server.
JMSSessionPoolMBean[]	getSessionPools() Get all the session pools defined for the JMS Server.
JMSStoreMBean	getStore() Get the backing store for the JMS server.
JMSTemplateMBean	getTemporaryTemplate() Return the temporary template for the JMS Server This template that is used to create all temporary destinations on this JMS Server.
boolean	isBytesPagingEnabled() Check if BytesPagingEnabled is set.
boolean	isMessagesPagingEnabled() Check if MessagesPagingEnabled is set.
boolean	removeDestination(JMSDestinationMBean destination) Removes a destination from the JNDI tree.
boolean	removeSessionPool(JMSSessionPoolMBean sessionPool) Remove a session pool from the JMS Server.
void	setBytesMaximum(long bytesMaximum) Set the value of bytesMaximum.
void	setBytesPagingEnabled(boolean enabled) Set BytesPagingEnabled for the JMSServer.
void	setBytesThresholdHigh(long bytesThresholdHigh) Set the value of bytesThresholdHigh.
void	setBytesThresholdLow(long bytesThresholdLow) Set the value of bytesThresholdLow.
void	setDestinations(JMSDestinationMBean[] destinations) Set all defined destinations for the JMSServer.
void	setMessagesMaximum(long messagesMaximum) Set the value of messagesMaximum.
void	setMessagesPagingEnabled(boolean enabled) Set MessagesPagingEnabled for the JMSServer.
void	setMessagesThresholdHigh(long messagesThresholdHigh) Set the value of messagesThresholdHigh.
void	setMessagesThresholdLow(long messagesThresholdLow) Set the value of messagesThresholdLow.
void	setPagingStore(JMSStoreMBean store) Set the paging store for the JMS server.
void	setSessionPools(JMSSessionPoolMBean[] sessionPools) Set all the session pools defined for the JMS Server.
void	setStore(JMSStoreMBean store) Set the backing store for the JMS server.
void	setTemporaryTemplate(JMSTemplateMBean temporaryTemplate) Set the temporary template that is used to create all temporary destinations on this JMS Server.

Methods inherited from interface weblogic.management.configuration.DeploymentMBean

addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

getNotes, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

getSessionPools

public JMSSessionPoolMBean[] getSessionPools()

Get all the session pools defined for the JMS Server.

A non-configurable MBean attribute.

setSessionPools

public void setSessionPools(JMSSessionPoolMBean[] sessionPools)
                     throws javax.management.InvalidAttributeValueException

Set all the session pools defined for the JMS Server.

addSessionPool

public boolean addSessionPool(JMSSessionPoolMBean sessionPool)
                       throws javax.management.InvalidAttributeValueException,
                              DistributedManagementException

Add a session pool to the JMS Server.

A dynamic MBean attribute

Parameters:

sessionPool - the sessionPool to add to the JMS Server

removeSessionPool

public boolean removeSessionPool(JMSSessionPoolMBean sessionPool)
                          throws javax.management.InvalidAttributeValueException,
                                 DistributedManagementException

Remove a session pool from the JMS Server.

A dynamic MBean attribute

Parameters:

sessionPool - the sessionPool to remove from the JMS Server

Throws:

java.lang.IllegalArgumentException - if the sessionPool does not exist.

getDestinations

public JMSDestinationMBean[] getDestinations()

Return map containing all defined destinations and their associated JNDI names.

A non-configurable MBean attribute.

setDestinations

public void setDestinations(JMSDestinationMBean[] destinations)
                     throws javax.management.InvalidAttributeValueException

Set all defined destinations for the JMSServer.

addDestination

public boolean addDestination(JMSDestinationMBean destination)
                       throws javax.management.InvalidAttributeValueException,
                              DistributedManagementException

Add a JMSDestination to the JMS Server

A dynamic MBean attribute

Parameters:

destination - the destination to be added to the JMS Server

Throws:

java.lang.IllegalArgumentException - if destination is null or exists

removeDestination

public boolean removeDestination(JMSDestinationMBean destination)
                          throws javax.management.InvalidAttributeValueException,
                                 DistributedManagementException

Removes a destination from the JNDI tree.

A dynamic MBean attribute

Parameters:

destination - the destination to be removed from the JMS Server

Throws:

java.lang.IllegalArgumentException - if destination is null or does not exist

getStore

public JMSStoreMBean getStore()

Get the backing store for the JMS server.

setStore

public void setStore(JMSStoreMBean store)
              throws javax.management.InvalidAttributeValueException

Set the backing store for the JMS server. A backing store may only be used by one JMS server.

Default Value: null

Legal Value: ((value == void)?(true):(weblogic.management.configuration.JMSLegalHelper.isUnowned(self, value)))

getTemporaryTemplate

public JMSTemplateMBean getTemporaryTemplate()

Return the temporary template for the JMS Server This template that is used to create all temporary destinations on this JMS Server. The attributes for the temporary destinations are derived from the template. If no temporary template is defined for the JMS server, then temporary destinations receive the default values for destinations.

setTemporaryTemplate

public void setTemporaryTemplate(JMSTemplateMBean temporaryTemplate)
                          throws javax.management.InvalidAttributeValueException

Set the temporary template that is used to create all temporary destinations on this JMS Server. The attributes for the temporary destinations are derived from the template. If no temporary template is defined for the JMS server, then temporary destinations receive the default values for destinations.

Default Value: null

Parameters:

temporaryTemplate - the temporaty template for the JMS Server

getBytesMaximum

public long getBytesMaximum()

Returns the value of bytesMaximum. This value is the maximum number of bytes that may be stored in the JMS server. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the JMS server.

setBytesMaximum

public void setBytesMaximum(long bytesMaximum)
                     throws javax.management.InvalidAttributeValueException,
                            DistributedManagementException

Set the value of bytesMaximum. This value is the maximum number of bytes that may be stored in the JMS server. A value of -1 specifies that there is no limit on the number of bytes that can be stored in the JMS server.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && ( ((weblogic.management.configuration.JMSServerMBean)self).getBytesThresholdHigh() <= value) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getBytesThresholdHigh

public long getBytesThresholdHigh()

Returns the value of bytesThresholdHigh. This value is the upper threshold that triggers events based on the number of bytes stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server.

setBytesThresholdHigh

public void setBytesThresholdHigh(long bytesThresholdHigh)
                           throws javax.management.InvalidAttributeValueException,
                                  DistributedManagementException

Set the value of bytesThresholdHigh. This value is the upper threshold that triggers events based on the number of bytes stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server. generated

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((value >= 0) && (value > ((weblogic.management.configuration.JMSServerMBean)self).getBytesThresholdLow()) && ((((weblogic.management.configuration.JMSServerMBean)self).getBytesMaximum() == -1) || (value <= ((weblogic.management.configuration.JMSServerMBean)self).getBytesMaximum())) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getBytesThresholdLow

public long getBytesThresholdLow()

Returns the value of bytesThresholdLow This value is the lower threshold that triggers events based on the number of bytes stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server.

setBytesThresholdLow

public void setBytesThresholdLow(long bytesThresholdLow)
                          throws javax.management.InvalidAttributeValueException,
                                 DistributedManagementException

Set the value of bytesThresholdLow. This value is the lower threshold that triggers events based on the number of bytes stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && (( ((weblogic.management.configuration.JMSServerMBean)self).getBytesThresholdHigh() == -1) || (value < ((weblogic.management.configuration.JMSServerMBean)self).getBytesThresholdHigh())))

Legal Minimum Value: -1

getMessagesMaximum

public long getMessagesMaximum()

Returns the value of messagesMaximum. This value is the maximum number of messages that may be stored in the JMS server. A value of -1 specifies that there is no limit on the number of messages that can be stored in the JMS server.

setMessagesMaximum

public void setMessagesMaximum(long messagesMaximum)
                        throws javax.management.InvalidAttributeValueException,
                               DistributedManagementException

Set the value of messagesMaximum. This value is the maximum number of messages that may be stored in the JMS server. A value of -1 specifies that there is no limit on the number of messages that can be stored in the JMS server. This attribute is dynamically configurable.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && (((weblogic.management.configuration.JMSServerMBean)self).getMessagesThresholdHigh() <= value) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getMessagesThresholdHigh

public long getMessagesThresholdHigh()

Returns the value of messagesThresholdHigh. This value is the upper threshold that triggers events based on the number of messages stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server

setMessagesThresholdHigh

public void setMessagesThresholdHigh(long messagesThresholdHigh)
                              throws javax.management.InvalidAttributeValueException

Set the value of messagesThresholdHigh. This value is the upper threshold that triggers events based on the number of messages stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server This attribute is dynamically configurable.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((value >= 0) && (value > ((weblogic.management.configuration.JMSServerMBean)self).getMessagesThresholdLow()) && ((((weblogic.management.configuration.JMSServerMBean)self).getMessagesMaximum() == -1) || (value <= ((weblogic.management.configuration.JMSServerMBean)self).getMessagesMaximum())) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getMessagesThresholdLow

public long getMessagesThresholdLow()

Returns the value of messagesThresholdLow This value is the lower threshold that triggers events based on the number of messages stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server.

setMessagesThresholdLow

public void setMessagesThresholdLow(long messagesThresholdLow)
                             throws javax.management.InvalidAttributeValueException,
                                    DistributedManagementException

Set the value of messagesThresholdLow. This value is the lower threshold that triggers events based on the number of messages stored in the JMS server. A value of -1 specifies that threshold events are disabled for the JMS server. This attribute is dynamically configurable.

A dynamic MBean attribute

Default Value: -1

Legal Value: (value == -1) || ((0 <= value) && (((weblogic.management.configuration.JMSServerMBean)self).getMessagesThresholdHigh() == -1 || value < ((weblogic.management.configuration.JMSServerMBean)self).getMessagesThresholdHigh()) && (value <= ((1 << 63) - 1)))

Legal Minimum Value: -1

getPagingStore

public JMSStoreMBean getPagingStore()

Get the paging store for the JMS server.

setPagingStore

public void setPagingStore(JMSStoreMBean store)
                    throws javax.management.InvalidAttributeValueException

Set the paging store for the JMS server. A paging store may only be used by one JMS server.

Default Value: null

Legal Value: ((value == void)?(true):(weblogic.management.configuration.JMSLegalHelper.isUnowned(self, value)))

isMessagesPagingEnabled

public boolean isMessagesPagingEnabled()

Check if MessagesPagingEnabled is set. If true, the JMS server will start paging out messages once the MessagesThresholdHigh is reached.

setMessagesPagingEnabled

public void setMessagesPagingEnabled(boolean enabled)
                              throws javax.management.InvalidAttributeValueException

Set MessagesPagingEnabled for the JMSServer. By setting this attribute to true, paging will be enabled so that the JMSServer will start paging messages out when its MessagesThresholdHigh is reached.

Default Value: false

isBytesPagingEnabled

public boolean isBytesPagingEnabled()

Check if BytesPagingEnabled is set. If true, the JMS server will start paging out messages once the BytesThresholdHigh is reached.

setBytesPagingEnabled

public void setBytesPagingEnabled(boolean enabled)
                           throws javax.management.InvalidAttributeValueException

Set BytesPagingEnabled for the JMSServer. By setting this attribute to true, paging will be enabled so that the JMSServer will start paging messages out when its BytesThresholdHigh is reached.

Default Value: false