weblogic.j2ee.descriptor.wl
Interface JMSBean

All Superinterfaces:

SettableBean

public interface JMSBean
extends SettableBean

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"

Access limited to the following security roles:

Deployer

getVersion

int getVersion()

The version of this file.

Returns:

The verion of this file

Default Value:

1

setVersion

void setVersion(int version)

Sets the version of this file

Parameters:

version - The version this file should be

getNotes

String getNotes()

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.

Returns:

The notes value

Changes take effect after you redeploy the module or restart the server.

setNotes

void setNotes(String notes)

Sets the notes attribute of the JMS module

Parameters:

notes - The new notes value

getQuotas

QuotaBean[] getQuotas()

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.

Returns:

An array of all quota beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createQuota

QuotaBean createQuota(String name)

Creates a quota bean and adds it to this JMS module

Quota beans control 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 QuotaBean

Parameters:

name - The name of the quota bean to created

Returns:

The quota bean that was created

destroyQuota

void destroyQuota(QuotaBean quota)

Removes a quota bean from this JMS module

Quota beans control 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 QuotaBean

Parameters:

quota - The quota bean to be removed

lookupQuota

QuotaBean lookupQuota(String name)

Locates the quota of a given name

Quota beans control 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 QuotaBean

Parameters:

name - The name of the quota to locate

Returns:

The quota of the given name or null if one could not be found

getTemplates

TemplateBean[] getTemplates()

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.

Returns:

An array of all template beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createTemplate

TemplateBean createTemplate(String name)

Creates a template bean and adds it to this JMS module

Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.

Parameters:

name - The name of the template to create

Returns:

The template bean added to this JMS module

destroyTemplate

void destroyTemplate(TemplateBean template)

Removes a template bean from this JMS module

Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.

Parameters:

template - The template to remove from this JMS module

lookupTemplate

TemplateBean lookupTemplate(String name)

Locates a template bean with the given name

Template beans contain default values for destination attributes. If a destination defines a template and does not explicitly set the value of an attribute, then that attribute will take its value from the defined template.

Parameters:

name - The name of the template to find

Returns:

The template with the given name or null if one cannot be found

getDestinationKeys

DestinationKeyBean[] getDestinationKeys()

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).

Returns:

An array of all destination key beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createDestinationKey

DestinationKeyBean createDestinationKey(String name)

Creates a destination key bean and adds it to this JMS module

Destination Key beans control the sorting criteria of JMS destinations

Parameters:

name - The name of the destination key to be added to this JMS module

Returns:

The destination key bean added to this JMS module

destroyDestinationKey

void destroyDestinationKey(DestinationKeyBean destinationKey)

Removes a destination key bean from this JMS module

Destination Key beans control the sorting criteria of JMS destinations

Parameters:

destinationKey - The destination key to be removed from this JMS module

lookupDestinationKey

DestinationKeyBean lookupDestinationKey(String name)

Locates a destination key bean with the given name

Destination Key beans control the sorting criteria of JMS destinations

Parameters:

name - The name of the destination key to locate

Returns:

The destination key bean with the given name, or null if one could not be found

getConnectionFactories

JMSConnectionFactoryBean[] getConnectionFactories()

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.

Returns:

An array of all connection factory beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createConnectionFactory

JMSConnectionFactoryBean createConnectionFactory(String name)

Creates a connection factory bean and adds it to this JMS module

Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.

Parameters:

name - The name of the connection factory to add to this JMS module

Returns:

The connection factory bean added to this JMS module

destroyConnectionFactory

void destroyConnectionFactory(JMSConnectionFactoryBean connectionFactory)

Removes a connection factory bean from this JMS module

Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.

Parameters:

connectionFactory - The connection factory bean to remove from this JMS module

lookupConnectionFactory

JMSConnectionFactoryBean lookupConnectionFactory(String name)

Locates a connection factory bean with the given name

Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.

Parameters:

name - The name of the connection factory to locate

Returns:

A connection factory with the given name, or null if one cannot be found

getForeignServers

ForeignServerBean[] getForeignServers()

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.

Returns:

An array of all foreign server beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createForeignServer

ForeignServerBean createForeignServer(String name)

Creates a foreign server bean and adds it to this JMS module

Foreign servers are used to configure messaging providers that are not part of the current domain. This is useful when integrating with another vendors JMS product.

Parameters:

name - The name of the foreign server bean to add to this JMS module

Returns:

The foreign server bean added to this JMS module

destroyForeignServer

void destroyForeignServer(ForeignServerBean foreignServer)

Removes a foreign server bean from this JMS module

Foreign servers are used to configure messaging providers that are not part of the current domain. This is useful when integrating with another vendors JMS product.

Parameters:

foreignServer - The foreign server bean to remove from this JMS module

lookupForeignServer

ForeignServerBean lookupForeignServer(String name)

Locates a foreign server bean with the given name

Foreign servers are used to configure messaging providers that are not part of the current domain. This is useful when integrating with another vendors JMS product.

Parameters:

name - The name of the foreign server to locate

Returns:

A foreign server with the given name, or null if one cannot be found

getQueues

QueueBean[] getQueues()

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.

Returns:

An array of all queue beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createQueue

QueueBean createQueue(String name)

Creates a queue bean and adds it to this JMS module

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.

Parameters:

name - The name of the queue bean to be added to this JMS module

Returns:

The queue bean added to this JMS module

destroyQueue

void destroyQueue(QueueBean queue)

Removes a queue bean from this JMS module

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.

Parameters:

queue - The queue to be removed from this JMS module

lookupQueue

QueueBean lookupQueue(String name)

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.

Parameters:

name - The name of the queue to lookup

Returns:

A queue with the given name, or null if one cannot be found

getTopics

TopicBean[] getTopics()

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.

Returns:

An array of all topic beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createTopic

TopicBean createTopic(String name)

Creates a topic bean and adds it to this JMS module

Topics are used for asynchronous peer communications. A message delivered to a topic will be distributed to all topic consumers. Several aspects of a topics behavior can be configured with a topic bean.

Parameters:

name - The name of the topic bean to add to this JMS module

Returns:

The topic bean added to this JMS module

destroyTopic

void destroyTopic(TopicBean topic)

Removes a topic bean from this JMS module

Topics are used for asynchronous peer communications. A message delivered to a topic will be distributed to all topic consumers. Several aspects of a topics behavior can be configured with a topic bean.

Parameters:

topic - The topic to be removed from this JMS module

lookupTopic

TopicBean lookupTopic(String name)

Locates a topic bean with the given name

Parameters:

name - The name of the topic to lookup

Returns:

A topic with the given name, or null if none could be found

getDistributedQueues

DistributedQueueBean[] getDistributedQueues()

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

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.

Returns:

An array of all distributed queue beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createDistributedQueue

DistributedQueueBean createDistributedQueue(String name)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Creates a distributed queue bean and adds it to this JMS module

A distributed queue is a queue that is located on many JMS servers. Distributed queues can help with load balancing and distribution, and have many of the same properties as normal queues. Many aspects of a distributed queues behavior can be configured with a distributed queue bean.

Parameters:

name - The name of the distributed queue bean to add to this JMS module

Returns:

The distributed queue bean added to this JMS module

destroyDistributedQueue

void destroyDistributedQueue(DistributedQueueBean distributedQueue)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Removes a distributed queue bean from this JMS module

A distributed queue is a queue that is located on many JMS servers. Distributed queues can help with load balancing and distribution, and have many of the same properties as normal queues. Many aspects of a distributed queues behavior can be configured with a distributed queue bean.

Parameters:

distributedQueue - The distributed queue bean to remove from this JMS module

lookupDistributedQueue

DistributedQueueBean lookupDistributedQueue(String name)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Locates a distributed queue bean with the given name

A distributed queue is a queue that is located on many JMS servers. Distributed queues can help with load balancing and distribution, and have many of the same properties as normal queues. Many aspects of a distributed queues behavior can be configured with a distributed queue bean.

Parameters:

name - The name of the distributed queue to locate

Returns:

A distributed queue with the given name, or null if none could be found

