RESTful Edit Management Interface for Oracle WebLogic Server MT (Deprecated)

View This JMS Server Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSServers

View this JMS server collection.

Request

Path Parameters

name: string

The name property of the instance in the collection.
version: string

The version of the WebLogic REST interface.

Query Parameters

excludeFields(optional): string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks(optional): string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields(optional): string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links(optional): string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns a list of JMS server entities.

This method can return the following links:

rel=create-form uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/JMSServerCreateForm
The create form resource for this collection resource.

Root Schema : Items

Type: array

Title: Items

Show Source

Array of: object JMS Server

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JMS Server"
    },
    "description":""
}

Nested Schema : JMS Server

Type: object

Show Source

allowsPersistentDowngrade(optional): boolean
Default Value: false
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.
Constraints
- not visible for domain scoped mbeans
blockingSendPolicy(optional): string
Default Value: FIFO

Allowed Values: [ "FIFO", "Preemptive" ]
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.
Constraints
- not visible for domain scoped mbeans
bytesMaximum(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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
Constraints
- not visible for domain scoped mbeans
bytesThresholdHigh(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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
Constraints
- not visible for domain scoped mbeans
bytesThresholdLow(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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< p>
Constraints
- not visible for domain scoped mbeans
consumptionPausedAtStartup(optional): string
Default Value: default
Indicates whether consumption is paused at startup on destinations targeted to this JMS server at startup. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "consumption paused" state, which prevents any message consuming activity on those destinations.
To allow normal message consumption on the destinations, later you will have to change the state of this JMS server to a "consumption enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Consumption Paused At Startup is determined based on the corresponding setting on the individual destination.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
- not visible for domain scoped mbeans
deploymentOrder(optional): integer(int32)
Minimum Value: 0

Maximum Value: 2147483647

Default Value: 1000
A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.
For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.
Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.
Constraints
- not visible for domain scoped mbeans
dynamicallyCreated(optional): boolean
Read Only: true

Default Value: false
Return whether the MBean was created dynamically or is persisted to config.xml
Constraints
- not visible for domain scoped mbeans
expirationScanInterval(optional): integer(int32)
Minimum Value: 0

Maximum Value: 2147483647

Default Value: 30
The number of seconds between this JMS server's cycles of scanning local destinations for expired messages. A value of 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.
Constraints
- not visible for domain scoped mbeans
hostingTemporaryDestinations(optional): boolean
Default Value: true
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.
Constraints
- not visible for domain scoped mbeans
id(optional): integer(int64)
Read Only: true
Return the unique id of this MBean instance
Constraints
- not visible for domain scoped mbeans
insertionPausedAtStartup(optional): string
Default Value: default
Indicates whether insertion is paused at startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is booted, then this JMS server and its targeted destinations are modified such that they are in a "insertion paused" state, which results preventing messages that are result of the "in-flight" work completion to arrive on those destinations.
Note: For a detailed definition of "in-flight" work/messages, see weblogic.management.runtime.JMSServerRuntimeMBean#resumeInsertion and weblogic.management.runtime.JMSDestinationRuntime#resumeInsertion
To allow in-flight work messages to appear on the destinations, later you will have to change the state of this JMS server to an "insertion enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance.
When the value is set to default, then the Insertion Paused At Startup is determined based on the corresponding setting on the individual destination.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
- not visible for domain scoped mbeans
maximumMessageSize(optional): integer(int32)
Minimum Value: 0

Maximum Value: 2147483647

Default Value: 2147483647
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.
Constraints
- not visible for domain scoped mbeans
messageBufferSize(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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.
Constraints
- not visible for domain scoped mbeans
messageCompressionOptions(optional): string
Default Value: GZIP_DEFAULT_COMPRESSION

Allowed Values: [ "GZIP_DEFAULT_COMPRESSION", "GZIP_BEST_COMPRESSION", "GZIP_BEST_SPEED", "LZF" ]
Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.
- Use GZIP_DEFAULT_COMPRESSION to enable message compression using the JDK GZIP API with DEFAULT_COMPRESSION level.
- Use GZIP_BEST_COMPRESSION to enable message compression using the JDK GZIP API with BEST_COMPRESSION level.
- Use GZIP_BEST_SPEED to enable message compression using the JDK GZIP API with BEST_SPEED level.
- Use LZF to enable message compression using Open Source LZF.
Constraints
- not visible for domain scoped mbeans
messagesMaximum(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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.
Constraints
- not visible for domain scoped mbeans
messagesThresholdHigh(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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.
Constraints
- not visible for domain scoped mbeans
messagesThresholdLow(optional): integer(int64)
Minimum Value: -1

Maximum Value: 9.223372036854776E18

Default Value: -1
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< p>
Constraints
- not visible for domain scoped mbeans
name(optional): string
Read Only: true
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
Constraints
- legal null
notes(optional): string

Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.
Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.


            
            
            pagingBlockSize(optional): 
            integer(int32)
            
                
                




Minimum Value: -1





Maximum Value: 8192











Default Value: -1







The smallest addressable block, in bytes, of a file. When a native wlfileio driver is available and the paging block size has not been configured by the user, the store selects the minimum OS specific value for unbuffered (direct) I/O, if it is within the range [512, 8192].
A paging store's block size does not change once the paging store creates its files. Changes to block size only take effect for new paging stores or after the current files have been deleted. See "Tuning the Persistent Store" in Performance and Tuning for Oracle WebLogic Server
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingDirectory(optional): 
            string
            
                
                


















Default Value: oracle.doceng.json.BetterJsonNull@1b3d5354







 Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.
 If unspecified, messages are written to the default tmp directory inside the server-name subdirectory of a domain's root directory. For example, domain-name/servers/server-name/tmp, where domain-name is the root directory of your domain. 
 For best performance, this directory should not be the same as the directory used by the JMS server's persistent store. 
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
legal null
not visible for domain scoped mbeans




                
            
            
            
            
            pagingFileLockingEnabled(optional): 
            boolean
            
                
                


















Default Value: true







Determines whether OS file locking is used. 
When file locking protection is enabled, a store boot fails if another store instance already has opened the store files. Do not disable this setting unless you have procedures in place to prevent multiple store instances from opening the same file. File locking is not required but helps prevent corruption in the event that two same-named file store instances attempt to operate in the same directories. This setting applies to both primary and cache files.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingIoBufferSize(optional): 
            integer(int32)
            
                
                




Minimum Value: -1





Maximum Value: 67108864











Default Value: -1







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.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingMaxFileSize(optional): 
            integer(int64)
            
                
                




Minimum Value: 10485760















Default Value: 1342177280







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.  
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingMaxWindowBufferSize(optional): 
            integer(int32)
            
                
                




Minimum Value: -1





Maximum Value: 1073741824











Default Value: -1







The maximum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file. Applies only when a native wlfileio library is loaded.
A window buffer does not consume Java heap memory, but does consume off-heap (native) memory. If the paging store is unable to allocate the requested buffer size, it allocates smaller and smaller buffers until it reaches PagingMinWindowBufferSize, and then fails if it cannot honor PagingMinWindowBufferSize
Oracle recommends setting the max window buffer size to more than double the size of the largest write (multiple concurrently updated records may be combined into a single write), and greater than or equal to the file size, unless there are other constraints. 32-bit JVMs may impose a total limit of between 2 and 4GB for combined Java heap plus off-heap (native) memory usage.
See the JMS server runtime MBean attribute PagingAllocatedWindowBufferBytes to find out the actual allocated Window Buffer Size.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingMessageCompressionEnabled(optional): 
            boolean
            
                
                


















Default Value: false







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.
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            pagingMinWindowBufferSize(optional): 
            integer(int32)
            
                
                




Minimum Value: -1





Maximum Value: 1073741824











Default Value: -1







The minimum amount of data, in bytes and rounded down to the nearest power of 2, mapped into the JVM's address space per paging store file.  Applies only when a native wlfileio library is loaded. See Paging Maximum Window Buffer Size
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            persistentStore(optional): 
            array  Persistent Store Reference
            
            
                
                
Title: Persistent Store Reference





















Contains the persistent store reference. The file or database in which this JMS server stores persistent messages. If unspecified, the JMS server uses the default persistent store that is configured on each targeted WebLogic Server instance. If the JMS server has a store configured, then the configured store is used to store persistent messages.
The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server, cluster, or migratable target instance as this JMS server. Multiple services on the same WebLogic Server instance, including multiple JMS servers, may share the same persistent store. Each service's persistent data will be kept apart.
If you specify a PersistentStore, the deprecated Store field must not be set. If neither the PersistentStore field nor the Store field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
restart required
not visible for domain scoped mbeans


                
            
            
            
            
            productionPausedAtStartup(optional): 
            string
            
                
                


















Default Value: default







Specifies whether production is paused at server startup on destinations targeted to this JMS server. A destination cannot receive any new messages while it is paused.
When the value is set to true, then immediately after the host server instance is rebooted, then this JMS server and its targeted destinations are modified such that they are in a "production paused" state, which results in preventing new message production activities on those destinations.
To resume normal new message production activity, later you will have to change the state of this JMS server to a "production enabled" state by setting this value to false, and then either redeploy the JMS server or reboot the hosting server instance. 
When the value is set to default, then the Production Paused At Startup is determined based on the corresponding setting on the individual destination.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            storeEnabled(optional): 
            boolean
            
                
                


















Default Value: true







 Specifies whether message persistence is supported for this JMS server.
When set to 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. 
 When set to false, then this JMS server does not support persistent messages, and instead downgrades them to non-persistent.
 The default value is true
Oracle recommends not setting this parameter to false. It is available to provide compatibility with older releases.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            storeMessageCompressionEnabled(optional): 
            boolean
            
                
                


















Default Value: false







Enables the JMS store to perform message body compression. When set to false, the default value, no compression is performed.
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            tags(optional): 
            array  Items
            
            
                
                
Title: Items





















Return all tags on this Configuration MBean
Constraints
not visible for domain scoped mbeans


                
            
            
            
            
            targets(optional): 
            array  Target References
            
            
                
                
Title: Target References





















Contains the array of target references. 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.
Constraints
not visible for domain scoped mbeans


                
            
            
            
            
            temporaryTemplateName(optional): 
            string
            
                
                
























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.
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            temporaryTemplateResource(optional): 
            string
            
                
                
























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.
Constraints
not visible for domain scoped mbeans




                
            
            
            
            
            type(optional): 
            string
            
                
                


Read Only: true























Returns the type of the MBean.
Constraints
unharvestable


        {
    "type":"object",
    "properties":{
        "allowsPersistentDowngrade":{
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>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).</p><p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "blockingSendPolicy":{
            "default":"FIFO",
            "enum":[
                "FIFO",
                "Preemptive"
            ],
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>Determines whether the JMS server delivers smaller messages before larger ones when a destination has exceeded its maximum number of messages. <code>FIFO</code> prevents the JMS server from delivering smaller messages when larger ones are already waiting for space. <code>Preemptive</code> allows smaller send requests to preempt previous larger ones when there is sufficient space for smaller messages on the destination.</p><p>This policy is defined only for the JMS server; it cannot be set on individual destinations.</p><p>Additional information on the <code>FIFO</code> and <code>Preemptive</code> policies is provided below.</p><p><code>FIFO</code> (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.</p><p><code>Preemptive</code> 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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "bytesMaximum":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The maximum number of bytes that can be stored in this JMS server. A value of <code>-1</code> removes any WebLogic Server limits.</p><p>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.</p><p><b>Range of Values:</b> >= BytesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "bytesThresholdHigh":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The upper threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of <code>-1</code> disables the events for this JMS server.</p><p>The triggered events are:</p><ul><li><p><code>Log Messages</code> - A message is logged on the server indicating a high threshold condition. </p></li><li><p><code>Flow Control</code> - If flow control is enabled, the JMS server becomes armed and instructs producers to begin decreasing their message flow. </p></li></ul><p><b>Range of Values:</b> <= BytesMaximum; >= BytesThresholdLow</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "bytesThresholdLow":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The lower threshold (number of bytes stored in this JMS server) that triggers flow control and logging events. A value of <code>-1</code> disables the events for this JMS server.</p><p>If the number of bytes falls below this threshold, the triggered events are:</p><ul><li><p><code>Log Messages</code> - A message is logged on the server indicating that the threshold condition has cleared. </p></li><li><p><code>Flow Control</code> - If flow control is enabled, the JMS server becomes disarmed and instructs producers to begin increasing their message flow. </p></li></ul><p><b>Range of Values:</b> <= BytesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "consumptionPausedAtStartup":{
            "default":"default",
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>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.</p><p>When the value is set to <code>true</code>, 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.</p><p>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 <code>false</code>, and then either redeploy the JMS server or reboot the hosting server instance.</p><p>When the value is set to <code>default</code>, then the Consumption Paused At Startup is determined based on the corresponding setting on the individual destination.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "expirationScanInterval":{
            "default":30,
            "minimum":0,
            "maximum":2147483647,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The number of seconds between this JMS server's cycles of scanning local destinations for expired messages. A value of <code></code> disables active scanning. A very large scan interval effectively disables active scanning.</p><p>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.</p><p>The scanning cycle for expired messages occurs as follows:</p><ul><li><p> After the specified waiting period, the JMS server devotes a separate thread to scan all of its local destinations for expired messages. </p></li><li><p> After the scanning is completed, all located expired messages are processed according to the specified Expiration Policy on the destination (Discard, Log, or Redirect). </p></li><li><p> The entire process repeats after another specified waiting period. </p></li></ul><p><b>Note:</b> 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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "hostingTemporaryDestinations":{
            "default":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Specifies whether this JMS server can be used to host temporary destinations.</p><p>If this field is enabled and no <b>Temporary Template Name</b> 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 <b>Temporary Template Name</b> field. If this field is disabled, then this JMS server will not host temporary destinations.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "insertionPausedAtStartup":{
            "default":"default",
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>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.</p><p>When the value is set to <code>true</code>, 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.</p><p><b>Note:</b> For a detailed definition of \"in-flight\" work/messages, see weblogic.management.runtime.JMSServerRuntimeMBean#resumeInsertion and weblogic.management.runtime.JMSDestinationRuntime#resumeInsertion</p><p>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 <code>false</code>, and then either redeploy the JMS server or reboot the hosting server instance.</p><p>When the value is set to <code>default</code>, then the Insertion Paused At Startup is determined based on the corresponding setting on the individual destination.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "maximumMessageSize":{
            "default":2147483647,
            "minimum":0,
            "maximum":2147483647,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>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 <code>JMSCorrelationID</code> and <code>JMSType</code></p><p>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.</p><p><b>Note:</b> Any change to this maximum affects only incoming messages; stored messages are not affected.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "messageBufferSize":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>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.</p><p>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.</p><p>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.</p><p>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.</p><p>Paging is always supported.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "messageCompressionOptions":{
            "default":"GZIP_DEFAULT_COMPRESSION",
            "enum":[
                "GZIP_DEFAULT_COMPRESSION",
                "GZIP_BEST_COMPRESSION",
                "GZIP_BEST_SPEED",
                "LZF"
            ],
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>Specifies the type of message compression used when JMS message body compression is enabled for Persistent Stores and JMS Paging Stores.</p><ul><li><p>Use <code>GZIP_DEFAULT_COMPRESSION</code> to enable message compression using the JDK GZIP API with <code>DEFAULT_COMPRESSION</code> level.</p></li><li><p>Use <code>GZIP_BEST_COMPRESSION</code> to enable message compression using the JDK GZIP API with <code>BEST_COMPRESSION</code> level.</p></li><li><p>Use <code>GZIP_BEST_SPEED</code> to enable message compression using the JDK GZIP API with <code>BEST_SPEED</code> level.</p></li><li><p>Use <code>LZF</code> to enable message compression using Open Source LZF.</p></li></ul><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "messagesMaximum":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The maximum number of messages that can be stored in this JMS server. A value of <code>-1</code> removes any WebLogic Server limits.</p><p>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.</p><p><b>Range of Values:</b> >= MessagesThresholdHigh.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "messagesThresholdHigh":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The upper threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of <code>-1</code> disables the events for this JMS server.</p><p>If the number of messages exceeds this threshold, the triggered events are:</p><ul><li><p><code>Log Messages</code> - A message is logged on the server indicating a high threshold condition. </p></li><li><p><code>Flow Control</code> - If flow control is enabled, the JMS server becomes armed and instructs producers to begin decreasing their message flow. </p></li></ul><p><b>Range of Values:</b> <= MessagesMaximum; >= MessagesThresholdLow.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "messagesThresholdLow":{
            "default":-1,
            "minimum":-1,
            "maximum":9.223372036854776E18,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The lower threshold (number of messages stored in this JMS server) that triggers flow control and logging events. A value of <code>-1</code> disables the events for this JMS server.</p><p>If the number of messages falls below this threshold, the triggered events are:</p><ul><li><p><code>Log Messages</code> - A message is logged on the server indicating that the threshold condition has cleared. </p></li><li><p><code>Flow Control</code> - If flow control is enabled, the JMS server becomes disarmed and instructs producers to begin increasing their message flow. </p></li></ul><p><i>Note:</i> This attribute is dynamically configurable.</p><p><b>Range of Values:</b> <= MessagesThresholdHigh</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "pagingBlockSize":{
            "default":-1,
            "minimum":-1,
            "maximum":8192,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The smallest addressable block, in bytes, of a file. When a native <code>wlfileio</code> 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].</p><p>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 <i>Performance and Tuning for Oracle WebLogic Server</i></p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingDirectory":{
            "default":null,
            "x-weblogic-legalNull":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p> Specifies where message bodies are written when the size of the message bodies in the JMS server exceeds the message buffer size.</p><p> If unspecified, messages are written to the default <code>tmp</code> directory inside the <code><i>server-name</i></code> subdirectory of a domain's root directory. For example, <code><i>domain-name</i>/servers/<i>server-name</i>/tmp</code>, where <code><i>domain-name</i></code> is the root directory of your domain. </p><p> For best performance, this directory should not be the same as the directory used by the JMS server's persistent store. </p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>legal null</li><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingFileLockingEnabled":{
            "default":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Determines whether OS file locking is used. </p><p>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.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingIoBufferSize":{
            "default":-1,
            "minimum":-1,
            "maximum":67108864,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>The I/O buffer size, in bytes, automatically rounded down to the nearest power of 2.</p><ul><li><p>When a native <code>wlfileio</code> driver is available, the setting applies to off-heap (native) memory.</p></li><li><p>When a native <code>wlfileio</code> driver is not available, the setting applies to JAVA heap memory.</p></li><li><p>For the best runtime performance, Oracle recommends setting <code>PagingIOBufferSize</code> so that it is larger than the largest write (multiple concurrent store requests may be combined into a single write).</p></li><li><p>See the JMS server runtime MBean attribute <code>PagingAllocatedIOBufferBytes</code> to find out the actual allocated off-heap (native) memory amount.</p></li></ul><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingMaxFileSize":{
            "default":1342177280,
            "minimum":10485760,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The paging maximum file size, in bytes.</p><ul><li><p>The <code>PagingMaxFileSize</code> 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).</p></li><li><p>A paging store automatically reuses space freed by deleted records and automatically expands individual files up to <code>PagingMaxFileSize</code> 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.</p></li><li><p> 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. </p></li><li><p> If <code>PagingMaxFileSize</code> is larger than 2^24 * <code>PagingBlockSize</code>, then <code>MaxFileSize</code> is ignored, and the value becomes 2^24 * <code>PagingBlockSize</code>. The default <code>PagingBlockSize</code> is 512, and 2^24 * 512 is 8 GB. </p></li></ul><p>Oracle recommends not setting the Paging Max File Size above the default value of 1,342,177,280.  </p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingMaxWindowBufferSize":{
            "default":-1,
            "minimum":-1,
            "maximum":1073741824,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>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 <code>wlfileio</code> library is loaded.</p><p>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 <code>PagingMinWindowBufferSize</code>, and then fails if it cannot honor <code>PagingMinWindowBufferSize</code></p><p>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.</p><p>See the JMS server runtime MBean attribute <code>PagingAllocatedWindowBufferBytes</code> to find out the actual allocated Window Buffer Size.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingMessageCompressionEnabled":{
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Enables the JMS paging store to perform message body compression on persistent and non-persistent messages. When <code>false</code>, the default value, no compression is performed.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "pagingMinWindowBufferSize":{
            "default":-1,
            "minimum":-1,
            "maximum":1073741824,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>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 <code>wlfileio</code> library is loaded. See Paging Maximum Window Buffer Size</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "persistentStore":{
            "x-weblogic-restartRequired":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Persistent Store Reference",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"Contains the persistent store reference. <p>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.</p><p>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.</p><p>If you specify a PersistentStore, the deprecated <b>Store</b> field must not be set. If neither the <b>PersistentStore</b> field nor the <b>Store</b> field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>restart required</li><li>not visible for domain scoped mbeans</li></ul>"
        },
        "productionPausedAtStartup":{
            "default":"default",
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>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.</p><p>When the value is set to <code>true</code>, 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.</p><p>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 <code>false</code>, and then either redeploy the JMS server or reboot the hosting server instance. </p><p>When the value is set to <code>default</code>, then the Production Paused At Startup is determined based on the corresponding setting on the individual destination.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "storeEnabled":{
            "default":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p> Specifies whether message persistence is supported for this JMS server.</p><ul><li><p>When set to <code>true</code>: 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. </p></li><li><p> When set to <code>false</code>, then this JMS server does not support persistent messages, and instead downgrades them to non-persistent.</p></li><li><p> The default value is <code>true</code></p></li></ul><p>Oracle recommends not setting this parameter to <code>false</code>. It is available to provide compatibility with older releases.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "storeMessageCompressionEnabled":{
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Enables the JMS store to perform message body compression. When set to <code>false</code>, the default value, no compression is performed.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "targets":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer.</p><p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "temporaryTemplateName":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The name of a configured JMS template that this JMS server uses to create temporary destinations.</p><p>Entering a template name, requires you to specify the JMS module that contains this template. However, a template name cannot be specified if the <b>Hosting Temporary Destinations</b> field is disabled.</p><p><b>Note:</b> If the specified JMS template provides persistent store values, they are ignored because temporary destinations do not support persistent messaging.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "temporaryTemplateResource":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The name of a JMS module that contains a template that this JMS server can use to create temporary destinations.</p><p>Entering a JMS module name requires you to specify a temporary template name. However, a module name cannot be specified if the <b>Hosting Temporary Destinations</b> field is disabled.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}



                    
                    
    Nested Schema : Persistent Store Reference
    
      
      Type: array
    

    

    
    Title: Persistent Store Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the persistent store reference. The file or database in which this JMS server stores persistent messages. If unspecified, the JMS server uses the default persistent store that is configured on each targeted WebLogic Server instance. If the JMS server has a store configured, then the configured store is used to store persistent messages.
The disk-based file store or JDBC-accessible database store that you specify must be targeted to the same server, cluster, or migratable target instance as this JMS server. Multiple services on the same WebLogic Server instance, including multiple JMS servers, may share the same persistent store. Each service's persistent data will be kept apart.
If you specify a PersistentStore, the deprecated Store field must not be set. If neither the PersistentStore field nor the Store field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.
If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).
Constraints
restart required
not visible for domain scoped mbeans
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "x-weblogic-restartRequired":true,
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Persistent Store Reference",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"Contains the persistent store reference. <p>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.</p><p>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.</p><p>If you specify a PersistentStore, the deprecated <b>Store</b> field must not be set. If neither the <b>PersistentStore</b> field nor the <b>Store</b> field are set, the JMS server supports persistent messaging using the default persistent store for the targeted WebLogic Server instance.</p><p>If the value is changed and activated, you need to restart any servers to which the MBean is targeted before the value will take effect (even though you do not get a warning in the Console that the server needs to be restarted).</p><p><h5>Constraints</h5></p><ul><li>restart required</li><li>not visible for domain scoped mbeans</li></ul>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : Items
    
      
      Type: array
    

    

    
    Title: Items
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Return all tags on this Configuration MBean
Constraints
not visible for domain scoped mbeans
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : Target References
    
      
      Type: array
    

    

    
    Title: Target References
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the array of target references. 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.
Constraints
not visible for domain scoped mbeans
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                object  Target Reference
            
            
                
                
Title: Target Reference





















Contains the target reference.


                
            
            
            
        
        {
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>The server instances, clusters, or a migratable targets defined in the current domain that are candidates for hosting the JMSSerer.</p><p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}
    

    

    

    

    

    




                    
                    
    Nested Schema : Target Reference
    
      Type: object
      
    

    

    
    Title: Target Reference
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    Contains the target reference.
    

    

    

    
        Show Source
        
            
            
            identity(optional): 
            array  Identity
            
            
                
                
Title: Identity





















DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.


                
            
            
            
        
        {
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}
    

    

    

    

    

    

    




                    
                    
    Nested Schema : Identity
    
      
      Type: array
    

    

    
    Title: Identity
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
    DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
    

    

    

    

    
        Show Source
        
            
            
            Array of: 
                string
            
            
                
                





























                
            
            
            
        
        {
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}


                

				Back to Top