JMSBean

Overview | Related MBeans | Attributes | Operations

Overview

The top of the JMS module bean tree.

JMS modules all have a JMSBean as their root bean (a bean with no parent). The schema namespace that corresponds to this bean is "http://xmlns.oracle.com/weblogic/weblogic-jms"

Security roles	The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean: Deployer
Fully Qualified Interface Name	If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.j2ee.descriptor.wl.JMSBean`
Factory Methods	No factory methods. Instances of this MBean are created automatically.

Related MBeans

This section describes attributes that provide access to other MBeans.

ConnectionFactories
DestinationKeys
DistributedQueues
DistributedTopics
ForeignServers
Queues
Quotas
SAFErrorHandlings

SAFImportedDestinations
SAFRemoteContexts
Templates
Topics
UniformDistributedQueues
UniformDistributedTopics

ConnectionFactories

Defines a set of connection configuration parameters that are used to create connections for JMS clients.

Connection factories can configure properties of the connections returned to the JMS client, and also provide configurable options for default delivery, transaction, and message flow control parameters.

Factory Methods	`createConnectionFactory (java.lang.String name)` `destroyConnectionFactory (JMSConnectionFactoryBean connectionFactory)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupConnectionFactory(String name)` Returns a `javax.management.ObjectName` for the instance of `JMSConnectionFactoryBean` named `name`.
Privileges	Read only
Type	JMSConnectionFactoryBean[]
Relationship type:	Containment.

DestinationKeys

Defines a unique sort order that destinations can apply to arriving messages.

By default messages are sorted in FIFO (first-in, first-out) order, which sorts ascending based on each message's unique JMSMessageID. However, you can configure destination key to use a different sorting scheme for a destination, such as LIFO (last-in, first-out).

Factory Methods	`createDestinationKey (java.lang.String name)` `destroyDestinationKey (DestinationKeyBean destinationKey)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupDestinationKey(String name)` Returns a `javax.management.ObjectName` for the instance of `DestinationKeyBean` named `name`.
Privileges	Read only
Type	DestinationKeyBean[]
Relationship type:	Containment.

DistributedQueues

Defines a set of queues that are distributed on multiple JMS servers, but which are accessible as a single, logical queue to JMS clients.

Distributed queues can help with message load balancing and distribution, and have many of the same properties as standalone queues.

Factory Methods	`createDistributedQueue (java.lang.String name)` `destroyDistributedQueue (DistributedQueueBean distributedQueue)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupDistributedQueue(String name)` Returns a `javax.management.ObjectName` for the instance of `DistributedQueueBean` named `name`.
Privileges	Read only
Type	DistributedQueueBean[]
Relationship type:	Containment.

DistributedTopics

Defines a set of topics that are distributed on multiple JMS servers, but which are accessible as a single, logical topic to JMS clients.

Distributed topics can help with load balancing and distribution, and have many of the same properties as standalone topics.

Factory Methods	`createDistributedTopic (java.lang.String name)` `destroyDistributedTopic (DistributedTopicBean distributedTopic)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupDistributedTopic(String name)` Returns a `javax.management.ObjectName` for the instance of `DistributedTopicBean` named `name`.
Privileges	Read only
Type	DistributedTopicBean[]
Relationship type:	Containment.

ForeignServers

Defines foreign messaging providers or remote WebLogic Server instances that are not part of the current domain.

This is useful when integrating with another vendor's JMS product, or when referencing remote instances of WebLogic Server in another cluster or domain in the local WebLogic JNDI tree.

Factory Methods	`createForeignServer (java.lang.String name)` `destroyForeignServer (ForeignServerBean foreignServer)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupForeignServer(String name)` Returns a `javax.management.ObjectName` for the instance of `ForeignServerBean` named `name`.
Privileges	Read only
Type	ForeignServerBean[]
Relationship type:	Containment.

Queues

Defines a point-to-point destination type, which are used for asynchronous peer communications. A message delivered to a queue is distributed to only one consumer.

Several aspects of a queue's behavior can be configured, including thresholds, logging, delivery overrides, and delivery failure options.

Factory Methods	`createQueue (java.lang.String name)` `destroyQueue (QueueBean queue)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupQueue(String name)` Returns a `javax.management.ObjectName` for the instance of `QueueBean` named `name`.
Privileges	Read only
Type	QueueBean[]
Relationship type:	Containment.

Quotas

Controls the allotment of system resources available to destinations.

For example, the number of bytes a destination is allowed to store can be configured with a Quota resource.

Factory Methods	`createQuota (java.lang.String name)` `destroyQuota (QuotaBean quota)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupQuota(String name)` Returns a `javax.management.ObjectName` for the instance of `QuotaBean` named `name`.
Privileges	Read only
Type	QuotaBean[]
Relationship type:	Containment.

SAFErrorHandlings

Defines the action to take when the SAF service fails to forward messages to remote destinations.

Configuration options include an Error Handling Policy (Redirect, Log, Discard, or Always-Forward), a Log Format, and sending Retry parameters.

Factory Methods	`createSAFErrorHandling (java.lang.String name)` `destroySAFErrorHandling (SAFErrorHandlingBean safErrorHandling)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupSAFErrorHandling(String name)` Returns a `javax.management.ObjectName` for the instance of `SAFErrorHandlingBean` named `name`.
Privileges	Read only
Type	SAFErrorHandlingBean[]
Relationship type:	Containment.

SAFImportedDestinations

Defines a collection of imported store-and-forward (SAF) destinations. A SAF destination is a representation of a queue or topic in a remote server instance or cluster that is imported into the local cluster or server instance, so that the local server instance or cluster can send messages to the remote server instance or cluster.

All JMS destinations are automatically exported by default, unless the Export SAF Destination parameter on a destination is explicitly disabled. Each collection of SAF imported destinations is associated with a remote SAF context resource, and, optionally, a SAF error handling resource.

Factory Methods	`createSAFImportedDestinations (java.lang.String name)` `destroySAFImportedDestinations (SAFImportedDestinationsBean safImportedDestinations)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupSAFImportedDestinations(String name)` Returns a `javax.management.ObjectName` for the instance of `SAFImportedDestinationsBean` named `name`.
Privileges	Read only
Type	SAFImportedDestinationsBean[]
Relationship type:	Containment.

SAFRemoteContexts

Defines the URL of the remote server instance or cluster where a JMS destination is exported from. It also contains the security credentials to be authenticated and authorized in the remote cluster or server.

Factory Methods	`createSAFRemoteContext (java.lang.String name)` `destroySAFRemoteContext (SAFRemoteContextBean safRemoteContext)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupSAFRemoteContext(String name)` Returns a `javax.management.ObjectName` for the instance of `SAFRemoteContextBean` named `name`.
Privileges	Read only
Type	SAFRemoteContextBean[]
Relationship type:	Containment.

Templates

Defines a set of default configuration settings for multiple destinations.

If a destination specifies a template and does not explicitly set the value of a parameter, then that parameter will take its value from the specified template.

Factory Methods	`createTemplate (java.lang.String name)` `destroyTemplate (TemplateBean template)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupTemplate(String name)` Returns a `javax.management.ObjectName` for the instance of `TemplateBean` named `name`.
Privileges	Read only
Type	TemplateBean[]
Relationship type:	Containment.

Topics

Defines a publish/subscribe destination type, which are used for asynchronous peer communications. A message delivered to a topic is distributed to all topic consumers.

Several aspects of a topic's behavior can be configured, including thresholds, logging, delivery overrides, delivery failure, and multicasting parameters.

Factory Methods	`createTopic (java.lang.String name)` `destroyTopic (TopicBean topic)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupTopic(String name)` Returns a `javax.management.ObjectName` for the instance of `TopicBean` named `name`.
Privileges	Read only
Type	TopicBean[]
Relationship type:	Containment.

UniformDistributedQueues

Defines a uniformly configured distributed queue, whose members have a consistent configuration of all distributed queue parameters, particularly in regards to weighting, security, persistence, paging, and quotas. These uniform distributed queue members are created on JMS servers based on the targeting of the uniform distributed queue.

Uniform distributed queues can help with message load balancing and distribution, and have many of the same properties as standalone queues, including thresholds, logging, delivery overrides, and delivery failure parameters.

Factory Methods	`createUniformDistributedQueue (java.lang.String name)` `destroyUniformDistributedQueue (UniformDistributedQueueBean uniformDistributedQueue)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupUniformDistributedQueue(String name)` Returns a `javax.management.ObjectName` for the instance of `UniformDistributedQueueBean` named `name`.
Privileges	Read only
Type	UniformDistributedQueueBean[]
Relationship type:	Containment.

UniformDistributedTopics

Defines a uniformly configured distributed topic, whose members have a consistent configuration of all uniform distributed queue parameters, particularly in regards to weighting, security, persistence, paging, and quotas. These uniform distributed topic members are created on JMS servers based on the targeting of the uniform distributed topic.

Uniform distributed topics can help with message load balancing and distribution, and have many of the same properties as standalone topics, including thresholds, logging, delivery overrides, and delivery failure parameters.

Factory Methods	`createUniformDistributedTopic (java.lang.String name)` `destroyUniformDistributedTopic (UniformDistributedTopicBean uniformDistributedTopic)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupUniformDistributedTopic(String name)` Returns a `javax.management.ObjectName` for the instance of `UniformDistributedTopicBean` named `name`.
Privileges	Read only
Type	UniformDistributedTopicBean[]
Relationship type:	Containment.

Attributes

This section describes the following attributes:

Notes
Version

Notes

Optional information that you can include to describe this JMS module.

JMS module saves this note in the JMS descriptor file 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.

Privileges	Read/Write
Type	java.lang.String

Version

The version of this file.

Privileges	Read/Write
Type	int
Default Value	1

Operations

This section describes the following operations:

isSet
lookupQueue
lookupTopic

unSet

isSet

Return true if the given property has been explicitly set in this bean.

Operation Name	`"isSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException` IllegalArgumentException if propertyName is not a recognized property

lookupQueue

Locates a queue bean with the given name

Queues are used for asynchronous peer communications. A message delivered to a queue will be distributed to one consumer. Several aspects of a queues behavior can be configured with a queue bean.

Operation Name	`"lookupQueue"`
Parameters	`Object [] { name }` where: `name` is an object of type `java.lang.String` that specifies: The name of the queue to lookup
Signature	`String [] { "java.lang.String" }`
Returns	`QueueBean`

lookupTopic

Locates a topic bean with the given name

Operation Name	`"lookupTopic"`
Parameters	`Object [] { name }` where: `name` is an object of type `java.lang.String` that specifies: The name of the topic to lookup
Signature	`String [] { "java.lang.String" }`
Returns	`TopicBean`

unSet

Restore the given property to its default value.

Operation Name	`"unSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature	`String [] { "java.lang.String" }`
Returns	`void`
Exceptions	`java.lang.IllegalArgumentException` UnsupportedOperationException if called on a runtime implementation.