Identifying attributes and operations for running objects using the wsadmin scripting tool

You can use scripting to identify attributes and operations for running objects.

Before you begin

Before starting this task, the wsadmin tool must be running. See the topic about starting the wsadmin scripting client.

About this task

Use the attributes or operations commands of the Help object to find information on a running MBean in the server.

Procedure

  1. Specify a running object.
  2. Use the attributes command to display the attributes of the running object:
    • Using Jacl:
      $Help attributes MBeanObjectName
    • Using Jython:
      Help.attributes(MBeanObjectName)
    Table 1. Help attributes command description . Run the attributes command with an object name.
    Attribute Definition
    $ is a Jacl operator for substituting a variable name with its value
    Help is the object that provides general help and information for running MBeans in the connected server process
    attributes is a Help command
    MBeanObjectName is the string representation of the MBean object name that is obtained in step 2
  3. Use the operations command to find out the operations that are supported by the MBean:
    • Using Jacl:
      $Help operations MBeanObjectname
      or
      $Help operations MBeanObjectname operationName
    • Using Jython:
      Help.operations(MBeanObjectname)
      or
      Help.operations(MBeanObjectname, operationName)
    Table 2. Help operations command description . Run the operations command with an object name and, optionally, an operation name.
    Attribute Definition
    $ is a Jacl operator for substituting a variable name with its value
    Help is the object that provides general help and information for running MBeans in the connected server process
    operations is a Help command
    MBeanObjectname is the string representation of the MBean object name that is obtained in step number 2
    operationName (optional) is the specified operation from which you want to obtain detailed information

    If you do not provide the operationName value, all the operations that are supported by the MBean return with the signature for each operation. If you specify the operationName value, only the operation that you specify returns and it contains details which include the input parameters and the return value.

    To display the operations for the server MBean, use the following example:

    • Using Jacl:
      set server [$AdminControl completeObjectName type=Server,name=server1,*]
      $Help operations $server
    • Using Jython:
      server = AdminControl.completeObjectName('type=Server,name=server1,*')
      print Help.operations(server)

    To display detailed information about the stop operation, use the following example:

    • Using Jacl:
      $Help operations $server stop
    • Using Jython:
      print Help.operations(server, 'stop')