Administering Administered Objects

Packaged within a connector module, an administered object provides specialized functionality for an application. For example, an administered object might provide access to a parser that is specific to the connector module and its associated EIS.

The following topics are addressed here:

• To Create an Administered Object

• To List Administered Objects

• To Update an Administered Object

• To Delete an Administered Object

To Create an Administered Object

Use the create-admin-object subcommand to create an administered object resource. When creating an administered object resource, name-value pairs are created, and the object is associated to a JNDI name.

Before You Begin

The resource adapter must be deployed before running this subcommand (jmsrar.rar).

1. Create an administered object by using the create-admin-object(1) subcommand.

   Information about properties for the subcommand is included in this help page.

2. (Optional) If needed, restart the server.

   Some properties require server restart. See Configuration Changes That Require Server Restart. If your server needs to be restarted, see To Restart a Domain.

Example 15–20 Creating an Administered Object

For this example, the javax.jms.Queue resource type is obtained from the ra.xml file. The JNDI name of the new administered object is jms/samplequeue.

asadmin> create-admin-object --restype javax.jms.Queue --raname jmsra  --description "sample administered object" 
--property Name=sample_jmsqueue jms/samplequeueCommand create-admin-object executed successfully

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help create-admin-object at the command line.

To List Administered Objects

Use the list-admin-object subcommand in remote mode to list the existing administered objects.

1. Ensure that the server is running.

   Remote subcommands require a running server.

2. List the administered objects by using the list-admin-objects(1) subcommand.

Example 15–21 Listing Administered Objects

This example lists the existing administered objects.

asadmin> list-admin-objects
jms/samplequeue
Command list-admin-objects executed successfully

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help list-admin-object at the command line.

To Update an Administered Object

Use the get and set subcommands to view and change the values of the administered objects properties.

1. List the administered objects by using the list-admin-objects(1) subcommand.

2. View the properties of the administered object by using the get(1) subcommand.

   For example:

   asadmin> get domain.resources.admin-object-resource.jms/samplequeue.*

3. Set the property of the administered object by using the set(1) subcommand.

   For example:

   asadmin> set domain.resources.admin-object-resource.jms/samplequeue.enabled=false

4. (Optional) If needed, restart the server.

   Some properties require server restart. See Configuration Changes That Require Server Restart. If your server needs to be restarted, see To Restart a Domain.

To Delete an Administered Object

Use the delete-admin-object subcommand to delete an administered objects.

1. List the administered objects by using the list-admin-objects(1) subcommand.

2. If necessary, notify users that the administered object is being deleted.

3. Delete an administered object by using the delete-admin-object(1) subcommand.

Example 15–22 Deleting an Administered Object

This example deletes the administered object with the JNDI name jms/samplequeue.

asadmin> delete-admin-object jms/samplequeue
Command delete-admin-object executed successfully

See Also

You can also view the full syntax and options of the subcommand by typing asadmin help delete-admin-object at the command line.