weblogic.jms.extensions

Interface IJMSModuleHelper

public interface IJMSModuleHelper

JMS module helper contains methods for managing (locate/create/delete) JMS Module configuration entities (descriptor beans) in a given module.

A helper instance is scoped to a domain, a RG (domain level or partition) or a RGT. All operations are performed within the scope that is associated with the helper.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IJMSModuleHelper.ScopeType
static class	IJMSModuleHelper.StoreType

Method Summary

Modifier and Type	Method and Description
void	createConnectionFactory(String resourceName, String factoryName, String factoryJndiName, String targetName, JMSNamedEntityModifier modifier) Creates a JMS connection factory in the given JMS System resource module
void	createDestinationKey(String resourceName, String destinationKeyName, String property, String keyType, String sortOrder, JMSNamedEntityModifier modifier) Creates a DestinationKey Bean in the given JMS system resource module
void	createForeignConnectionFactory(String resourceName, String foreignServerName, String foreignConnectionFactoryName, String localJNDIName, String remoteJNDIName, String username, String password, JMSNamedEntityModifier modifier) Creates a foreign JMS connection factory in a given foreign server of a JMS system resource module
void	createForeignDestination(String resourceName, String foreignServerName, String foreignDestinationName, String localJNDIName, String remoteJNDIName, JMSNamedEntityModifier modifier) Creates a foreign JMS destination in a given foreign server of a JMS system resource module
void	createForeignServer(String resourceName, String foreignServerName, String targetName, JMSNamedEntityModifier modifier) Creates a foreign JMS server in a given JMS system resource module
void	createJMSServer(String jmsServerName, String targetName, String storeName) Creates a JMSServer in the given scope.
void	createJMSSystemResource(String resourceName, String targetName) Creates a JMS System resource in the given scope
void	createPersistentStore(IJMSModuleHelper.StoreType storeType, String storeName, String targetName, PersistentStoreModifier modifier) Creates a persistent store in the given scope
void	createQueue(String resourceName, String jmsServerName, String queueName, String jndiName, JMSNamedEntityModifier modifier) Creates a JMS queue in a given JMS system resource module.
void	createQuota(String resourceName, String quotaName, JMSNamedEntityModifier modifier) Creates a quota in the given JMS system resource module
void	createSAFAgent(String safAgentName, String targetName, String storeName) Creates a SAFAgent in the given scope.
void	createSAFErrorHandling(String resourceName, String safErrorHandlingName, JMSNamedEntityModifier modifier) Creates a SAF error handling in the given JMS system resource module
void	createSAFImportedDestinations(String resourceName, String safImportedDestinationsName, String safRemoteContextName, String safErrorHandlingName, String targetName, JMSNamedEntityModifier modifier) Creates a SAF imported destinations group in the given JMS system resource module
void	createSAFQueue(String resourceName, String safImportedDestinationsName, String safQueueName, String safQueueRemoteJNDIName, JMSNamedEntityModifier modifier) Creates a SAF queue in the given SAF imported destinations group
void	createSAFRemoteContext(String resourceName, String safRemoteContextName, JMSNamedEntityModifier modifier) Creates a SAF remote context in the given JMS system resource module
void	createSAFTopic(String resourceName, String safImportedDestinationsName, String safTopicName, String safTopicRemoteJNDIName, JMSNamedEntityModifier modifier) Creates a SAF topic in the given SAF imported destinations group
void	createTemplate(String resourceName, String templateName, JMSNamedEntityModifier modifier) Creates a template in the given JMS system resource module
void	createTopic(String resourceName, String jmsServerName, String topicName, String jndiName, JMSNamedEntityModifier modifier) Creates a JMS topic in the given JMS system resource module
void	createUniformDistributedQueue(String resourceName, String uniformDistributedQueueName, String jndiName, String targetName, JMSNamedEntityModifier modifier) Create a uniform distributed queue in the given JMS Module and target it as stated.
void	createUniformDistributedTopic(String resourceName, String uniformDistributedTopicName, String jndiName, String targetName, JMSNamedEntityModifier modifier) Create a uniform distributed topic in the given JMS Module and target it as stated.
void	deleteConnectionFactory(String resourceName, String factoryName) Deletes a JMS connection factory in the given JMS System resource module
void	deleteDestinationKey(String resourceName, String destinationKeyName) Deletes the destination key bean from the given
void	deleteForeignConnectionFactory(String resourceName, String foreignServerName, String foreignConnectionFactoryName) Delete a foreign connection factory from the given foreign server in a resource
void	deleteForeignDestination(String resourceName, String foreignServerName, String foreignDestinationName) Delete a foreign destination from a given foreignServer in a resource
void	deleteForeignServer(String resourceName, String foreignServerName) Delete a foreign server and all its foreign connection factories and foreign destinations.
void	deleteJMSServer(String jmsServerName) Deletes a JMSServer in the given scope.
void	deleteJMSSystemResource(String resourceName) Deletes a JMS System resource in the given scope
void	deletePersistentStore(String storeName) Deletes a persistent store
void	deleteQueue(String resourceName, String queueName) Deletes a JMS queue in a given JMS system resource module.
void	deleteQuota(String resourceName, String quotaName) Deletes a quota from the given JMS system resource module
void	deleteSAFAgent(String safAgentName) Deletes a SAFAgent in the given scope.
void	deleteSAFErrorHandling(String resourceName, String safErrorHandlingName) Delete a SAF error handling from the given JMS system resource module
void	deleteSAFImportedDestinations(String resourceName, String safImportedDestinationsName) Deletes a SAF imported destinations group and all its SAF queues and SAF topics.
void	deleteSAFQueue(String resourceName, String safImportedDestinationsName, String safQueueName) Deletes a SAF queue from the given SAF imported Destinations group.
void	deleteSAFRemoteContext(String resourceName, String safRemoteContextName) Deletes a SAF remote context from the given JMS system resource module
void	deleteSAFTopic(String resourceName, String safImportedDestinationsName, String safTopicName) Delete a SAF topic from the given SAF imported destinations group.
void	deleteTemplate(String resourceName, String templateName) Deletes a template from the given JMS system resource module
void	deleteTopic(String resourceName, String topicName) Deletes a topic from the given JMS system resource module
void	deleteUniformDistributedQueue(String resourceName, String uniformDistributedQueueName) Deletes a uniform distributed queue in the given JMS Module
void	deleteUniformDistributedTopic(String resourceName, String uniformDistributedTopicName) Deletes a uniform distributed topic in the given JMS Module
void	deployJMSServer(String jmsServerName, String targetName) Deploy a JMSServer and in turn advertise all the destinations on that JMSServer to the JNDI tree of the target server.
void	deploySAFAgent(String safAgentName, String targetName) Deploy a SAFAgent and in turn advertise all the imported destinations of that SAFAgent to the JNDI tree of the target servers/clusters.
DestinationBean[]	findAllInheritedDestinations(String templateName, JMSBean module) Returns an array of all the JMS destinations(queues/topics) that are inherited from the given Template (name)
QueueBean[]	findAllInheritedQueueBeans(String templateName, JMSBean module) Finder that returns all the QueueBeans that inherit from the given TemplateBean in a JMS Module
TopicBean[]	findAllInheritedTopicBeans(String templateName, JMSBean module) Finder that returns all the TopicBeans that inherit from the given TemplateBean in a JMS Module
void	findAndModifyEntity(String resourceName, String entityName, String entityType, JMSNamedEntityModifier modifier) Helper API to find and modify a JMS Module managed entity from the given JMS system resource.
DestinationBean	findDestinationBean(String name, JMSBean module) Finder for DestinationBean in a JMS Module
JMSSystemResourceMBean	findJMSSystemResource(String resourceName) Finder for a JMSSystemResourceMBean in the given scope
boolean	isTargetInDeploymentScope(ConfigurationMBean configBean, WebLogicMBean deploymentScope) Check if the given ConfigurationMBean is in the same scope in which the module is being deployed.
String	uddMemberJNDIName(String jmsServerName, String name) Returns the JNDI name of a Uniform Distributed Destination member, given the JNDI name of the Uniform Distributed Destination and the JMS server upon which the member is deployed or to be deployed.
String	uddMemberName(String jmsServerName, String name) Returns the member name of a Uniform Distributed Destination, given the name of the Uniform Distributed Destination and the JMS server upon which the member is deployed or to be deployed.
void	undeployJMSServer(String jmsServerName) Undeploy a JMSServer and in turn unadvertises all the destinations on that JMSServer from the JNDI tree of the target server.
void	undeploySAFAgent(String safAgentName) Undeploy a SAFAgent and in turn unadvertises all the destinations on that SAFAgent from the JNDI tree of the target server.