getDistributedTopics

DistributedTopicBean[] getDistributedTopics()

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

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.

Returns:

An array of all distributed topic beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createDistributedTopic

DistributedTopicBean createDistributedTopic(String name)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Creates a distributed topic bean and adds it to this JMS module

A distributed topic is a topic that is located on many JMS servers. Distributed topics can help with load balancing and distribution, and have many of the same properties as normal topics. Many aspects of a distributed topics behavior can be configured with a distributed topic bean.

Parameters:

name - The name of the distributed topic bean to add to this JMS module

Returns:

The distributed topic bean added to this JMS module

destroyDistributedTopic

void destroyDistributedTopic(DistributedTopicBean distributedTopic)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Removes a distributed topic bean from this JMS module

A distributed topic is a topic that is located on many JMS servers. Distributed topics can help with load balancing and distribution, and have many of the same properties as normal topics. Many aspects of a distributed topics behavior can be configured with a distributed topic bean.

Parameters:

distributedTopic - The distributed topic bean to remove from this JMS module

lookupDistributedTopic

DistributedTopicBean lookupDistributedTopic(String name)

Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination

Locates a distributed topic bean with the given name

A distributed topic is a topic that is located on many JMS servers. Distributed topics can help with load balancing and distribution, and have many of the same properties as normal topics. Many aspects of a distributed topics behavior can be configured with a distributed topic bean.

Parameters:

name - The name of the distributed topic to locate

Returns:

A distributed topic with the given name, or null if none could be found

getUniformDistributedQueues

UniformDistributedQueueBean[] getUniformDistributedQueues()

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.

Returns:

The uniform distributed queue beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createUniformDistributedQueue

UniformDistributedQueueBean createUniformDistributedQueue(String name)

Creates a uniform distributed queue bean and adds it to this JMS module

A uniform distributed queue is a distributed queue whose members are configured as part of the configuration of the distributed queue. These members are, therefore, uniform and are created based on the targeting of the uniform distributed queue.

Parameters:

name - The name of the uniform distributed queue bean to add to this JMS module

Returns:

The uniform distributed queue bean added to this JMS module

destroyUniformDistributedQueue

void destroyUniformDistributedQueue(UniformDistributedQueueBean uniformDistributedQueue)

Removes a uniform distributed queue bean from this JMS module

A uniform distributed queue is a distributed queue whose members are configured as part of the configuration of the distributed queue. These members are, therefore, uniform and are created based on the targeting of the uniform distributed queue.

Parameters:

uniformDistributedQueue - The uniform distributed queue bean to remove from this JMS module

lookupUniformDistributedQueue

UniformDistributedQueueBean lookupUniformDistributedQueue(String name)

Locates a uniform distributed queue bean with the given name

A uniform distributed queue is a distributed queue whose members are configured as part of the configuration of the distributed queue. These members are, therefore, uniform and are created based on the targeting of the uniform distributed queue.

Parameters:

name - The name of the uniform distributed queue to locate

Returns:

A uniform distributed queue bean with the given name, or null if none could be found

getUniformDistributedTopics

UniformDistributedTopicBean[] getUniformDistributedTopics()

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.

Returns:

All the uniform distributed topic beans in this JMS module

Changes take effect after you redeploy the module or restart the server.

createUniformDistributedTopic

UniformDistributedTopicBean createUniformDistributedTopic(String name)

Creates a uniform distributed topic bean and adds it to this JMS module

A uniform distributed topic is a distributed topic whose members are configured as part of the configuration of the distributed topic. These members are, therefore, uniform and are created based on the targeting of the uniform distributed topic.

Parameters:

name - The name of the uniform distributed topic bean to add to this JMS module

Returns:

The uniform distributed topic bean added to this JMS module

destroyUniformDistributedTopic

void destroyUniformDistributedTopic(UniformDistributedTopicBean uniformDistributedTopic)

Removes a uniform distributed topic bean from this JMS module

A uniform distributed topic is a distributed topic whose members are configured as part of the configuration of the distributed topic. These members are, therefore, uniform and are created based on the targeting of the uniform distributed topic.

Parameters:

uniformDistributedTopic - The uniform distributed topic bean to remove from this JMS module

lookupUniformDistributedTopic

UniformDistributedTopicBean lookupUniformDistributedTopic(String name)

Locates a uniform distributed topic bean with the given name

A uniform distributed topic is a distributed topic whose members are configured as part of the configuration of the distributed topic. These members are, therefore, uniform and are created based on the targeting of the uniform distributed topic.

Parameters:

name - The name of the uniform distributed topic bean to locate

Returns:

A uniform distributed topic with the given name, or null if none could be found

getSAFImportedDestinations

SAFImportedDestinationsBean[] getSAFImportedDestinations()

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.

Returns:

an array of SAFImportedDestinationsBean added to this JMS Module

Changes take effect after you redeploy the module or restart the server.

createSAFImportedDestinations

SAFImportedDestinationsBean createSAFImportedDestinations(String name)

Create a SAFImportedDestinationsBean in this JMSModule

SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server

Parameters:

name - The name of the SAFImportedDestinations to be created.

Returns:

SAFImportedDestinationsBean added to this JMS Module

destroySAFImportedDestinations

void destroySAFImportedDestinations(SAFImportedDestinationsBean safImportedDestinations)

Destroy a SAFImportedDestinationsBean in this JMS Module

SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server

Parameters:

safImportedDestinations - SAFImportedDestinationsBean defined in this module

lookupSAFImportedDestinations

SAFImportedDestinationsBean lookupSAFImportedDestinations(String name)

Locates a SAF Imported Destinations bean with the given name

SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server

Parameters:

name - The name of the SAF imported destinations to locate

Returns:

A SAF imported destination bean with the given name, or null if none could be found

getSAFRemoteContexts

SAFRemoteContextBean[] getSAFRemoteContexts()

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.

Returns:

Array of SAFRemoteContextBean defined in this module

Changes take effect after you redeploy the module or restart the server.

createSAFRemoteContext

SAFRemoteContextBean createSAFRemoteContext(String name)

Create SAFRemoteContextBean in this module

SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.

Parameters:

name - The name of the SAFRemoteContextBean to be created.

Returns:

SAFRemoteContextBean being added to this module

destroySAFRemoteContext

void destroySAFRemoteContext(SAFRemoteContextBean safRemoteContext)

Destroy SAFRemoteContextBean in this module

SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.

Parameters:

safRemoteContext - SAFRemoteContextBean in this module

lookupSAFRemoteContext

SAFRemoteContextBean lookupSAFRemoteContext(String name)

Locates a SAF Remote Context bean with the given name

SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.

Parameters:

name - The name of the SAF Remote Context to locate

Returns:

A SAF Remote Context with the given name, or null if none can be found

getSAFErrorHandlings

SAFErrorHandlingBean[] getSAFErrorHandlings()

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.

Returns:

array of SAFErrorHandlingBean defined in this module

Changes take effect after you redeploy the module or restart the server.

createSAFErrorHandling

SAFErrorHandlingBean createSAFErrorHandling(String name)

Create SAFErrorHandlingBean in this module

SAFErrorHandlingBeaa defines what has to be done for messages that cannot be forwarded by SAFAgents

Parameters:

name - The name of the SAFErrorHandlingBean to be created.

Returns:

SAFErrorHandlingBean

destroySAFErrorHandling

void destroySAFErrorHandling(SAFErrorHandlingBean safErrorHandling)

Destroy SAFErrorHandlingBean defined in this module

SAFErrorHandlingBean defines what has to be done for messages that cannot be forwarded by SAFAgents

Parameters:

safErrorHandling - SAFErrorhandlingBean defined in this module

lookupSAFErrorHandling

SAFErrorHandlingBean lookupSAFErrorHandling(String name)

Locates a SAF Error Handling bean with the given name

SAFErrorHandlingBean defines what has to be done for messages that cannot be forwarded by SAFAgents

Parameters:

name - The name of the SAF Error Handling to locate

Returns:

A SAF Error Handling with the given name, or null if none can be found