Commands for the JCA management group of the AdminTask object

Commands for the JCA management group of the AdminTask object

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 2 Connectory (J2C) activation specifications, administrative objects, connection factories, administrative object interfaces, and message listener types.
For more information about the AdminTask object, see the Commands for the AdminTask object article.
The following commands are available for the JCA management group of the AdminTask object:
Command name: Description: Target object: Parameters and return values: Examples:
copyResourceAdapter
Use the copyResourceAdapter command to create a Java 2 Connector (J2C) resource adapter under the scope that you specify.
J2C Resource Adapter object ID

Parameters:

- name

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

- scope

Indicates the scope object ID. This parameter is required.

- useDeepCopy

If you set this parameter to 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 you set this parameter to false, the objects are not created (shallow copy). The default is false.

Returns: J2C resource adapter object ID
Batch mode example usage:
Using Jacl
$AdminTask copyResourceAdapter $ra [subst {-name newRA -scope $scope}]
Using Jython string
AdminTask.copyResourceAdapter(ra, '[-name newRA -scope scope]')
Interactive mode example usage:
Using Jacl
$AdminTask copyResourceAdapter {-interactive}
Using Jython string
AdminTask.copyResourceAdapter ('[-interactive]')
createJ2CActivationSpec
Use the createJ2CActivationSpec command to create a Java 2 Connector (J2C) activation specification under a J2C resource adapter and the attributes that you specify. Use the messageListenerType parameter to indicate the activation specification that is defined for the J2C resource adapter.
J2C Resource Adapter object ID

Parameters:

- 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 that you specify.

- name

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

- jndiName

Indicates the name of the Java Naming and Directory Interface (JNDI).

- destinationJndiName

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

- authenticationAlias

Indicates the authentication alias of the J2C activation specification that you are creating.

- description

Description of the created J2C activation specification.

Returns: J2CActivationSpec object ID
Batch mode example usage:
Using Jacl
$AdminTask createJ2CActivationSpec  $ra {-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener }
Using Jython string
AdminTask.createJ2CActivationSpec(ra, '[-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener]')
Interactive mode example usage:
Using Jacl
$AdminTask createJ2CActivationSpec {-interactive}
Using Jython string
AdminTask.createJ2CActivationSpec ('[-interactive]')
createJ2CAdminObject

Use the createJ2CAdminObject command to create an administrative object under a resource adapter with attributes that you specify. Use the administrative object interface to indicate the administrative object that is defined in the resource adapter.
J2C Resource Adapter object ID

Parameters:

-adminObjectInterface

administrative object interface to identify the administrative object for the resource adapter that you specify. This parameter is required.

-name

Indicates the name of the administrative object.

-jndiName

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

-description

Description of the created J2C admin object.

Returns: J2CAdminObject object ID
Batch mode example usage:
Using Jacl
$AdminTask createJ2CAdminObject $ra {-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01} 
Using Jython string
AdminTask.createJ2CAdminObject(ra, '[-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01]')
Interactive mode example usage:
Using Jacl
$AdminTask createJ2CAdminObject {-interactive}
Using Jython string
AdminTask.createJ2CAdminObject ('[-interactive]')
createJ2CConnectionFactory

Use the createJ2CConnectionFactory command to create a Java 2 connection factory under a Java 2 resource adapter and the attributes that you specify. Use the connection factory interfaces to indicate the connection definitions that are defined for the Java 2 resource adapter.
J2C Resource Adapter object ID

Parameters:

-connectionFactoryInterface

Identifies the connection definition for the Java 2 resource adapter that you specify. This parameter is required.

-name

Indicates the name of the connection factory.

-jndiName

Indicates the name of the Java Naming and Directory Interface (JNDI).

-description

Description of the created J2C connection factory.

Returns: The J2C connection factory object ID.
Batch mode example usage:
Using Jacl
$AdminTask createJ2CConnectionFactory $ra {-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1}
Using Jython string
AdminTask.createJ2CConnectionFactory(ra, '[-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1]')
Interactive mode example usage:
Using Jacl
$AdminTask createJ2CConnectionFactory {-interactive}
Using Jython string
AdminTask.createJ2CConnectionFactory ('[-interactive]')
listAdminObjectInterfaces

Use the listAdminObjectInterfaces command to list the administrative object interfaces that are defined under the resource adapter that you specify.
J2C Resource Adapter object ID

Parameters: None
Returns: A list of administrative object interfaces.
Batch mode example usage:
Using Jacl
$AdminTask listAdminObjectInterfaces $ra
Using Jython string
AdminTask.listAdminObjectInterfaces(ra)
Interactive mode example usage:
Using Jacl
$AdminTask listAdminObjectInterfaces {-interactive}
Using Jython string
AdminTask.listAdminObjectInterfaces ('[-interactive]')
listConnectionFactoryInterfaces

Use the listConnectionFactoryInterfaces command to list all of the connection factory interfaces that are defined under the Java 2 connector resource adapter that you specify.
J2C Resource Adapter object ID

Parameters: None
Returns: A list of connection factory interfaces.
Batch mode example usage:
Using Jacl
$AdminTask listConnectionFactoryInterfaces $ra
Using Jython string
AdminTask.listConnectionFactoryInterfaces(ra)
Interactive mode example usage:
Using Jacl
$AdminTask listConnectionFactoryInterfaces {-interactive}
Using Jython string
AdminTask.listConnectionFactoryInterfaces ('[-interactive]')
listJ2CActivationSpecs

Use the listJ2CActivationSpecs command to list the activation specifications that are contained under the resource adapter and message listener type that you specify.
J2C Resource Adapter object ID

Parameters:

-messageListenerType

message listener type for the resource adapter for which you are making a list. This parameter is required.

Returns: A list of activation specifications that has specified messageListener type.
Batch mode example usage:
Using Jacl
$AdminTask listJ2CActivationSpecs $ra {-messageListenerType javax.jms.MessageListener}
Using Jython string
AdminTask.listJ2CActivationSpecs(ra, '[-messageListenerType javax.jms.MessageListener]')
Interactive mode example usage:
Using Jacl
$AdminTask listJ2CActivationSpecs {-interactive}
Using Jython string
AdminTask.listJ2CActivationSpecs ('[-interactive]')
listJ2CAdminObjects

Use the listJ2CAdminObjects command to list administrative objects that contain the administrative object interface that you specify.
J2C Resource Adapter object ID

Parameters:

-adminObjectInterface

administrative object interface for which you want to list. This parameter is required.

Returns: A list of administrative objects that has specified adminObjectInterface.
Batch mode example usage:
Using Jacl
$AdminTask listJ2CAdminObjects $ra {-adminObjectInterface fvt.adaptor.message.FVTMessageProvider}
Using Jython string
AdminTask.listJ2CAdminObjects(ra, '[-adminObjectInterface fvt.adaptor.message.FVTMessageProvider]')
Interactive mode example usage:
Using Jacl
$AdminTask listJ2CAdminObjects {-interactive}
Using Jython string
AdminTask.listJ2CAdminObjects ('[-interactive]')
listJ2CConnectionFactories

Use the listJ2CConnectionFactories command to list the Java 2 connector connection factories under the resource adapter and connection factory interface that you specify.
J2C Resource Adapter object ID

Parameters:

-connectionFactoryInterface

Indicates the name of the connection factory that you want to list. This parameter is required.

Returns: A list of J2C connectionFactory that has the specified connectionFactoryInterface.
Batch mode example usage:
Using Jacl
$AdminTask listJ2CConnectionFactories $ra {-connectionFactoryInterface javax.sql.DataSource}
Using Jython string
AdminTask.listJ2CConnectionFactories(ra, '[-connectionFactoryInterface javax.sql.DataSource]')
Interactive mode example usage:
Using Jacl
$AdminTask listJ2CConnectionFactories {-interactive}
Using Jython string
AdminTask.listJ2CConnectionFactories ('[-interactive]')
listMessageListenerTypes

Use the listMessageListenerTypes command to list the message listener types that are defined under the resource adapter that you specify.
J2C Resource Adapter object ID

Parameters: None
Returns: A list of message listener types.
Batch mode example usage:
Using Jacl
$AdminTask listMessageListenerTypes $ra
Using Jython string
AdminTask.listMessageListenerTypes(ra)
Interactive mode example usage:
Using Jacl
$AdminTask listMessageListenerTypes {-interactive}
Using Jython string
AdminTask.listMessageListenerTypes ('[-interactive]')
Related tasks
Using the AdminTask object for scripted administration Related reference
Commands for the AdminTask object

Command name:	Description:	Target object:	Parameters and return values:	Examples:
copyResourceAdapter	Use the copyResourceAdapter command to create a Java 2 Connector (J2C) resource adapter under the scope that you specify.	J2C Resource Adapter object ID	Parameters: - name Indicates the name of the new J2C resource adapter. This parameter is required. - scope Indicates the scope object ID. This parameter is required. - useDeepCopy If you set this parameter to 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 you set this parameter to false, the objects are not created (shallow copy). The default is false. Returns: J2C resource adapter object ID	Batch mode example usage: Using Jacl $AdminTask copyResourceAdapter $ra [subst {-name newRA -scope $scope}] Using Jython string AdminTask.copyResourceAdapter(ra, '[-name newRA -scope scope]') Interactive mode example usage: Using Jacl $AdminTask copyResourceAdapter {-interactive} Using Jython string AdminTask.copyResourceAdapter ('[-interactive]')
createJ2CActivationSpec	Use the createJ2CActivationSpec command to create a Java 2 Connector (J2C) activation specification under a J2C resource adapter and the attributes that you specify. Use the messageListenerType parameter to indicate the activation specification that is defined for the J2C resource adapter.	J2C Resource Adapter object ID	Parameters: - 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 that you specify. - name Indicates the name of the J2C activation specification that you are creating. - jndiName Indicates the name of the Java Naming and Directory Interface (JNDI). - destinationJndiName Indicates the name of the Java Naming and Directory Interface (JNDI) of corresponding destination. - authenticationAlias Indicates the authentication alias of the J2C activation specification that you are creating. - description Description of the created J2C activation specification. Returns: J2CActivationSpec object ID	Batch mode example usage: Using Jacl $AdminTask createJ2CActivationSpec $ra {-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener } Using Jython string AdminTask.createJ2CActivationSpec(ra, '[-name J2CActSpec -jndiName eis/ActSpec1 -messageListenerType javax.jms.MessageListener]') Interactive mode example usage: Using Jacl $AdminTask createJ2CActivationSpec {-interactive} Using Jython string AdminTask.createJ2CActivationSpec ('[-interactive]')
createJ2CAdminObject	Use the createJ2CAdminObject command to create an administrative object under a resource adapter with attributes that you specify. Use the administrative object interface to indicate the administrative object that is defined in the resource adapter.	J2C Resource Adapter object ID	Parameters: -adminObjectInterface administrative object interface to identify the administrative object for the resource adapter that you specify. This parameter is required. -name Indicates the name of the administrative object. -jndiName Name of the Java Naming and Directory Interface (JNDI). -description Description of the created J2C admin object. Returns: J2CAdminObject object ID	Batch mode example usage: Using Jacl $AdminTask createJ2CAdminObject $ra {-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01} Using Jython string AdminTask.createJ2CAdminObject(ra, '[-adminObjectInterface fvt.adapter.message.FVTMessageProvider -name J2CA01 -jndiName eis/J2CA01]') Interactive mode example usage: Using Jacl $AdminTask createJ2CAdminObject {-interactive} Using Jython string AdminTask.createJ2CAdminObject ('[-interactive]')
createJ2CConnectionFactory	Use the createJ2CConnectionFactory command to create a Java 2 connection factory under a Java 2 resource adapter and the attributes that you specify. Use the connection factory interfaces to indicate the connection definitions that are defined for the Java 2 resource adapter.	J2C Resource Adapter object ID	Parameters: -connectionFactoryInterface Identifies the connection definition for the Java 2 resource adapter that you specify. This parameter is required. -name Indicates the name of the connection factory. -jndiName Indicates the name of the Java Naming and Directory Interface (JNDI). -description Description of the created J2C connection factory. Returns: The J2C connection factory object ID.	Batch mode example usage: Using Jacl $AdminTask createJ2CConnectionFactory $ra {-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1} Using Jython string AdminTask.createJ2CConnectionFactory(ra, '[-connectionFactoryInterfaces javax.sql.DataSource -name J2CCF1 -jndiName eis/J2CCF1]') Interactive mode example usage: Using Jacl $AdminTask createJ2CConnectionFactory {-interactive} Using Jython string AdminTask.createJ2CConnectionFactory ('[-interactive]')
listAdminObjectInterfaces	Use the listAdminObjectInterfaces command to list the administrative object interfaces that are defined under the resource adapter that you specify.	J2C Resource Adapter object ID	Parameters: None Returns: A list of administrative object interfaces.	Batch mode example usage: Using Jacl $AdminTask listAdminObjectInterfaces $ra Using Jython string AdminTask.listAdminObjectInterfaces(ra) Interactive mode example usage: Using Jacl $AdminTask listAdminObjectInterfaces {-interactive} Using Jython string AdminTask.listAdminObjectInterfaces ('[-interactive]')
listConnectionFactoryInterfaces	Use the listConnectionFactoryInterfaces command to list all of the connection factory interfaces that are defined under the Java 2 connector resource adapter that you specify.	J2C Resource Adapter object ID	Parameters: None Returns: A list of connection factory interfaces.	Batch mode example usage: Using Jacl $AdminTask listConnectionFactoryInterfaces $ra Using Jython string AdminTask.listConnectionFactoryInterfaces(ra) Interactive mode example usage: Using Jacl $AdminTask listConnectionFactoryInterfaces {-interactive} Using Jython string AdminTask.listConnectionFactoryInterfaces ('[-interactive]')
listJ2CActivationSpecs	Use the listJ2CActivationSpecs command to list the activation specifications that are contained under the resource adapter and message listener type that you specify.	J2C Resource Adapter object ID	Parameters: -messageListenerType message listener type for the resource adapter for which you are making a list. This parameter is required. Returns: A list of activation specifications that has specified messageListener type.	Batch mode example usage: Using Jacl $AdminTask listJ2CActivationSpecs $ra {-messageListenerType javax.jms.MessageListener} Using Jython string AdminTask.listJ2CActivationSpecs(ra, '[-messageListenerType javax.jms.MessageListener]') Interactive mode example usage: Using Jacl $AdminTask listJ2CActivationSpecs {-interactive} Using Jython string AdminTask.listJ2CActivationSpecs ('[-interactive]')
listJ2CAdminObjects	Use the listJ2CAdminObjects command to list administrative objects that contain the administrative object interface that you specify.	J2C Resource Adapter object ID	Parameters: -adminObjectInterface administrative object interface for which you want to list. This parameter is required. Returns: A list of administrative objects that has specified adminObjectInterface.	Batch mode example usage: Using Jacl $AdminTask listJ2CAdminObjects $ra {-adminObjectInterface fvt.adaptor.message.FVTMessageProvider} Using Jython string AdminTask.listJ2CAdminObjects(ra, '[-adminObjectInterface fvt.adaptor.message.FVTMessageProvider]') Interactive mode example usage: Using Jacl $AdminTask listJ2CAdminObjects {-interactive} Using Jython string AdminTask.listJ2CAdminObjects ('[-interactive]')
listJ2CConnectionFactories	Use the listJ2CConnectionFactories command to list the Java 2 connector connection factories under the resource adapter and connection factory interface that you specify.	J2C Resource Adapter object ID	Parameters: -connectionFactoryInterface Indicates the name of the connection factory that you want to list. This parameter is required. Returns: A list of J2C connectionFactory that has the specified connectionFactoryInterface.	Batch mode example usage: Using Jacl $AdminTask listJ2CConnectionFactories $ra {-connectionFactoryInterface javax.sql.DataSource} Using Jython string AdminTask.listJ2CConnectionFactories(ra, '[-connectionFactoryInterface javax.sql.DataSource]') Interactive mode example usage: Using Jacl $AdminTask listJ2CConnectionFactories {-interactive} Using Jython string AdminTask.listJ2CConnectionFactories ('[-interactive]')
listMessageListenerTypes	Use the listMessageListenerTypes command to list the message listener types that are defined under the resource adapter that you specify.	J2C Resource Adapter object ID	Parameters: None Returns: A list of message listener types.	Batch mode example usage: Using Jacl $AdminTask listMessageListenerTypes $ra Using Jython string AdminTask.listMessageListenerTypes(ra) Interactive mode example usage: Using Jacl $AdminTask listMessageListenerTypes {-interactive} Using Jython string AdminTask.listMessageListenerTypes ('[-interactive]')