JCAManagement

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

The JCAManagement .includes the following commands:

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

copyResourceAdapter

Create a Java 2 Connector (J2C) resource adapter under the scope specified.

Target object:

J2C Resource Adapter object ID

Parameters and return values

-name

Indicates the name of the new J2C resource adapter. This parameter is required.

-scope

Indicates the scope object ID. Required.

-useDeepCopy

If true, all of the J2C connection factory, J2C activation specification, and J2C administrative 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}]
• Jython string:
  AdminTask.copyResourceAdapter(ra, '[-name newRA -scope scope]')
• Jython list:
  AdminTask.copyResourceAdapter(ra, ['-name', 'newRA', '-scope', 'scope'])

Interactive mode example usage:

• Jacl:
  $AdminTask copyResourceAdapter {-interactive}
• Jython:
  AdminTask.copyResourceAdapter('-interactive')

createJ2CActivationSpec

Create a Java 2 Connector (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 specification for the J2C activation specification to be created. Use this parameter to identify the activation specification template for the J2C resource adapter specified.

-name

Indicates the name of the J2C activation specification that we are creating.

-jndiName

Indicates the name of the JNDI.

-destinationJndiName

Indicates the name of the JNDI of corresponding destination.

-authenticationAlias

Indicates the authentication 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 }
• Jython string:
  AdminTask.createJ2CActivationSpec(ra, '[-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener]')
• 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 administrative object under a resource adapter with attributes specified. Use the administrative object interface to indicate the administrative object 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

Indicates the name of the administrative object.

-jndiName

Name of the 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}
• Jython string:
  AdminTask.createJ2CAdminObject(ra, '[-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01]')
• 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

Indicates the name of the connection factory.

-jndiName

Indicates the name of the JNDI.

-description

Description of the created J2C connection factory.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask createJ2CConnectionFactory $ra {-connectionFactoryInterface javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1}
• Jython string:
  AdminTask.createJ2CConnectionFactory(ra, '[-connectionFactoryInterface javax.sql.DataSource -name J2CCF1 -jndi Name eis/J2CCF1]')
• Jython list:
  AdminTask.createJ2CConnectionFactory(ra, ['-connectionFactoryInterface', 'javax.sql.DataSource', '-name', 'J2CCF1', '-jndiName', 'eis/J2CCF1'])

Interactive mode example usage:

• Jacl:
  $AdminTask createJ2CConnectionFactory {-interactive}
• Jython:
  AdminTask.createJ2CConnectionFactory('-interactive')

listAdminObjectInterfaces

List the administrative 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 administrative object interfaces.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listAdminObjectInterfaces $ra
• Jython string:
  AdminTask.listAdminObjectInterfaces(ra)
• 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
• Jython string:
  AdminTask.listConnectionFactoryInterfaces(ra)
• Jython list:
  AdminTask.listConnectionFactoryInterfaces(ra)

Interactive mode example usage:

• Jacl:
  $AdminTask listConnectionFactoryInterfaces {-interactive}
• Jython:
  AdminTask.listConnectionFactoryInterfaces('-interactive')

listJ2CActivationSpecs

List the activation specifications 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}
• Jython string:
  AdminTask.listJ2CActivationSpecs(ra, '[-messageListener Type javax.jms.MessageListener]')
• 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 administrative 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 we want to list. Required.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listJ2CAdminObjects $ra {-adminObjectInterface fvt.adaptor.message.FVTMessageProvider}
• 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

Indicates the name of the connection factory to list. Required.

Examples

Batch mode example usage:

• Jacl:
  $AdminTask listJ2CConnectionFactories $ra {-connectionFactoryInterface javax.sql.DataSource}
• Jython string:
  AdminTask.listJ2CConnectionFactories(ra, '[-connectionFactoryInterface javax.sql.DataSource]')
• 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
• Jython string:
  AdminTask.listMessageListenerTypes(ra)
• Jython list:
  AdminTask.listMessageListenerTypes(ra)

Interactive mode example usage:

• Jacl:
  $AdminTask listMessageListenerTypes {-interactive}
• Jython:
  AdminTask.listMessageListenerTypes('-interactive')

Configure new J2C administrative objects

Configure new J2C activation specifications

Configure new J2C resource adapters

wsadmin AdminTask

Commands for the AdminTask object