Method Detail

createJMSSystemResource

void createJMSSystemResource(String resourceName,
                             String targetName)
                      throws JMSException

Creates a JMS System resource in the given scope

Parameters:

resourceName - name of the resource to be created

targetName - name of the target where the JMS system resource will be targeted. Valid targeting options is [Cluster, Server] at the domain scope. It must be set to null at the RG/RGT scope.

Throws:

JMSException - if an error occurs

deleteJMSSystemResource

void deleteJMSSystemResource(String resourceName)
                      throws JMSException

Deletes a JMS System resource in the given scope

Parameters:

resourceName - name of the resource to be deleted

Throws:

JMSException - if an error occurs

createPersistentStore

void createPersistentStore(IJMSModuleHelper.StoreType storeType,
                           String storeName,
                           String targetName,
                           PersistentStoreModifier modifier)
                    throws JMSException

Creates a persistent store in the given scope

Parameters:

storeType - type of the store to be created

storeName - name of the store to be created

targetName - name of the target where the persistent store will be targeted. Valid targeting options is [Cluster, Server, MigratableTarget] at the domain scope. It must be set to null at the RG/RGT scope.

modifier - implementation of the PersistentStoreModifier used to modify the store's attribute values

Throws:

JMSException - if an error occurs

deletePersistentStore

void deletePersistentStore(String storeName)
                    throws JMSException

Deletes a persistent store

Parameters:

storeName - name of the store to be deleted

Throws:

JMSException - if an error occurs

createJMSServer

void createJMSServer(String jmsServerName,
                     String targetName,
                     String storeName)
              throws JMSException

Creates a JMSServer in the given scope.

Parameters:

jmsServerName - name of the JMSServer to be created

targetName - name of the target where the JMSServer will be targeted. Valid targeting options is [Cluster, Server, MigratableTarget] at the domain scope. Only one of the targeting options can be select. It must be set to null at the RG/RGT scope.

storeName - name of the persistent store to be used by the JMSServer

Throws:

JMSException - if an error occurs

deleteJMSServer

void deleteJMSServer(String jmsServerName)
              throws JMSException

Deletes a JMSServer in the given scope.

Parameters:

jmsServerName - name of the JMSServer to be deleted

Throws:

JMSException - if an error occurs

createConnectionFactory

void createConnectionFactory(String resourceName,
                             String factoryName,
                             String factoryJndiName,
                             String targetName,
                             JMSNamedEntityModifier modifier)
                      throws JMSException

Creates a JMS connection factory in the given JMS System resource module

Parameters:

resourceName - name of the JMS System resource in which to create the connection factory

factoryName - name of the JMS connection factory

factoryJndiName - JNDI name of the connection factory

targetName - name of the target where the connection factory will be targeted. Valid targeting options is [Cluster, Server, JMSServer] at the domain scope. Valid targeting options is [JMSServer, DEFAULT_TARGETING_ENABLED] at the RG/RGT scope.

modifier - implementation of the JMSNamedEntityModifier used to modify the connection factory's attribute values

Throws:

JMSException - if an error occurs

deleteConnectionFactory

void deleteConnectionFactory(String resourceName,
                             String factoryName)
                      throws JMSException

Deletes a JMS connection factory in the given JMS System resource module

Parameters:

resourceName - name of the JMS System resource in which to delete the connection factory

factoryName - name of the JMS connection factory

Throws:

JMSException - if an error occurs

createUniformDistributedQueue

void createUniformDistributedQueue(String resourceName,
                                   String uniformDistributedQueueName,
                                   String jndiName,
                                   String targetName,
                                   JMSNamedEntityModifier modifier)
                            throws JMSException

Create a uniform distributed queue in the given JMS Module and target it as stated.

Parameters:

resourceName - JMS resource name in which the distributed queue will be created

uniformDistributedQueueName - name of the distributed queue to be created

jndiName - the name to give the distributed queue in JNDI

targetName - name of the target where the uniform distributed queue will be targeted. Valid targeting options is [Cluster, Server, JMSServer] at the domain scope. Valid targeting options is [JMSServer, DEFAULT_TARGETING_ENABLED] at the RG/RGT scope.

modifier - implementation of the JMSNamedEntityModifier used to modify the distributed queue's attribute values

Throws:

JMSException - if an error occurs

deleteUniformDistributedQueue

void deleteUniformDistributedQueue(String resourceName,
                                   String uniformDistributedQueueName)
                            throws JMSException

Deletes a uniform distributed queue in the given JMS Module

Parameters:

resourceName - JMS resource name in which the distributed queue will be deleted

uniformDistributedQueueName - name of the distributed queue to be deleted

Throws:

JMSException - if an error occurs

createUniformDistributedTopic

void createUniformDistributedTopic(String resourceName,
                                   String uniformDistributedTopicName,
                                   String jndiName,
                                   String targetName,
                                   JMSNamedEntityModifier modifier)
                            throws JMSException

Create a uniform distributed topic in the given JMS Module and target it as stated.

Parameters:

resourceName - JMS resource name in which the distributed topic will be created

uniformDistributedTopicName - name of the distributed topic to be created

jndiName - name to give the distributed topic in JNDI

targetName - name of the target where the uniform distributed topic will be targeted. Valid targeting options is [Cluster, Server, JMSServer] at the domain scope. Valid targeting options is [JMSServer, DEFAULT_TARGETING_ENABLED] at the RG/RGT scope.

modifier - implementation of the JMSNamedEntityModifier used to modify the distributed tipic's attribute values

Throws:

JMSException - if an error occurs

deleteUniformDistributedTopic

void deleteUniformDistributedTopic(String resourceName,
                                   String uniformDistributedTopicName)
                            throws JMSException

Deletes a uniform distributed topic in the given JMS Module

Parameters:

resourceName - JMS resource name in which the distributed topic will be deleted

uniformDistributedTopicName - name of the distributed topic to be deleted

Throws:

JMSException - if an error occurs

findJMSSystemResource

JMSSystemResourceMBean findJMSSystemResource(String resourceName)
                                      throws JMSException

Finder for a JMSSystemResourceMBean in the given scope

Parameters:

resourceName - name of JMSSystemResourceMBean to be found

Returns:

JMSSystemResourceMBean

Throws:

JMSException - if an error occurs

deployJMSServer

void deployJMSServer(String jmsServerName,
                     String targetName)
              throws JMSException

Deploy a JMSServer and in turn advertise all the destinations on that JMSServer to the JNDI tree of the target server. This method is for DOMAIN scope only

Parameters:

jmsServerName - name of the JMS server.

targetName - name of the target where the persistent store will be targeted. Valid targeting options is [Cluster, Server, MigratableTarget] at the domain scope. Only one of the targeting options can be select. It must be set to null at the RG/RGT scope.

Throws:

JMSException - if an error occurs

undeployJMSServer

void undeployJMSServer(String jmsServerName)
                throws JMSException

Undeploy a JMSServer and in turn unadvertises all the destinations on that JMSServer from the JNDI tree of the target server. This method is for DOMAIN scope only

Parameters:

jmsServerName - name of the JMS server.

Throws:

JMSException - if an error occurs

createQueue

void createQueue(String resourceName,
                 String jmsServerName,
                 String queueName,
                 String jndiName,
                 JMSNamedEntityModifier modifier)
          throws JMSException

Creates a JMS queue in a given JMS system resource module.

Parameters:

resourceName - name of the JMSSystemResource to modify

jmsServerName - name of the JMS server

queueName - name of the JMS queue to be created

jndiName - name used to lookup the destination within the JNDI namespace.

modifier - implementation of the JMSNamedEntityModifier used to modify the queue's attribute values

Throws:

JMSException - if an error occurs

deleteQueue

void deleteQueue(String resourceName,
                 String queueName)
          throws JMSException

Deletes a JMS queue in a given JMS system resource module.

Parameters:

resourceName - name of the JMSSystemResource to modify

queueName - name of the JMS queue to be deleted

Throws:

JMSException - if an error occurs

createSAFAgent

void createSAFAgent(String safAgentName,
                    String targetName,
                    String storeName)
             throws JMSException

Creates a SAFAgent in the given scope.

Parameters:

safAgentName - name of the SAFAgent to be created

targetName - name of the target where the SAFAgent will be targeted. Valid targeting options is [Cluster, Server] at the domain scope. It must be set to null at the RG/RGT scope.

storeName - name of the persistent store to be used by the SAFAgent

Throws:

JMSException - if an error occurs

deleteSAFAgent

void deleteSAFAgent(String safAgentName)
             throws JMSException

Deletes a SAFAgent in the given scope.

Parameters:

safAgentName - name of the SAFAgent to be deleted

Throws:

JMSException - if an error occurs

findDestinationBean

DestinationBean findDestinationBean(String name,
                                    JMSBean module)

Finder for DestinationBean in a JMS Module

Parameters:

name - Name of DestinationBean to be found

module - Root Bean of JMSModule

Returns:

QueueBean

createQuota

void createQuota(String resourceName,
                 String quotaName,
                 JMSNamedEntityModifier modifier)
          throws JMSException

Creates a quota in the given JMS system resource module

Parameters:

resourceName - name of the JMS system source module

quotaName - name of the quota to be created

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteQuota

void deleteQuota(String resourceName,
                 String quotaName)
          throws JMSException

Deletes a quota from the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

quotaName - name of the quota to be deleted

Throws:

JMSException - if an error occurs

createSAFErrorHandling

void createSAFErrorHandling(String resourceName,
                            String safErrorHandlingName,
                            JMSNamedEntityModifier modifier)
                     throws JMSException

Creates a SAF error handling in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

safErrorHandlingName - name of the SAF error handling to be created

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteSAFErrorHandling

void deleteSAFErrorHandling(String resourceName,
                            String safErrorHandlingName)
                     throws JMSException

Delete a SAF error handling from the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

safErrorHandlingName - name of the SAF error handling to be deleted

Throws:

JMSException - if an error occurs

createSAFImportedDestinations

void createSAFImportedDestinations(String resourceName,
                                   String safImportedDestinationsName,
                                   String safRemoteContextName,
                                   String safErrorHandlingName,
                                   String targetName,
                                   JMSNamedEntityModifier modifier)
                            throws JMSException

Creates a SAF imported destinations group in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - name of the SAF imported destinations group to be created

safRemoteContextName - name of the SAF remote context

safErrorHandlingName - name of the SAF error handling

targetName - name of the target where the SAF imported destinations group will be targeted. Valid targeting options is [Cluster, Server, SAFAgent] at the domain scope. Valid targeting options is [SAFAgent, DEFAULT_TARGETING_ENABLED] at the RG/RGT scope.

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteSAFImportedDestinations

void deleteSAFImportedDestinations(String resourceName,
                                   String safImportedDestinationsName)
                            throws JMSException

Deletes a SAF imported destinations group and all its SAF queues and SAF topics.

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - the name of the SAF imported destinations group to be deleted

Throws:

JMSException - if an error occurs

createSAFQueue

void createSAFQueue(String resourceName,
                    String safImportedDestinationsName,
                    String safQueueName,
                    String safQueueRemoteJNDIName,
                    JMSNamedEntityModifier modifier)
             throws JMSException

Creates a SAF queue in the given SAF imported destinations group

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - name of the SAF imported destinations group in which to create the SAF queue

safQueueName - name of the SAF queue to be created

safQueueRemoteJNDIName - JNDI name of the remote queue

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteSAFQueue

void deleteSAFQueue(String resourceName,
                    String safImportedDestinationsName,
                    String safQueueName)
             throws JMSException

Deletes a SAF queue from the given SAF imported Destinations group.

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - the name of the SAF imported destinations group from which to delete the SAF queue

safQueueName - name of the SAF queue to be deleted

Throws:

JMSException - if an error occurs

createSAFRemoteContext

void createSAFRemoteContext(String resourceName,
                            String safRemoteContextName,
                            JMSNamedEntityModifier modifier)
                     throws JMSException

Creates a SAF remote context in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

safRemoteContextName - name of the SAF remote context

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteSAFRemoteContext

void deleteSAFRemoteContext(String resourceName,
                            String safRemoteContextName)
                     throws JMSException

Deletes a SAF remote context from the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

safRemoteContextName - name of the SAF remote context to be deleted

Throws:

JMSException - if an error occurs

createSAFTopic

void createSAFTopic(String resourceName,
                    String safImportedDestinationsName,
                    String safTopicName,
                    String safTopicRemoteJNDIName,
                    JMSNamedEntityModifier modifier)
             throws JMSException

Creates a SAF topic in the given SAF imported destinations group

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - name of the SAF imported destinations group in which to create the SAF topic

safTopicName - name of the SAF topic

safTopicRemoteJNDIName - JNDI name of the remote topic

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteSAFTopic

void deleteSAFTopic(String resourceName,
                    String safImportedDestinationsName,
                    String safTopicName)
             throws JMSException

Delete a SAF topic from the given SAF imported destinations group.

Parameters:

resourceName - name of the JMS system resource module

safImportedDestinationsName - name of the SAF imported destinations group from which to delete the SAF topic

safTopicName - name of the SAF topic to be deleted

Throws:

JMSException - if an error occurs

createTemplate

void createTemplate(String resourceName,
                    String templateName,
                    JMSNamedEntityModifier modifier)
             throws JMSException

Creates a template in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

templateName - name of the template to be created

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteTemplate

void deleteTemplate(String resourceName,
                    String templateName)
             throws JMSException

Deletes a template from the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

templateName - name of the template to be deleted

Throws:

JMSException - if an error occurs

createTopic

void createTopic(String resourceName,
                 String jmsServerName,
                 String topicName,
                 String jndiName,
                 JMSNamedEntityModifier modifier)
          throws JMSException

Creates a JMS topic in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

jmsServerName - name of the JMS server

topicName - name of the JMS topic to be created

jndiName - name used to lookup the destination within the JNDI namespace

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteTopic

void deleteTopic(String resourceName,
                 String topicName)
          throws JMSException

Deletes a topic from the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module from which the topic will be deleted

topicName - name of the topic to be deleted

Throws:

JMSException - if an error occurs

deploySAFAgent

void deploySAFAgent(String safAgentName,
                    String targetName)
             throws JMSException

Deploy a SAFAgent and in turn advertise all the imported destinations of that SAFAgent to the JNDI tree of the target servers/clusters. This method is for DOMAIN scope only

Parameters:

safAgentName - name of the SAFAgent

targetName - name of the target where the SAFAgent will be targeted. Valid targeting options is [Cluster, Server] at the domain scope. It must be set to null at the RG/RGT scope.

Throws:

JMSException - if an error occurs

undeploySAFAgent

void undeploySAFAgent(String safAgentName)
               throws JMSException

Undeploy a SAFAgent and in turn unadvertises all the destinations on that SAFAgent from the JNDI tree of the target server. This method is for DOMAIN scope only

Parameters:

safAgentName - name of the SAFAgent.

Throws:

JMSException - if an error occurs

isTargetInDeploymentScope

boolean isTargetInDeploymentScope(ConfigurationMBean configBean,
                                  WebLogicMBean deploymentScope)

Check if the given ConfigurationMBean is in the same scope in which the module is being deployed.

Parameters:

configBean - the configuration bean whose scope has to be verified.

deploymentScope - the scope of the deployment, used to decide the the scope of the module

Returns:

true if the scopes match and false otherwise.

uddMemberName

String uddMemberName(String jmsServerName,
                     String name)

Returns the member name of a Uniform Distributed Destination, given the name of the Uniform Distributed Destination and the JMS server upon which the member is deployed or to be deployed.

Parameters:

jmsServerName - configured name of a JMS Server

name - configured name of a Uniform Distributed Destination

Returns:

String member name

uddMemberJNDIName

String uddMemberJNDIName(String jmsServerName,
                         String name)

Returns the JNDI name of a Uniform Distributed Destination member, given the JNDI name of the Uniform Distributed Destination and the JMS server upon which the member is deployed or to be deployed.

Parameters:

jmsServerName - configured name of a JMS Server

name - configured JNDI name of a Uniform Distributed Destination

Returns:

String JNDI name of member

createDestinationKey

void createDestinationKey(String resourceName,
                          String destinationKeyName,
                          String property,
                          String keyType,
                          String sortOrder,
                          JMSNamedEntityModifier modifier)
                   throws JMSException

Creates a DestinationKey Bean in the given JMS system resource module

Parameters:

resourceName - name of the JMS system resource module

destinationKeyName - name of the destination key

property - name of the header property

keyType - type of the header property

sortOrder - sorting order

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteDestinationKey

void deleteDestinationKey(String resourceName,
                          String destinationKeyName)
                   throws JMSException

Deletes the destination key bean from the given

Parameters:

resourceName - name of the JMS system resource

destinationKeyName - name of the destination key

Throws:

JMSException - if an error occurs

createForeignServer

void createForeignServer(String resourceName,
                         String foreignServerName,
                         String targetName,
                         JMSNamedEntityModifier modifier)
                  throws JMSException

Creates a foreign JMS server in a given JMS system resource module

Parameters:

resourceName - name of the JMS System resource in which to create the foreign server

foreignServerName - name of the JMS foreign server

