|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class represents a JMS server. A JMS server manages connections and message requests on behalf of clients.
Fields inherited from class weblogic.management.configuration.DeploymentMBean |
CACHING_STUB_SVUID,
DEFAULT_ORDER,
MAX_ORDER,
MIN_ORDER |
Fields inherited from class weblogic.management.configuration.ConfigurationMBean |
CACHING_STUB_SVUID,
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
boolean |
addDestination(JMSDestinationMBean destination)
Add a JMS destination to the JMS server. |
boolean |
addSessionPool(JMSSessionPoolMBean sessionPool)
Add a session pool to the JMS server. |
java.lang.String |
getBlockingSendPolicy()
The JMS server's policy on whether to deliver smaller messages before larger ones when a destination has exceeded its message quota. |
long |
getBytesMaximum()
The maximum bytes quota (total amount of bytes) that can be stored in this JMS server. |
long |
getBytesThresholdHigh()
The upper threshold value that triggers events based on the number of bytes stored in the JMS server. |
long |
getBytesThresholdLow()
The lower threshold value 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. |
int |
getExpirationScanInterval()
The amount of time, in seconds, that the JMS server will pause between its cycles of scanning its destinations for expired messages to process (acccording to the specified Expiration Policy on the destinations). |
int |
getMaximumMessageSize()
The maximum size of a message that will be accepted from producers on this JMS server. |
long |
getMessagesMaximum()
The maximum message quota (total amount of messages) that can be stored in this JMS server. |
long |
getMessagesThresholdHigh()
The upper threshold value that triggers events based on the number of messages stored in the JMS server. |
long |
getMessagesThresholdLow()
The lower threshold value that triggers events based on the number of messages stored in the JMS server. |
JMSStoreMBean |
getPagingStore()
The name of the dedicated JMS file store where message bodies are temporarily swapped out from memory when the JMS server's message load reaches a specified bytes/messages threshold. |
JMSSessionPoolMBean[] |
getSessionPools()
Get all the session pools defined for the JMS server. |
JMSStoreMBean |
getStore()
The persistent disk-based file or JDBC-accessible database for the JMS server. |
JMSTemplateMBean |
getTemporaryTemplate()
The name of the existing JMS template that is used to create all temporary destinations, including temporary queues and temporary topics. |
boolean |
isBytesPagingEnabled()
Specifies whether bytes paging is enabled on this JMS server for temporarily swapping message bodies out from memory to a persistent paging store when the JMS servers's byte load reaches a specified threshold. |
boolean |
isMessagesPagingEnabled()
Specifies whether messages paging is enabled on this JMS server for temporarily swapping message bodies out from memory to a persistent paging store when the JMS servers's message load reaches a specified threshold. |
boolean |
removeDestination(JMSDestinationMBean destination)
Removes a destination from the JNDI tree. |
boolean |
removeSessionPool(JMSSessionPoolMBean sessionPool)
Remove a session pool from the JMS server. |
void |
setBlockingSendPolicy(java.lang.String blockingSendPolicy)
The JMS server's policy on whether to deliver smaller messages before larger ones when a destination has exceeded its message quota. |
void |
setBytesMaximum(long bytesMaximum)
The maximum bytes quota (total amount of bytes) that can be stored in this JMS server. |
void |
setBytesPagingEnabled(boolean enabled)
Specifies whether bytes paging is enabled on this JMS server for temporarily swapping message bodies out from memory to a persistent paging store when the JMS servers's byte load reaches a specified threshold. |
void |
setBytesThresholdHigh(long bytesThresholdHigh)
The upper threshold value that triggers events based on the number of bytes stored in the JMS server. |
void |
setBytesThresholdLow(long bytesThresholdLow)
The lower threshold value that triggers events based on the number of bytes stored in the JMS server. |
void |
setDestinations(JMSDestinationMBean[] destinations)
Set all defined destinations for the JMS server. |
void |
setExpirationScanInterval(int scanPeriod)
The amount of time, in seconds, that the JMS server will pause between its cycles of scanning its destinations for expired messages to process (acccording to the specified Expiration Policy on the destinations). |
void |
setMaximumMessageSize(int maxMessageSize)
The maximum size of a message that will be accepted from producers on this JMS server. |
void |
setMessagesMaximum(long messagesMaximum)
The maximum message quota (total amount of messages) that can be stored in this JMS server. |
void |
setMessagesPagingEnabled(boolean enabled)
Specifies whether messages paging is enabled on this JMS server for temporarily swapping message bodies out from memory to a persistent paging store when the JMS servers's message load reaches a specified threshold. |
void |
setMessagesThresholdHigh(long messagesThresholdHigh)
The upper threshold value that triggers events based on the number of messages stored in the JMS server. |
void |
setMessagesThresholdLow(long messagesThresholdLow)
The lower threshold value that triggers events based on the number of messages stored in the JMS server. |
void |
setPagingStore(JMSStoreMBean store)
The name of the dedicated JMS file store where message bodies are temporarily swapped out from memory when the JMS server's message load reaches a specified bytes/messages threshold. |
void |
setSessionPools(JMSSessionPoolMBean[] sessionPools)
Set all the session pools defined for the JMS server. |
void |
setStore(JMSStoreMBean store)
The persistent disk-based file or JDBC-accessible database for the JMS server. |
void |
setTemporaryTemplate(JMSTemplateMBean temporaryTemplate)
The name of the existing JMS template that is used to create all temporary destinations on the JMS server, including temporary queues and temporary topics. |
Methods inherited from interface weblogic.management.configuration.DeploymentMBean |
addTarget,
getDeploymentOrder,
getTargets,
removeTarget,
setDeploymentOrder,
setTargets |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue,
getNotes,
restoreDefaultValue,
setComments,
setDefaultedMBean,
setNotes,
setPersistenceEnabled |
Methods inherited from interface weblogic.management.WebLogicMBean |
getMBeanInfo,
getName,
getObjectName,
getParent,
getType,
isCachingDisabled,
isRegistered,
setName,
setParent |
Methods inherited from interface javax.management.DynamicMBean |
getAttribute,
getAttributes,
invoke,
setAttribute,
setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
postDeregister,
postRegister,
preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
addNotificationListener,
getNotificationInfo,
removeNotificationListener |
Method Detail |
public JMSSessionPoolMBean[] getSessionPools()
public void setSessionPools(JMSSessionPoolMBean[] sessionPools) throws javax.management.InvalidAttributeValueException
sessionPools
- The new sessionPools valuepublic boolean addSessionPool(JMSSessionPoolMBean sessionPool) throws javax.management.InvalidAttributeValueException, DistributedManagementException
sessionPool
- the sessionPool to add to the JMS serverpublic boolean removeSessionPool(JMSSessionPoolMBean sessionPool) throws javax.management.InvalidAttributeValueException, DistributedManagementException
sessionPool
- the sessionPool to remove from the JMS serverpublic JMSDestinationMBean[] getDestinations()
public void setDestinations(JMSDestinationMBean[] destinations) throws javax.management.InvalidAttributeValueException
destinations
- The new destinations valuepublic boolean addDestination(JMSDestinationMBean destination) throws javax.management.InvalidAttributeValueException, DistributedManagementException
destination
- the destination to be added to the JMS serverpublic boolean removeDestination(JMSDestinationMBean destination) throws javax.management.InvalidAttributeValueException, DistributedManagementException
destination
- the destination to be removed from the JMS serverpublic JMSStoreMBean getStore()
A persistent store may only be used by one JMS server. A value of none specifies that no persistent messaging is supported. If no persistent store is specified, then destinations on this JMS server will not support persistent messages or durable subscribers.
public void setStore(JMSStoreMBean store) throws javax.management.InvalidAttributeValueException
A persistent store can only be used by one JMS server. A value of none specifies that no persistent messaging is supported. If no persistent store is specified, then destinations on this JMS server will not support persistent messages or durable subscribers.
store
- The new store valuepublic JMSTemplateMBean getTemporaryTemplate()
Note: If this attribute is set to none, attempts to create a temporary destination (queue or topic) will fail.
public void setTemporaryTemplate(JMSTemplateMBean temporaryTemplate) throws javax.management.InvalidAttributeValueException
Note: If this attribute is set to none, attempts to create a temporary destination (queue or topic) will fail.
temporaryTemplate
- the temporary template for the JMS serverpublic long getBytesMaximum()
This attribute is dynamically configurable.
Range of Values: >= BytesThresholdHigh
public void setBytesMaximum(long bytesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
This attribute is dynamically configurable.
Range of Values: >= BytesThresholdHigh
bytesMaximum
- The new bytesMaximum valuepublic long getBytesThresholdHigh()
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: <= BytesMaximum; >BytesThresholdLow
Note: Bytes paging cannot be dynamically disabled by resetting the BytesThresholdHigh to -1. To disable paging, you could set the BytesThresholdHigh to a very large number, so that paging would not be triggered.
public void setBytesThresholdHigh(long bytesThresholdHigh) throws javax.management.InvalidAttributeValueException, DistributedManagementException
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: <= BytesMaximum; >BytesThresholdLow
Note: Bytes paging cannot be dynamically disabled by resetting the BytesThresholdHigh to -1. To disable paging, you could set the BytesThresholdHigh to a very large number, so that paging would not be triggered.
bytesThresholdHigh
- The new bytesThresholdHigh valuepublic long getBytesThresholdLow()
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: < BytesThresholdHigh
public void setBytesThresholdLow(long bytesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that bytes paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: < BytesThresholdHigh
bytesThresholdLow
- The new bytesThresholdLow valuepublic long getMessagesMaximum()
This attribute is dynamically configurable.
Range of Values: >= MessagesThresholdHigh
public void setMessagesMaximum(long messagesMaximum) throws javax.management.InvalidAttributeValueException, DistributedManagementException
This attribute is dynamically configurable.
Range of Values: >= MessagesThresholdHigh
messagesMaximum
- The new messagesMaximum valuepublic long getMessagesThresholdHigh()
Messages Paging - If messages paging is enabled (and a paging store has been configured), then server messages paging is started.
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: <= MessagesMaximum; >MessagesThresholdLow
This attribute is dynamically configurable.
Note: Messages paging cannot be dynamically disabled by resetting the MessagesThresholdHigh to -1. To disable paging, you could set the MessagesThresholdHigh to a very large number, so that paging would not be triggered.
public void setMessagesThresholdHigh(long messagesThresholdHigh) throws javax.management.InvalidAttributeValueException
Messages Paging - If messages paging is enabled (and a paging store has been configured), then server messages paging is started.
A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: <= MessagesMaximum; >MessagesThresholdLow
This attribute is dynamically configurable.
Note: Messages paging cannot be dynamically disabled by resetting the MessagesThresholdHigh to -1. To disable paging, you could set the MessagesThresholdHigh to a very large number, so that paging would not be triggered.
messagesThresholdHigh
- The new messagesThresholdHigh valuepublic long getMessagesThresholdLow()
Messagse Paging - If messages paging is enabled, paging is stopped (if paging is occurring).
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: < MessagesThresholdHigh
public void setMessagesThresholdLow(long messagesThresholdLow) throws javax.management.InvalidAttributeValueException, DistributedManagementException
Messages Paging - If messages paging is enabled, paging is stopped (if paging is occurring).
This attribute is dynamically configurable. A value of -1 specifies that the value is not set and that messages paging, flow control, and threshold log messages are disabled for the JMS server.
Range of Values: < MessagesThresholdHigh
messagesThresholdLow
- The new messagesThresholdLow valuepublic JMSStoreMBean getPagingStore()
A paging store can only be used by one JMS server. A value of none specifies that message paging is not supported. If no paging store is specified, then the JMS server and its destinations will not support message paging.
Note: Using a JMS JDBC store is not recommended for paging since the amount of traffic and subsequent lack of performance would make such a configuration undesirable.
public void setPagingStore(JMSStoreMBean store) throws javax.management.InvalidAttributeValueException
A paging store can only be used by one JMS server. A value of none specifies that message paging is not supported. If no paging store is specified, then the JMS server and its destinations will not support message paging.
Note: Using a JMS JDBC store is not recommended for paging since the amount of traffic and subsequent lack of performance would make such a configuration undesirable.
store
- The new pagingStore valuepublic boolean isMessagesPagingEnabled()
If either the MessagesThresholdLow or MessagesThresholdHigh attribute is undefined, or defined as -1, then server messages paging is implicitly disabled--even though this flag is set to true.
public void setMessagesPagingEnabled(boolean enabled) throws javax.management.InvalidAttributeValueException
If either the MessagesThresholdLow or MessagesThresholdHigh attribute is undefined, or defined as -1, then server messages paging is implicitly disabled--even though this flag is set to true.
enabled
- The new messagesPagingEnabled valuepublic boolean isBytesPagingEnabled()
If either the BytesThresholdLow or BytesThresholdHigh attribute is defined as -1, then server bytes paging is implicitly disabled--even though this flag is set to true.
public void setBytesPagingEnabled(boolean enabled) throws javax.management.InvalidAttributeValueException
If either the BytesThresholdLow or BytesThresholdHigh attribute is defined as -1, then server bytes paging is implicitly disabled--even though this flag is set to true.
enabled
- The new bytesPagingEnabled valuepublic void setExpirationScanInterval(int scanPeriod) throws javax.management.InvalidAttributeValueException
Setting this value to some very large value also effectively disables active scanning for expired messages from the system. Users will not receive expired messages, and any expired messages that are discovered are removed form the system. However, expired messages sitting in idle destinations (i.e., an inactive queue or disconnected durable subscriber) will not be removed and will continue to consume system resources.
The scanning and processing cycle for expired messages occurs as follows:
Note: Since a new scan will not start until the current one is finished and 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 and processing.
scanPeriod
- The new expirationScanInterval valuepublic int getExpirationScanInterval()
Setting this value to some very large value also effectively disables active scanning for expired messages from the system. Users will not receive expired messages, and any expired messages that are discovered are removed form the system. However, expired messages sitting in idle destinations (i.e., an inactive queue or disconnected durable subscriber) will not be removed and will continue to consume system resources.
The scanning and processing cycle for expired messages occurs as follows:
Note: Since a new scan will not start until the current one is finished and until the 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.
public int getMaximumMessageSize()
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
public void setMaximumMessageSize(int maxMessageSize) throws javax.management.InvalidAttributeValueException, DistributedManagementException
The maximum message size is only enforced for the initial production of a message. Messages that are redirected to an error destination or forwarded to a member of a distributed destination are not checked for size. For instance, if a destination and its corresponding error destination are configured with a maximum message size of 128K bytes and 64K bytes, respectively, a message of 96K bytes could be redirected to the error destination (even though it exceeds the 64K byte maximum), but a producer could not directly send the 96K byte message to the error destination.
This attribute is dynamically configurable, but only incoming messages are impacted; stored messages are not impacted.
maxMessageSize
- The new maximumMessageSize valuepublic java.lang.String getBlockingSendPolicy()
This policy is defined only for the JMS server; it cannot be set on individual destinations. The valid expiration policies are:
public void setBlockingSendPolicy(java.lang.String blockingSendPolicy) throws javax.management.InvalidAttributeValueException
This policy is defined only for the JMS server; it cannot be set on individual destinations. The valid expiration policies are:
blockingSendPolicy
- The new blockingSendPolicy value
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs81 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |