JCAManagement

Use the Jython or Jacl scripting languages to configure messaging with scripting. The commands and parameters in the JCA management group can be used to create and manage resource adapters, Java EE Connector Architecture (J2C) activation specifications, administrative objects, connection factories, admin object interfaces, and message listener types.

The JCAManagement includes the following commands:

• copyResourceAdapter
• createJ2CActivationSpec
• createJ2CAdminObject
• createJ2CConnectionFactory
• listAdminObjectInterfaces
• listConnectionFactoryInterfaces
• listJ2CActivationSpecs
• listJ2CAdminObjects
• listJ2CConnectionFactories
• listMessageListenerTypes

 

copyResourceAdapter

Use the copyResourceAdapter command to create a J2C resource adapter under the scope specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

-name

Name of the new J2C resource adapter. Required.

-scope

Scope object ID. Required.

-useDeepCopy

If we set this parameter to true, all of the J2C connection factory, J2C activation specification, and J2C admin objects will be copied to the new J2C resource adapter (deep copy). If we set this parameter to false, the objects are not created (shallow copy). The default is false.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask copyResourceAdapter $ra [subst {-name newRA -scope $scope}]
  

• Use Jython string:

  AdminTask.copyResourceAdapter(ra, '[-name newRA -scope scope]') 
  

• Use Jython list:

  AdminTask.copyResourceAdapter(ra, ['-name', 'newRA', '-scope', 'scope']) 
  

Interactive mode example usage:

• Jacl...

  $AdminTask copyResourceAdapter {-interactive} 
  

• Jython...

  AdminTask.copyResourceAdapter('-interactive') 
  

 

createJ2CActivationSpec

Create a J2C activation specification under a J2C resource adapter and the attributes specified. Use the messageListenerType parameter to indicate the activation specification that is defined for the J2C resource adapter.

Target object: J2C Resource Adapter object ID

Parameters and return values

- messageListenerType

Identifies the activation spec for the J2C activation specification to be created. Use this parameter to identify the activation specification template for the J2C resource adapter specified.

-name

Name of the J2C activation spec that you are creating.

-jndiName

Name of the Java Naming and Directory Interface (JNDI).

-destinationJndiName

Name of the Java Naming and Directory Interface (JNDI) of corresponding destination.

-authenticationAlias

A alias of the J2C activation specification that we are creating.

-description

Description of the created J2C activation specification.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask createJ2CActivationSpec $ra {-name J2CAct Spec -jndiName eis/ActSpec1 
   -messageListenerType javax.jms.MessageListener } 
  

• Use Jython string:

  AdminTask.createJ2CActivationSpec(ra, '[-name J2CActSpec -jndiName eis/ActSpec1 
   -messageListenerType javax.jms.MessageListener]') 
  

• Use Jython list:

  AdminTask.createJ2CActivationSpec(ra, ['-name', 'J2CActSpec', '-jndiName', 'eis/ActSpec1', 
   '-messageListenerType', 'javax.jms.MessageListener']) 
  

Interactive mode example usage:

• Jacl...

  $AdminTask createJ2CActivationSpec {-interactive} 
  

• Jython...

  AdminTask.createJ2CActivationSpec('-interactive')
  

 

createJ2CAdminObject

Create an admin object under a resource adapter with attributes specified. Use the admin object interface to indicate the admin object that is defined in the resource adapter.

Target object: J2C Resource Adapter object ID

Parameters and return values

-adminObjectInterface

Administrative object interface to identify the administrative object for the resource adapter specified. Required.

-name

Name of the admin object.

-jndiName

Name of the Java Naming and Directory Interface (JNDI).

-description

Description of the created J2C admin object.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask createJ2CAdminObject $ra {-adminObjectInterface fvt.adapter.message.FVTMessageProvider 
   -name J2CA01 -jndiName eis/J2CA01} 
  

• Use Jython string:

  AdminTask.createJ2CAdminObject(ra, '[-adminObjectInterface fvt.adapter.message.FVTMessageProvider 
   -name J2CA01 -jndiName eis/J2CA01]')
  

• Use Jython list:

  AdminTask.createJ2CAdminObject(ra, ['-adminObjectInterface', 
   'fvt.adapter.message.FVTMessageProvider', '-name', 'J2CA01', '-jndiName', 'eis/J2CA01'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask createJ2CAdminObject {-interactive} 
  

• Jython...

  AdminTask.createJ2CAdminObject('-interactive')
  

 

createJ2CConnectionFactory

Create a Java 2 connection factory under a Java 2 resource adapter and the attributes specified. Use the connection factory interfaces to indicate the connection definitions defined for the Java 2 resource adapter.

Target object: J2C Resource Adapter object ID

Parameters and return values

-connectionFactoryInterface

Identifies the connection definition for the Java 2 resource adapter specified. Required.

-name

Name of the connection factory.

-jndiName

Name of the Java Naming and Directory Interface (JNDI).

-description

Description of the created J2C connection factory.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask createJ2CConnectionFactory $ra {-connectionFactoryInterfaces javax.sql.DataSource 
  -name J2CCF1 -jndiName eis/J2CCF1}
  

• Use Jython string:

  AdminTask.createJ2CConnectionFactory(ra, '[-connectionFactoryInterfaces javax.sql.DataSource 
  -name J2CCF1 -jndi Name eis/J2CCF1]')
  

• Use Jython list:

  AdminTask.createJ2CConnectionFactory(ra, ['-connectionFactoryInterfaces', 
   'javax.sql.DataSource', '-name', 'J2CCF1', '-jndiName', 'eis/J2CCF1'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask createJ2CConnectionFactory {-interactive} 
  

• Jython...

  AdminTask.createJ2CConnectionFactory('-interactive')
  

 

listAdminObjectInterfaces

List the admin object interfaces defined under the resource adapter specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

• Parameters: None

• Returns: A list of admin object interfaces.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listAdminObjectInterfaces $ra
  

• Use Jython string:

  AdminTask.listAdminObjectInterfaces(ra)
  

• Use Jython list:

  AdminTask.listAdminObjectInterfaces(ra)
  

Interactive mode example usage:

• Jacl...

  $AdminTask listAdminObjectInterfaces {-interactive} 
  

• Jython...

  AdminTask.listAdminObjectInterfaces('-interactive')
  

 

listConnectionFactoryInterfaces

List all of the connection factory interfaces defined under the Java 2 connector resource adapter specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

• Parameters: None

• Returns: A list of connection factory interfaces.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listConnectionFactoryInterfaces $ra
  

• Use Jython string:

  AdminTask.listConnectionFactoryInterfaces(ra)
  

• Use Jython list:

  AdminTask.listConnectionFactoryInterfaces(ra)
  

Interactive mode example usage:

• Jacl...

  $AdminTask listConnectionFactoryInterfaces {-interactive} 
  

• Jython...

  AdminTask.listConnectionFactoryInterfaces('-interactive') 
  

 

listJ2CActivationSpecs

List the activation specifications that are contained under the resource adapter and message listener type specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

-messageListenerType

Message listener type for the resource adapter for which we are making a list. Required.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listJ2CActivationSpecs $ra {-messageListener Type javax.jms.MessageListener}
  

• Use Jython string:

  AdminTask.listJ2CActivationSpecs(ra, '[-messageListener Type javax.jms.MessageListener]')
  

• Use Jython list:

  AdminTask.listJ2CActivation Specs(ra, ['-messageListener Type', 'javax.jms.MessageListener'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask listJ2CActivationSpecs {-interactive} 
  

• Jython...

  AdminTask.listJ2CActivationSpecs('-interactive')
  

 

listJ2CAdminObjects

List admin objects that contain the administrative object interface specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

-adminObjectInterface

Administrative object interface for which you want to list. Required.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listJ2CAdminObjects $ra {-adminObjectInterface 
   fvt.adaptor.message.FVTMessageProvider}
  

• Use Jython string:

  AdminTask.listJ2CAdminObjects(ra, '[-adminObjectInterface 
   fvt.adaptor.message.FVTMessageProvider]')
  

Interactive mode example usage:

• Jacl...

  $AdminTask listJ2CAdminObjects {-interactive} 
  

• Jython...

  AdminTask.listJ2CAdminObjects('-interactive')
  

 

listJ2CConnectionFactories

List the Java 2 connector connection factories under the resource adapter and connection factory interface specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

-connectionFactoryInterface

Name of the connection factory to list. Required.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listJ2CConnectionFactories $ra {-connectionFactoryInterface javax.sql.DataSource}
  

• Use Jython string:

  AdminTask.listJ2CConnectionFactories(ra, '[-connectionFactoryInterface javax.sql.DataSource]')
  

• Use Jython list:

  AdminTask.listJ2CConnectionFactories(ra, ['-connectionFactoryInterface', 
   'javax.sql.DataSource'])
  

Interactive mode example usage:

• Jacl...

  $AdminTask listJ2CConnectionFactories {-interactive} 
  

• Jython...

  AdminTask.listJ2CConnectionFactories('-interactive') 
  

 

listMessageListenerTypes

List the message listener types defined under the resource adapter specified.

Target object: J2C Resource Adapter object ID

Parameters and return values

• Parameters: None

• Returns: A list of message listener types.

Examples

Batch mode example usage:

• Jacl...

  $AdminTask listMessageListenerTypes $ra
  

• Use Jython string:

  AdminTask.listMessageListenerTypes(ra)
  

• Use Jython list:

  AdminTask.listMessageListenerTypes(ra)
  

Interactive mode example usage:

• Jacl...

  $AdminTask listMessageListenerTypes {-interactive} 
  

• Jython...

  AdminTask.listMessageListenerTypes('-interactive') 
  

---

 

Related tasks

Set new J2C admin objects using scripting
Set new J2C activation specifications using scripting
Set new J2C resource adapters using scripting
Use AdminTask for scripted administration

 

Related

Commands for AdminTask