targetName - name of the target where the foreign server will be targeted. Valid targeting options is [Cluster, Server, JMSServer] at the domain scope. Valid targeting options is [JMSServer, DEFAULT_TARGETING_ENABLED] at the RG/RGT scope.

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteForeignServer

void deleteForeignServer(String resourceName,
                         String foreignServerName)
                  throws JMSException

Delete a foreign server and all its foreign connection factories and foreign destinations.

Parameters:

resourceName - JMS resource name from where the foreign server will be deleted

foreignServerName - the name of the foreign server to delete

Throws:

JMSException - if an error occurs

createForeignConnectionFactory

void createForeignConnectionFactory(String resourceName,
                                    String foreignServerName,
                                    String foreignConnectionFactoryName,
                                    String localJNDIName,
                                    String remoteJNDIName,
                                    String username,
                                    String password,
                                    JMSNamedEntityModifier modifier)
                             throws JMSException

Creates a foreign JMS connection factory in a given foreign server of a JMS system resource module

Parameters:

resourceName - name of the JMS System resource

foreignServerName - name of the JMS foreign server

foreignConnectionFactoryName - name of the JMS foreign connection factory to create

localJNDIName - local JNDI name of name foreign connection factory

remoteJNDIName - remote JNDI name of the foreign connection factory

username - user name to create initial context

password - password to create initial context

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteForeignConnectionFactory

void deleteForeignConnectionFactory(String resourceName,
                                    String foreignServerName,
                                    String foreignConnectionFactoryName)
                             throws JMSException

Delete a foreign connection factory from the given foreign server in a resource

Parameters:

resourceName - JMS resource name from where the foreign server will be deleted

foreignServerName - the name of the foreign server from which to delete

foreignConnectionFactoryName - the name of the foreign connection factory

Throws:

JMSException - if an error occurs

createForeignDestination

void createForeignDestination(String resourceName,
                              String foreignServerName,
                              String foreignDestinationName,
                              String localJNDIName,
                              String remoteJNDIName,
                              JMSNamedEntityModifier modifier)
                       throws JMSException

Creates a foreign JMS destination in a given foreign server of a JMS system resource module

Parameters:

resourceName - name of the JMS System resource

foreignServerName - name of the JMS foreign server

foreignDestinationName - name of the JMS foreign destination to create

localJNDIName - local JNDI name of name foreign destination

remoteJNDIName - remote JNDI name of the foreign destination

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs

deleteForeignDestination

void deleteForeignDestination(String resourceName,
                              String foreignServerName,
                              String foreignDestinationName)
                       throws JMSException

Delete a foreign destination from a given foreignServer in a resource

Parameters:

resourceName - JMS resource name from where the foreign server will be deleted

foreignServerName - the name of the foreign server from which to delete

foreignDestinationName - the name of the foreign destination

Throws:

JMSException - if an error occurs

findAllInheritedDestinations

DestinationBean[] findAllInheritedDestinations(String templateName,
                                               JMSBean module)

Returns an array of all the JMS destinations(queues/topics) that are inherited from the given Template (name)

Parameters:

templateName - from which the destinations inherit

module - in which to find the inherited destinations

Returns:

array of destinations inherited from the given template

See Also:

DestinationBean

findAllInheritedQueueBeans

QueueBean[] findAllInheritedQueueBeans(String templateName,
                                       JMSBean module)

Finder that returns all the QueueBeans that inherit from the given TemplateBean in a JMS Module

Parameters:

templateName - Name of TemplateBean to be found

module - Root Bean of JMSModule

Returns:

QueueBean[]

See Also:

QueueBean

findAllInheritedTopicBeans

TopicBean[] findAllInheritedTopicBeans(String templateName,
                                       JMSBean module)

Finder that returns all the TopicBeans that inherit from the given TemplateBean in a JMS Module

Parameters:

templateName - Name of TemplateBean to be found

module - Root Bean of JMSModule

Returns:

TopicBean[]

See Also:

TopicBean

findAndModifyEntity

void findAndModifyEntity(String resourceName,
                         String entityName,
                         String entityType,
                         JMSNamedEntityModifier modifier)
                  throws JMSException

Helper API to find and modify a JMS Module managed entity from the given JMS system resource.

Parameters:

resourceName - name of the JMS system resource to look for the entity

entityName - name of the entity to be found and modified

entityType - represents the Bean type, for example, QueueBean type shall be specified as "Queue"

modifier - implementation of the JMSNamedEntityModifier used to modify the entity's attribute values

Throws:

JMSException - if an error occurs