|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JMSBean
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"
Method Summary | |
---|---|
abstract JMSConnectionFactoryBean |
createConnectionFactory(String name) Creates a connection factory bean and adds it to this JMS module |
abstract DestinationKeyBean |
createDestinationKey(String name) Creates a destination key bean and adds it to this JMS module |
abstract DistributedQueueBean |
createDistributedQueue(String name) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract DistributedTopicBean |
createDistributedTopic(String name) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract ForeignServerBean |
createForeignServer(String name) Creates a foreign server bean and adds it to this JMS module |
abstract QueueBean |
createQueue(String name) Creates a queue bean and adds it to this JMS module |
abstract QuotaBean |
createQuota(String name) Creates a quota bean and adds it to this JMS module |
abstract SAFErrorHandlingBean |
createSAFErrorHandling(String name) Create SAFErrorHandlingBean in this module |
abstract SAFImportedDestinationsBean |
createSAFImportedDestinations(String name) Create a SAFImportedDestinationsBean in this JMSModule |
abstract SAFRemoteContextBean |
createSAFRemoteContext(String name) Create SAFRemoteContextBean in this module |
abstract TemplateBean |
createTemplate(String name) Creates a template bean and adds it to this JMS module |
abstract TopicBean |
createTopic(String name) Creates a topic bean and adds it to this JMS module |
abstract UniformDistributedQueueBean |
createUniformDistributedQueue(String name) Creates a uniform distributed queue bean and adds it to this JMS module |
abstract UniformDistributedTopicBean |
createUniformDistributedTopic(String name) Creates a uniform distributed topic bean and adds it to this JMS module |
abstract void |
destroyConnectionFactory(JMSConnectionFactoryBean connectionFactory) Removes a connection factory bean from this JMS module |
abstract void |
destroyDestinationKey(DestinationKeyBean destinationKey) Removes a destination key bean from this JMS module |
abstract void |
destroyDistributedQueue(DistributedQueueBean distributedQueue) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract void |
destroyDistributedTopic(DistributedTopicBean distributedTopic) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract void |
destroyForeignServer(ForeignServerBean foreignServer) Removes a foreign server bean from this JMS module |
abstract void |
destroyQueue(QueueBean queue) Removes a queue bean from this JMS module |
abstract void |
destroyQuota(QuotaBean quota) Removes a quota bean from this JMS module |
abstract void |
destroySAFErrorHandling(SAFErrorHandlingBean safErrorHandling) Destroy SAFErrorHandlingBean defined in this module |
abstract void |
destroySAFImportedDestinations(SAFImportedDestinationsBean safImportedDestinations) Destroy a SAFImportedDestinationsBean in this JMS Module |
abstract void |
destroySAFRemoteContext(SAFRemoteContextBean safRemoteContext) Destroy SAFRemoteContextBean in this module |
abstract void |
destroyTemplate(TemplateBean template) Removes a template bean from this JMS module |
abstract void |
destroyTopic(TopicBean topic) Removes a topic bean from this JMS module |
abstract void |
destroyUniformDistributedQueue(UniformDistributedQueueBean uniformDistributedQueue) Removes a uniform distributed queue bean from this JMS module |
abstract void |
destroyUniformDistributedTopic(UniformDistributedTopicBean uniformDistributedTopic) Removes a uniform distributed topic bean from this JMS module |
abstract JMSConnectionFactoryBean[] |
getConnectionFactories() Defines a set of connection configuration parameters that are used to create connections for JMS clients. |
abstract DestinationKeyBean[] |
getDestinationKeys() Defines a unique sort order that destinations can apply to arriving messages. |
abstract DistributedQueueBean[] |
getDistributedQueues() Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract DistributedTopicBean[] |
getDistributedTopics() Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract ForeignServerBean[] |
getForeignServers() Defines foreign messaging providers or remote WebLogic Server instances that are not part of the current domain. |
abstract String |
getNotes() Optional information that you can include to describe this JMS module. |
abstract QueueBean[] |
getQueues() Defines a point-to-point destination type, which are used for asynchronous peer communications. |
abstract QuotaBean[] |
getQuotas() Controls the allotment of system resources available to destinations. |
abstract SAFErrorHandlingBean[] |
getSAFErrorHandlings() Defines the action to take when the SAF service fails to forward messages to remote destinations. |
abstract SAFImportedDestinationsBean[] |
getSAFImportedDestinations() Defines a collection of imported store-and-forward (SAF) destinations. |
abstract SAFRemoteContextBean[] |
getSAFRemoteContexts() Defines the URL of the remote server instance or cluster where a JMS destination is exported from. |
abstract TemplateBean[] |
getTemplates() Defines a set of default configuration settings for multiple destinations. |
abstract TopicBean[] |
getTopics() Defines a publish/subscribe destination type, which are used for asynchronous peer communications. |
abstract 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. |
abstract 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. |
abstract int |
getVersion() The version of this file. |
abstract JMSConnectionFactoryBean |
lookupConnectionFactory(String name) Locates a connection factory bean with the given name |
abstract DestinationKeyBean |
lookupDestinationKey(String name) Locates a destination key bean with the given name |
abstract DistributedQueueBean |
lookupDistributedQueue(String name) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract DistributedTopicBean |
lookupDistributedTopic(String name) Deprecated. 10.3.4.0, since Weighted Distributed Destination has been deprecated and replaced by Uniform Distributed Destination |
abstract ForeignServerBean |
lookupForeignServer(String name) Locates a foreign server bean with the given name |
abstract QueueBean |
lookupQueue(String name) Locates a queue bean with the given name |
abstract QuotaBean |
lookupQuota(String name) Locates the quota of a given name |
abstract SAFErrorHandlingBean |
lookupSAFErrorHandling(String name) Locates a SAF Error Handling bean with the given name |
abstract SAFImportedDestinationsBean |
lookupSAFImportedDestinations(String name) Locates a SAF Imported Destinations bean with the given name |
abstract SAFRemoteContextBean |
lookupSAFRemoteContext(String name) Locates a SAF Remote Context bean with the given name |
abstract TemplateBean |
lookupTemplate(String name) Locates a template bean with the given name |
abstract TopicBean |
lookupTopic(String name) Locates a topic bean with the given name |
abstract UniformDistributedQueueBean |
lookupUniformDistributedQueue(String name) Locates a uniform distributed queue bean with the given name |
abstract UniformDistributedTopicBean |
lookupUniformDistributedTopic(String name) Locates a uniform distributed topic bean with the given name |
abstract void |
setNotes(String notes) Sets the notes attribute of the JMS module |
abstract void |
setVersion(int version) Sets the version of this file |
Method Detail |
---|
int getVersion()
void setVersion(int version)
version
- The version this file should beString 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.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
void setNotes(String notes)
Sets the notes attribute of the JMS module
notes
- The new notes valueQuotaBean[] 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.
QuotaBean createQuota(String 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
name
- The name of the quota bean to createdvoid destroyQuota(QuotaBean quota)
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
quota
- The quota bean to be removedQuotaBean lookupQuota(String 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
name
- The name of the quota to locateTemplateBean[] 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.
TemplateBean createTemplate(String 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.
name
- The name of the template to createvoid destroyTemplate(TemplateBean template)
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.
template
- The template to remove from this JMS moduleTemplateBean lookupTemplate(String 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.
name
- The name of the template to findDestinationKeyBean[] 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).
DestinationKeyBean createDestinationKey(String name)
Destination Key beans control the sorting criteria of JMS destinations
name
- The name of the destination key to be added to this JMS modulevoid destroyDestinationKey(DestinationKeyBean destinationKey)
Destination Key beans control the sorting criteria of JMS destinations
destinationKey
- The destination key to be removed from this JMS moduleDestinationKeyBean lookupDestinationKey(String name)
Destination Key beans control the sorting criteria of JMS destinations
name
- The name of the destination key to locateJMSConnectionFactoryBean[] 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.
JMSConnectionFactoryBean createConnectionFactory(String name)
Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.
name
- The name of the connection factory to add to this JMS modulevoid destroyConnectionFactory(JMSConnectionFactoryBean connectionFactory)
Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.
connectionFactory
- The connection factory bean to remove from this JMS moduleJMSConnectionFactoryBean lookupConnectionFactory(String name)
Connection factories are used to create connections for JMS clients. Connection factories can configure properties of the connections returned to the JMS client.
name
- The name of the connection factory to locateForeignServerBean[] 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.
ForeignServerBean createForeignServer(String 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.
name
- The name of the foreign server bean to add to this JMS modulevoid destroyForeignServer(ForeignServerBean foreignServer)
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.
foreignServer
- The foreign server bean to remove from this JMS moduleForeignServerBean lookupForeignServer(String 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.
name
- The name of the foreign server to locateQueueBean[] 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.
QueueBean createQueue(String 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.
name
- The name of the queue bean to be added to this JMS modulevoid destroyQueue(QueueBean queue)
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.
queue
- The queue to be removed from this JMS moduleQueueBean lookupQueue(String 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.
name
- The name of the queue to lookupTopicBean[] 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.
TopicBean createTopic(String name)
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.
name
- The name of the topic bean to add to this JMS modulevoid destroyTopic(TopicBean topic)
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.
topic
- The topic to be removed from this JMS moduleTopicBean lookupTopic(String name)
name
- The name of the topic to lookupDistributedQueueBean[] getDistributedQueues()
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.
DistributedQueueBean createDistributedQueue(String 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.
name
- The name of the distributed queue bean to add to this JMS modulevoid destroyDistributedQueue(DistributedQueueBean distributedQueue)
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.
distributedQueue
- The distributed queue bean to remove from this JMS moduleDistributedQueueBean lookupDistributedQueue(String 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.
name
- The name of the distributed queue to locateDistributedTopicBean[] getDistributedTopics()
Distributed topics can help with load balancing and distribution, and have many of the same properties as standalone topics.
DistributedTopicBean createDistributedTopic(String 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.
name
- The name of the distributed topic bean to add to this JMS modulevoid destroyDistributedTopic(DistributedTopicBean distributedTopic)
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.
distributedTopic
- The distributed topic bean to remove from this JMS moduleDistributedTopicBean lookupDistributedTopic(String 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.
name
- The name of the distributed topic to locateUniformDistributedQueueBean[] 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.
UniformDistributedQueueBean createUniformDistributedQueue(String 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.
name
- The name of the uniform distributed queue bean to add to this JMS modulevoid destroyUniformDistributedQueue(UniformDistributedQueueBean uniformDistributedQueue)
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.
uniformDistributedQueue
- The uniform distributed queue bean to remove from this JMS moduleUniformDistributedQueueBean lookupUniformDistributedQueue(String 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.
name
- The name of the uniform distributed queue to locateUniformDistributedTopicBean[] 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.
UniformDistributedTopicBean createUniformDistributedTopic(String 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.
name
- The name of the uniform distributed topic bean to add to this JMS modulevoid destroyUniformDistributedTopic(UniformDistributedTopicBean uniformDistributedTopic)
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.
uniformDistributedTopic
- The uniform distributed topic bean to remove from this JMS moduleUniformDistributedTopicBean lookupUniformDistributedTopic(String 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.
name
- The name of the uniform distributed topic bean to locateSAFImportedDestinationsBean[] 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.
SAFImportedDestinationsBean createSAFImportedDestinations(String name)
SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server
name
- The name of the SAFImportedDestinations to be created.void destroySAFImportedDestinations(SAFImportedDestinationsBean safImportedDestinations)
SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server
safImportedDestinations
- SAFImportedDestinationsBean defined in this moduleSAFImportedDestinationsBean lookupSAFImportedDestinations(String name)
SAFImportedDestinationsBean defines a set of SAFQueues and or SAFTopics imported in the local cluster from the remote Cluster or server
name
- The name of the SAF imported destinations to locateSAFRemoteContextBean[] 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.
SAFRemoteContextBean createSAFRemoteContext(String name)
SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.
name
- The name of the SAFRemoteContextBean to be created.void destroySAFRemoteContext(SAFRemoteContextBean safRemoteContext)
SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.
safRemoteContext
- SAFRemoteContextBean in this moduleSAFRemoteContextBean lookupSAFRemoteContext(String name)
SAFRemoteContextBean defines the parameters to be used by the JMS Imported Destinations (SAFQueue or SAFTopic) to connect ot the remote Cluster.
name
- The name of the SAF Remote Context to locateSAFErrorHandlingBean[] 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.
SAFErrorHandlingBean createSAFErrorHandling(String name)
SAFErrorHandlingBeaa defines what has to be done for messages that cannot be forwarded by SAFAgents
name
- The name of the SAFErrorHandlingBean to be created.void destroySAFErrorHandling(SAFErrorHandlingBean safErrorHandling)
SAFErrorHandlingBean defines what has to be done for messages that cannot be forwarded by SAFAgents
safErrorHandling
- SAFErrorhandlingBean defined in this moduleSAFErrorHandlingBean lookupSAFErrorHandling(String name)
SAFErrorHandlingBean defines what has to be done for messages that cannot be forwarded by SAFAgents
name
- The name of the SAF Error Handling to locate
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |