|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@SingleTargetOnly
public interface JMSServerMBean
This class represents a JMS server. A JMS server manages connections and message requests on behalf of clients.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.DeploymentMBean |
---|
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER |
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
abstract boolean |
addDestination(JMSDestinationMBean destination) Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules. |
abstract boolean |
addSessionPool(JMSSessionPoolMBean sessionPool) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract boolean |
addTarget(TargetMBean target) Targets the JMSServer to the specified target instance. |
abstract JMSQueueMBean |
createJMSQueue(String name) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSQueueMBean |
createJMSQueue(String name, JMSQueueMBean toClone) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSSessionPoolMBean |
createJMSSessionPool(String name) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract JMSSessionPoolMBean |
createJMSSessionPool(String name, JMSSessionPoolMBean toClone) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSTopicMBean |
createJMSTopic(String name) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSTopicMBean |
createJMSTopic(String name, JMSTopicMBean toClone) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract void |
destroyJMSQueue(JMSQueueMBean queue) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract void |
destroyJMSSessionPool(JMSSessionPoolMBean sessionPool) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract void |
destroyJMSTopic(JMSTopicMBean topic) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract String |
getBlockingSendPolicy() Determines whether the JMS server delivers smaller messages before larger ones when a destination has exceeded its maximum number of messages. |
abstract long |
getBytesMaximum() The maximum number of bytes that can be stored in this JMS server. |
abstract long |
getBytesThresholdHigh() The upper threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. |
abstract long |
getBytesThresholdLow() The lower threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. |
abstract String |
getConsumptionPausedAtStartup() Indicates whether consumption is paused at startup on destinations targeted to this JMS server at startup. |
abstract JMSDestinationMBean[] |
getDestinations() Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules. |
abstract int |
getExpirationScanInterval() The number of seconds between this JMS server's cycles of scanning local destinations for expired messages. |
abstract String |
getInsertionPausedAtStartup() Indicates whether insertion is paused at startup on destinations targeted to this JMS server. |
abstract JMSMessageLogFileMBean |
getJMSMessageLogFile() The message log file configuration for this JMS Server. |
abstract JMSQueueMBean[] |
getJMSQueues() Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSSessionPoolMBean[] |
getJMSSessionPools() Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract JMSTopicMBean[] |
getJMSTopics() Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract int |
getMaximumMessageSize() The maximum number of bytes allowed in individual messages on this JMS server. |
abstract long |
getMessageBufferSize() The amount of memory (in bytes) that this JMS server can use to store message bodies before it writes them to disk. |
abstract String |
getMessageCompressionOptions() Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores. |
abstract long |
getMessagesMaximum() The maximum number of messages that can be stored in this JMS server. |
abstract long |
getMessagesThresholdHigh() The upper threshold (number of messages stored in this JMS server) that triggers flow control and logging events. |
abstract long |
getMessagesThresholdLow() The lower threshold (number of messages stored in this JMS server) that triggers flow control and logging events. |
abstract String |
getName() The user-specified name of this MBean instance. |
abstract int |
getPagingBlockSize() The smallest addressable block, in bytes, of a file. |
abstract String |
getPagingDirectory() Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size. |
abstract int |
getPagingIoBufferSize() The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2. |
abstract long |
getPagingMaxFileSize() The paging maximum file size, in bytes. |
abstract 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. |
abstract 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. |
abstract JMSStoreMBean |
getPagingStore() Deprecated. 9.0.0.0 Replaced with the PagingDirectory attribute. |
abstract PersistentStoreMBean |
getPersistentStore() The file or database in which this JMS server stores persistent messages. |
abstract String |
getProductionPausedAtStartup() Specifies whether production is paused at server startup on destinations targeted to this JMS server. |
abstract JMSSessionPoolMBean[] |
getSessionPools() Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract JMSStoreMBean |
getStore() Deprecated. 9.0.0.0 Replaced with the PersistentStore attribute. |
abstract boolean |
getStoreEnabled() Specifies whether message persistence is supported for this JMS server. |
abstract TargetMBean[] |
getTargets() The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer. |
abstract JMSTemplateMBean |
getTemporaryTemplate() Deprecated. 9.0.0.0 Replaced with the TemporaryTemplateName and TemporaryTemplateResource attributes. |
abstract String |
getTemporaryTemplateName() The name of a configured JMS template that this JMS server uses to create temporary destinations. |
abstract String |
getTemporaryTemplateResource() The name of a JMS module that contains a template that this JMS server can use to create temporary destinations. |
abstract 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. |
abstract boolean |
isBytesPagingEnabled() Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled. |
abstract boolean |
isHostingTemporaryDestinations() Specifies whether this JMS server can be used to host temporary destinations. |
abstract boolean |
isMessagesPagingEnabled() Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled. |
abstract boolean |
isPagingFileLockingEnabled() Determines whether OS file locking is used. |
abstract boolean |
isPagingMessageCompressionEnabled() Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. |
abstract boolean |
isStoreMessageCompressionEnabled() Enables the JMS store to perform message body compression. |
abstract JMSQueueMBean |
lookupJMSQueue(String name) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract JMSSessionPoolMBean |
lookupJMSSessionPool(String name) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract JMSTopicMBean |
lookupJMSTopic(String name) Deprecated. 9.0.0.0 Replaced with the JMS module functionality. |
abstract boolean |
removeDestination(JMSDestinationMBean destination) Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules. |
abstract boolean |
removeSessionPool(JMSSessionPoolMBean sessionPool) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract boolean |
removeTarget(TargetMBean target) Untargets the JMSServer instance from the current target. |
abstract void |
setAllowsPersistentDowngrade(boolean allows) Sets the value of the isAllowsPersistentDowngrade attribute. |
abstract void |
setBlockingSendPolicy(String blockingSendPolicy) Sets the value of the BlockingSendPolicy attribute. |
abstract void |
setBytesMaximum(long bytesMaximum) Sets the value of the BytesMaximum attribute. |
abstract void |
setBytesPagingEnabled(boolean enabled) Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled. |
abstract void |
setBytesThresholdHigh(long bytesThresholdHigh) Sets the value of the BytesThresholdHigh attribute. |
abstract void |
setBytesThresholdLow(long bytesThresholdLow) Sets the value of the BytesThresholdLow attribute. |
abstract void |
setConsumptionPausedAtStartup(String enabled) Sets the value of the ConsumptionPausedAtStartup attribute. |
abstract void |
setDestinations(JMSDestinationMBean[] destinations) Deprecated. 9.0.0.0 Replaced with the functionality of JMS modules. |
abstract void |
setExpirationScanInterval(int scanPeriod) Sets the value of the ExpirationScanInterval attribute. |
abstract void |
setHostingTemporaryDestinations(boolean hosting) Sets the value of the HostingTemporaryDestinations attribute. |
abstract void |
setInsertionPausedAtStartup(String enabled) Sets the value of the InsertionPausedAtStartup attribute. |
abstract void |
setMaximumMessageSize(int maxMessageSize) Sets the value of the MaximumMessageSize attribute. |
abstract void |
setMessageBufferSize(long bufferSize) Sets the value of the MessageBufferSize attribute. |
abstract void |
setMessageCompressionOptions(String option) Sets the type of message compression used. |
abstract void |
setMessagesMaximum(long messagesMaximum) Sets the value of the MessagesMaximum attribute. |
abstract void |
setMessagesPagingEnabled(boolean enabled) Deprecated. 9.0.0.0 Replaced by defaulting the paging to always be enabled. |
abstract void |
setMessagesThresholdHigh(long messagesThresholdHigh) Sets the value of the MessagesThresholdHigh attribute. |
abstract void |
setMessagesThresholdLow(long messagesThresholdLow) Sets the value of the MessagesThresholdLow attribute. |
abstract void |
setPagingBlockSize(int pagingBlockSize) See GenericFileStoreMBean.setBlockSize. |
abstract void |
setPagingDirectory(String directory) Sets the value of the PagingDirectory attribute. |
abstract void |
setPagingFileLockingEnabled(boolean pagingFileLockingEnabled) See GenericFileStoreMBean.setFileLockingEnabled. |
abstract void |
setPagingIoBufferSize(int pagingIoBufferSize) See GenericFileStoreMBean.IoBufferSize. |
abstract void |
setPagingMaxFileSize(long pagingMaxFileSize) See GenericFileStoreMBean.setMaxFileSize. |
abstract void |
setPagingMaxWindowBufferSize(int pagingMaxWindowBufferSize) See GenericFileStoreMBean.setMaxWindowBufferSize. |
abstract void |
setPagingMessageCompressionEnabled(boolean allows) Sets the value of the isPagingMessageCompressionEnabled attribute. |
abstract void |
setPagingMinWindowBufferSize(int pagingMinWindowBufferSize) See GenericFileStoreMBean.setMinWindowBufferSize. |
abstract void |
setPagingStore(JMSStoreMBean store) Deprecated. 9.0.0.0 Replaced with the PagingDirectory attribute. |
abstract void |
setPersistentStore(PersistentStoreMBean store) Sets the value of the PersistentStore attribute. |
abstract void |
setProductionPausedAtStartup(String enabled) Sets the value of the ProductionPausedAtStartup attribute. |
abstract void |
setSessionPools(JMSSessionPoolMBean[] pools) Deprecated. 9.0.0.0 Replaced by message-driven beans. The JMSSessionPoolMBean type was deprecated. See JMSSessionPoolMBean for more information. |
abstract void |
setStore(JMSStoreMBean store) Deprecated. 9.0.0.0 Replaced with the PersistentStore attribute. |
abstract void |
setStoreEnabled(boolean enabled) |
abstract void |
setStoreMessageCompressionEnabled(boolean allows) Sets the value of the isStoreMessageCompressionEnabled attribute. |
abstract void |
setTargets(TargetMBean[] Targets) Sets the value of the getTargets attribute. |
abstract void |
setTemporaryTemplate(JMSTemplateMBean temporaryTemplate) Deprecated. 9.0.0.0 Replaced with the TemporaryTemplateName and TemporaryTemplateResource attributes. |
abstract void |
setTemporaryTemplateName(String templateName) Sets the value of the TemporaryTemplateName attribute. |
abstract void |
setTemporaryTemplateResource(String resource) Sets the value of the TemporaryTemplateResource attribute. |
Methods inherited from interface weblogic.management.configuration.DeploymentMBean |
---|
getDeploymentOrder, setDeploymentOrder |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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 |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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 |
Methods inherited from interface weblogic.descriptor.DescriptorBean |
---|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener |
Method Detail |
---|
String getName()
The user-specified name of this MBean instance.
This name is included as one of the key properties in the MBean's javax.management.ObjectName
:
Name=user-specified-name
getName
in interface ConfigurationMBean
getName
in interface WebLogicMBean
TargetMBean[] getTargets()
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 DeploymentMBean
void setTargets(TargetMBean[] Targets) throws InvalidAttributeValueException, DistributedManagementException
Sets the value of the getTargets attribute.
setTargets
in interface DeploymentMBean
Targets
- The new targets valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getTargets()
boolean addTarget(TargetMBean target) throws 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 DeploymentMBean
target
- The target where the JMSServer needs to be deployedInvalidAttributeValueException
DistributedManagementException
boolean removeTarget(TargetMBean target) throws InvalidAttributeValueException, DistributedManagementException
Untargets the JMSServer instance from the current target.
removeTarget
in interface DeploymentMBean
target
- The target that has to be removed from the JMSServerInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.addTarget(weblogic.management.configuration.TargetMBean)
JMSSessionPoolMBean[] getSessionPools()
The session pools defined for the JMS server. This method is provided for backward compatibility.
void setSessionPools(JMSSessionPoolMBean[] pools) throws InvalidAttributeValueException
The session pools defined for the JMS server. This method is provided for backward compatibility.
InvalidAttributeValueException
boolean addSessionPool(JMSSessionPoolMBean sessionPool) throws 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 serverInvalidAttributeValueException
DistributedManagementException
boolean removeSessionPool(JMSSessionPoolMBean sessionPool) throws 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 serverInvalidAttributeValueException
DistributedManagementException
JMSSessionPoolMBean[] getJMSSessionPools()
The session pools defined for the JMS server.
JMSSessionPoolMBean createJMSSessionPool(String name) throws InvalidAttributeValueException, DistributedManagementException
Add a session pool to the JMS server.
name
- the name of the sessionPool to add to the JMS serverInvalidAttributeValueException
DistributedManagementException
JMSSessionPoolMBean createJMSSessionPool(String name, JMSSessionPoolMBean toClone) throws InvalidAttributeValueException, DistributedManagementException
Factory method to create JMSTopic object
name
-toClone
- the JMSSessionPool that is being cloned.InvalidAttributeValueException
DistributedManagementException
void destroyJMSSessionPool(JMSSessionPoolMBean sessionPool)
Remove a session pool from the JMS server.
sessionPool
- the sessionPool to remove from the JMS serverJMSSessionPoolMBean lookupJMSSessionPool(String name)
Get a session pool by name from the JMS server.
JMSDestinationMBean[] getDestinations()
All defined destinations and their associated JNDI names.
void setDestinations(JMSDestinationMBean[] destinations) throws InvalidAttributeValueException
Sets the value of the Destinations attribute.
destinations
- The new destinations valueInvalidAttributeValueException
JMSServerMBean.getDestinations()
boolean addDestination(JMSDestinationMBean destination) throws InvalidAttributeValueException, DistributedManagementException
Add a JMS destination to the JMS server.
destination
- the destination to be added to the JMS serverInvalidAttributeValueException
DistributedManagementException
IllegalArgumentException
- if destination is null or existsboolean removeDestination(JMSDestinationMBean destination) throws InvalidAttributeValueException, DistributedManagementException
Removes a destination from the JNDI tree.
destination
- the destination to be removed from the JMS serverInvalidAttributeValueException
DistributedManagementException
IllegalArgumentException
- if destination is null or does not existJMSStoreMBean getStore()
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.
JMSServerMBean.getPersistentStore()
void setStore(JMSStoreMBean store) throws InvalidAttributeValueException
Sets the value of the Store attribute.
store
- The new store valueInvalidAttributeValueException
JMSServerMBean.getStore()
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.
PersistentStoreMBean
void setPersistentStore(PersistentStoreMBean store) throws InvalidAttributeValueException
Sets the value of the PersistentStore attribute.
store
- The new store valueInvalidAttributeValueException
JMSServerMBean.getPersistentStore()
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.
void setStoreEnabled(boolean enabled)
JMSServerMBean.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 allowableJMSServerMBean.isAllowsPersistentDowngrade()
JMSTemplateMBean getTemporaryTemplate()
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.
void setTemporaryTemplate(JMSTemplateMBean temporaryTemplate) throws InvalidAttributeValueException
Sets the value of the TemporaryTemplate attribute.
temporaryTemplate
- the temporary template for the JMS serverInvalidAttributeValueException
JMSServerMBean.getTemporaryTemplate()
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 destinationsJMSServerMBean.isHostingTemporaryDestinations()
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
, TemplateBean
void setTemporaryTemplateResource(String resource) throws InvalidAttributeValueException
Sets the value of the TemporaryTemplateResource attribute.
resource
- The name of the JMSSystemResource in which the temporary template definition can be foundInvalidAttributeValueException
JMSServerMBean.getTemporaryTemplateResource()
, JMSSystemResourceMBean
, TemplateBean
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
, TemplateBean
void setTemporaryTemplateName(String templateName) throws InvalidAttributeValueException
Sets the value of the TemporaryTemplateName attribute.
templateName
- The name of the TemplateBean to use when creating temporary destinations on this JMSServerInvalidAttributeValueException
JMSServerMBean.getTemporaryTemplateName()
, JMSSystemResourceMBean
, TemplateBean
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
void setBytesMaximum(long bytesMaximum) throws InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesMaximum attribute.
bytesMaximum
- The new bytesMaximum valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getBytesMaximum()
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 InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesThresholdHigh attribute.
bytesThresholdHigh
- The new bytesThresholdHigh valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getBytesThresholdHigh()
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 InvalidAttributeValueException, DistributedManagementException
Sets the value of the BytesThresholdLow attribute.
bytesThresholdLow
- The new bytesThresholdLow valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getBytesThresholdLow()
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 InvalidAttributeValueException, DistributedManagementException
Sets the value of the MessagesMaximum attribute.
messagesMaximum
- The new messagesMaximum valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getMessagesMaximum()
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 InvalidAttributeValueException
Sets the value of the MessagesThresholdHigh attribute.
messagesThresholdHigh
- The new messagesThresholdHigh valueInvalidAttributeValueException
JMSServerMBean.getMessagesThresholdHigh()
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 InvalidAttributeValueException, DistributedManagementException
Sets the value of the MessagesThresholdLow attribute.
messagesThresholdLow
- The new messagesThresholdLow valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getMessagesThresholdLow()
JMSStoreMBean getPagingStore()
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.
JMSServerMBean.getPagingDirectory()
void setPagingStore(JMSStoreMBean store) throws InvalidAttributeValueException
Sets the value of the PagingStore attribute.
store
- The new pagingStore valueInvalidAttributeValueException
JMSServerMBean.setPagingDirectory(java.lang.String)
boolean isMessagesPagingEnabled()
This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.
JMSServerMBean.getMessageBufferSize()
void setMessagesPagingEnabled(boolean enabled) throws InvalidAttributeValueException
Sets the value of the MessagesPagingEnabled attribute.
enabled
- The new messagesPagingEnabled valueInvalidAttributeValueException
JMSServerMBean.setMessageBufferSize(long)
boolean isBytesPagingEnabled()
This parameter has been deprecated. Paging is always enabled. The "MessageBufferSize" parameter controls how much memory is used before paging kicks in.
JMSServerMBean.getMessageBufferSize()
void setBytesPagingEnabled(boolean enabled) throws InvalidAttributeValueException
Sets the value of the BytesPagingEnabled attribute.
enabled
- The new bytesPagingEnabled valueInvalidAttributeValueException
JMSServerMBean.setMessageBufferSize(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.
JMSServerMBean.getPagingDirectory()
void setMessageBufferSize(long bufferSize) throws InvalidAttributeValueException
Sets the value of the MessageBufferSize attribute.
InvalidAttributeValueException
JMSServerMBean.getMessageBufferSize()
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.
JMSServerMBean.getMessageBufferSize()
void setPagingDirectory(String directory) throws InvalidAttributeValueException
Sets the value of the PagingDirectory attribute.
InvalidAttributeValueException
JMSServerMBean.getPagingDirectory()
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.
void setPagingFileLockingEnabled(boolean pagingFileLockingEnabled)
pagingFileLockingEnabled
- The new PagingFileLockingEnabled valueInvalidAttributeValueException
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.
void setPagingMinWindowBufferSize(int pagingMinWindowBufferSize)
InvalidAttributeValueException
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.
void setPagingMaxWindowBufferSize(int pagingMaxWindowBufferSize)
pagingMaxWindowBufferSize
- The new PagingMaxWindowBufferSize valueInvalidAttributeValueException
int 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.void setPagingIoBufferSize(int pagingIoBufferSize)
pagingIoBufferSize
- The new PagingIOBufferSize valueInvalidAttributeValueException
long 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.
void setPagingMaxFileSize(long pagingMaxFileSize)
pagingMaxFileSize
- The new PagingMaxFileSize valueInvalidAttributeValueException
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.
void setPagingBlockSize(int pagingBlockSize)
pagingBlockSize
- The new PagingBlockSize valueInvalidAttributeValueException
void setExpirationScanInterval(int scanPeriod) throws InvalidAttributeValueException
Sets the value of the ExpirationScanInterval attribute.
scanPeriod
- The new expirationScanInterval valueInvalidAttributeValueException
JMSServerMBean.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:
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 InvalidAttributeValueException, DistributedManagementException
Sets the value of the MaximumMessageSize attribute.
maxMessageSize
- The new maximumMessageSize valueInvalidAttributeValueException
DistributedManagementException
JMSServerMBean.getMaximumMessageSize()
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(String blockingSendPolicy) throws InvalidAttributeValueException
Sets the value of the BlockingSendPolicy attribute.
blockingSendPolicy
- The new blockingSendPolicy valueInvalidAttributeValueException
JMSServerMBean.getBlockingSendPolicy()
void setProductionPausedAtStartup(String enabled) throws InvalidAttributeValueException
Sets the value of the ProductionPausedAtStartup attribute.
enabled
- The new ProductionPausedAtStartup valueInvalidAttributeValueException
JMSServerMBean.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.
JMSServerRuntimeMBean.resumeProduction()
, JMSDestinationRuntimeMBean.resumeProduction()
void setInsertionPausedAtStartup(String enabled) throws InvalidAttributeValueException
Sets the value of the InsertionPausedAtStartup attribute.
enabled
- The new InsertionPausedAtStartup valueInvalidAttributeValueException
JMSServerMBean.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.
JMSServerRuntimeMBean.resumeInsertion()
, JMSDestinationRuntimeMBean.resumeInsertion()
void setConsumptionPausedAtStartup(String enabled) throws InvalidAttributeValueException
Sets the value of the ConsumptionPausedAtStartup attribute.
enabled
- The new ConsumptionPausedAtStartup valueInvalidAttributeValueException
JMSServerMBean.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.
JMSServerRuntimeMBean.resumeConsumption()
, JMSDestinationRuntimeMBean.resumeConsumption()
JMSQueueMBean[] getJMSQueues()
Acquire JMSQueues for this JMSServer
JMSQueueMBean createJMSQueue(String name)
Factory method to create JMSQueue object
name
-JMSQueueMBean createJMSQueue(String name, JMSQueueMBean toClone)
Factory method to create JMSQueue object
name
-toClone
- is the JMSQueueMBean that is being moved from the DomainMBeanvoid destroyJMSQueue(JMSQueueMBean queue)
Removes a JMSQueue from this domain
queue
-JMSQueueMBean lookupJMSQueue(String name)
name
-JMSTopicMBean[] getJMSTopics()
Define JMSTopics for this Domain
JMSTopicMBean createJMSTopic(String name)
Factory method to create JMSTopic object
name
-JMSTopicMBean createJMSTopic(String name, JMSTopicMBean toClone)
Factory method to create JMSTopic object
name
-void destroyJMSTopic(JMSTopicMBean topic)
Removes a JMSTopic from this domain
topic
-JMSTopicMBean lookupJMSTopic(String name)
name
-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.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
JMSServerMBean.getMessageCompressionOptions()
void setStoreMessageCompressionEnabled(boolean allows)
Sets the value of the isStoreMessageCompressionEnabled attribute.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
allows
- true if JMS store should perform message body compressionJMSServerMBean.isStoreMessageCompressionEnabled()
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.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
JMSServerMBean.getMessageCompressionOptions()
void setPagingMessageCompressionEnabled(boolean allows)
Sets the value of the isPagingMessageCompressionEnabled attribute.
This attribute should be enabled only when configuring a WebLogic domain in an Oracle Exalogic environment.
allows
- true if JMS paging store should perform compressionJMSServerMBean.isPagingMessageCompressionEnabled()
void setMessageCompressionOptions(String option)
Sets the type of message compression used.
This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.
option
- the supported compression machanismString 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.This attribute should be used only when configuring a WebLogic domain in an Oracle Exalogic environment.
JMSServerMBean.isStoreMessageCompressionEnabled()
, JMSServerMBean.isPagingMessageCompressionEnabled()
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |