IBM WebSphere 开发者技术期刊: WebSphere Application Server 的管理命令框架编程指南

<Metadata xmlns="commandmetadata.xsd">
   <commandProvider implClass="HelloWorldProvider">
      <commandGroups name="HelloWorld">
         <commands>helloWorld</commands>
      </commandGroups>
      <commands name="helloWorld" 
            description="Hello World command" title="Hello World Command">
         <targetObjectAllowed>false</targetObjectAllowed>
      </commands>
   </commandProvider>
</Metadata>

<commands name="helloWorld" description="Hello World command" 
      title="Hello World Command">
   <targetObjectAllowed>false</targetObjectAllowed>
   <parameters name="personName" description="Name of person" 
         title="Name of Person">
      <type>String</type>
      <required>false</required>
   </parameters>
   <parameters name="personalInfo" description="
         Person information in the form of properties such as address, cellPhone." 
         title="Properties of person">
      <type>java.util.Properties</type>
      <required>false</required>
   </parameters>
   <parameters name="pets" description="
         Pets owned by the person" title="Array of Pets owned">
      <type>[Ljava.lang.String;</type>
      <required>false</required>
   </parameters>
   <parameters name="personID" description="Person Identification" 
         title="Unique ObjectName representing the person">
      <type>javax.management.ObjectName</type>
      <required>false</required>
   </parameters>
</commands>

public class HelloWorldProvider extends CommandProvider
{
   /*
    * createCommand : All providers must provide this method. This method
    * will be called by the command framework when a command provided by
    * this provider is created.
    * This method should return AdminCommand that implements the command
    * specified by the commandName in the metadata passed.
    */
   public AbstractAdminCommand createCommand(CommandMetadata metadata)
   throws CommandNotFoundException
   {
      if ( metadata.getName().equals("helloWorld") )
         return new HelloWorldCommand(metadata);
      else
         throw new CommandNotFoundException(metadata.getName());
   }

   /*
    * loadCommand : All providers must provide this method. This method
    * will be called by the command framework when a command provided by
    * this provider is loaded.
    * This method should return AdminCommand that implements the command
    * specified by the commandName in the metadata.
    *
    * A command can be saved at any time using command.save(outputstream)
    * and loaded again later using CommandMgr.loadCommand(inputStream)
    * When a loadCommand is used to reload previously saved command, this
    * method will be called by the command framework.
    */
   public AbstractAdminCommand loadCommand(CommandData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      if ( cmdData.getName().equals("helloWorld") )
         return new HelloWorldCommand(cmdData);
      else
         throw new CommandNotFoundException(cmdData.getName());
   }
}

public class HelloWorldCommand extends AbstractAdminCommand
{
   /*
    * constructor to create a command. Used by provider to create
    * a new command. All commands should implement this constructor
    */
   public HelloWorldCommand (CommandMetadata metadata)
   throws CommandNotFoundException
   {
      // super constructor should be called
      super(metadata);
   }
   
   /*
    * constructor to load a command. Used by provider to load command
    * All commands should implement this constructor
    */
   public HelloWorldCommand (CommandData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      // super constructor should be called
      super(cmdData);
   }

   /*
    * execute() : All commands should provide this method.
    * This method will be called by command framework to execute the
    * command.
    * Command execute logic should be provided in this method.
    * When this method is called, the parameters are not validated.
    * This method should call super.validate() to validate the parameters
    * to make sure all required parameters for the command are supplied
    * and the type of parameters is correct.
    * Any additional validation required by the command should be performed
    * in this method.
    *
    * Result of the command should be set in the command before returning
    * from this method.
    * In case of error executing the command an exception should be set in
    * in the command result. An exception set in the command result
    * indicates a failure to execute the command.
    */
   public void execute()
   {
      // create command result
      CommandResultImpl result = new CommandResultImpl();
      // clear result
      result.reset();

      try {
         // super validate should be called
         validate();

         // get parameters
         String personName = (String)getParameter("personName");
         Properties personalInfo = (Properties)getParameter("personalInfo");
         String pets[] = (String[])getParameter("pets");
         javax.management.ObjectName personID =
            (javax.management.ObjectName)getParameter("personID");

         // execute cmd

         // prepare hello message
         StringBuffer sb = new StringBuffer();
         sb.append("Hello World ");
         if ( personName != null ) {
            sb.append(personName);
         }

         if ( personID != null ) {
            sb.append(" ID =  ");
            sb.append(personID.toString());
         }


         if ( personalInfo != null ) {
            sb.append(" Personal Info = ");
            sb.append(personalInfo);
         }

         if ( pets != null ) {
            sb.append(" pets =  ");
            for ( int i=0; i<pets.length; i++ ) {
               if ( i!=0 ) sb.append(",");
               sb.append(pets[i]);
            }
         }

         // setup the result
         String res = sb.toString();
         result.setResult(res);

      }
      catch (CommandValidationException cve) {
         result.setException(cve);
      }
      catch (Throwable e) {
         result.setException(e);
      }

      // set command result
      setCommandResult(result);
   }
}

<commandProvider implClass="HelloWorldTaskProvider">
   <commandGroups name="HelloWorldTask">
      <commands>helloWorldTask</commands>
   </commandGroups>
   <taskCommands name="helloWorldTask" description="
         HelloWorld Task Command" title="Hello World Task Command">
      <targetObjectAllowed>false</targetObjectAllowed>
      <steps name="getPerson" description="
            Step to get person information" title="personal information step">
         <targetObjectAllowed>false</targetObjectAllowed>
         <priority>0</priority>
         <parameters name="personName" description="Name of person" 
               title="Name of Person">
            <type>String</type>
            <required>true</required>
         </parameters>
         <parameters name="countryName" description="
               Country Name of person" title="Name of Country">
            <type>String</type>
            <required>true</required>
         </parameters>
      </steps>
   </taskCommands>
</commandProvider>

<steps name="contactInfo" description="
      Step to get person's contact information" title="
      Contact information step.">
   <targetObjectAllowed>false</targetObjectAllowed>
   <table>true</table>
   <priority>0</priority>
   <parameters name="type" description="contact type 
         (phone or e-mail) " title="contact type">
      <type>String</type>
      <required>true</required>
      <keyField>true</keyField>
   </parameters>
   <parameters name="value" description="
         contact value ( phone number or e-mail address )" 
         title="contact value">
      <type>String</type>
      <required>true</required>
      <keyField>true</keyField>
   </parameters>
</steps>

<commandProvider implClass="HelloWorldExtProvider">
   <taskCommandExts>
      <name>helloWorldTask</name>
      <steps name="additionalInfo" description="
            extended step to add additional information" title="
            Additional Information Step Extension">
         <targetObjectAllowed>false</targetObjectAllowed>
         <priority>0</priority>
         <parameters name="hobbies" description="
               Hobbies" title="Hobbies">
            <type>[Ljava.lang.String;</type>
            <required>true</required>
         </parameters>
         <parameters name="sports" description="
               Sports" title="Sports">
            <type>[Ljava.lang.String;</type>
            <required>true</required>
         </parameters>
      </steps>
   </taskCommandExts>
</commandProvider>

<Metadata xmlns="commandmetadata.xsd">
<!--
Admin Command Example :
This will display Hello or Hello personName
Result :
   Hello
   Hello John
   Hello John {cellPhone=123-456-7890 homePhone=123-456-7890 
         workPhone=123-456-7890} pets=dog,cat personId=John(organization=ibm,
         country=usa,state=texas,city=austin)
-->
   <commandProvider implClass="HelloWorldProvider">
      <commandGroups name="HelloWorld">
         <commands>helloWorld</commands>
      </commandGroups>
      <commands name="helloWorld" description="Hello World 
            command" title="Hello World Command">
         <targetObjectAllowed>false</targetObjectAllowed>
         <parameters name="personName" description="Name of 
               person" title="Name of Person">
            <type>String</type>
            <required>false</required>
         </parameters>
         <parameters name="personalInfo" description="Person 
               information in the form of properties such as address, 
               cellPhone." title="Properties of person">
            <type>java.util.Properties</type>
            <required>false</required>
         </parameters>
         <parameters name="pets" description="Pets owned 
               by the person" title="Array of Pets owned">
            <type>[Ljava.lang.String;</type>
            <required>false</required>
         </parameters>
         <parameters name="personID" description="Person 
               Identification" title="Unique ObjectName representing 
               the person">
            <type>javax.management.ObjectName</type>
            <required>false</required>
         </parameters>
      </commands>
   </commandProvider>

<!--
Task Command Example :
This will display Hello World or Hello World personName, countryName
Result :
   Hello World John,USA {phone=123-456-7890, e-mail=john@yahoo.com}

Table step : A step that accepts parameters in the form of a table.
It has two paramters type and value that represents two columns of the table.
Multiple rows can be specified as input paramters for this step as shown below.

   type                 value
   --------------       ------------
   home phone           xxx-xxx-xxxx
   work phone           xxx-xxx-xxxx
   e-mail address       xxx@yyyy.com
-->

   <commandProvider implClass="HelloWorldTaskProvider">
      <commandGroups name="HelloWorldTask">
         <commands>helloWorldTask</commands>
      </commandGroups>
      <taskCommands name="helloWorldTask" description="HelloWorld 
            Task Command" title="Hello World Task Command">
         <targetObjectAllowed>false</targetObjectAllowed>
         <steps name="getPerson" description="Step to get person 
               information" title="personal information step">
            <targetObjectAllowed>false</targetObjectAllowed>
            <priority>0</priority>
            <parameters name="personName" description="Name of 
                  person" title="Name of Person">
               <type>String</type>
               <required>true</required>
            </parameters>
            <parameters name="countryName" description="Country 
                  Name of person" title="Name of Country">
               <type>String</type>
               <required>true</required>
            </parameters>
         </steps>
         <steps name="contactInfo" description="Step to get 
               person's contact information" title="Contact information 
               step.">
            <targetObjectAllowed>false</targetObjectAllowed>
            <table>true</table>
            <priority>0</priority>
            <parameters name="type" description="contact type 
                  (phone or e-mail) " title="contact type">
               <type>String</type>
               <required>true</required>
               <keyField>true</keyField>
            </parameters>
            <parameters name="value" description="contact value 
                  (phone number or e-mail address )" title="contact value">
               <type>String</type>
               <required>true</required>
               <keyField>true</keyField>
            </parameters>
         </steps>
      </taskCommands>
   </commandProvider>

<!--
Task Command Extension Example :
This will add additional information to the above command.
In this example, a new step is added as an extension to the Hello World command.
This new step reads hobbies and sports parameters and adds to the result of the
original command.

Result :
   Hello World John,USA {phone=123-456-7890, e-mail=john@yahoo.com} {hobbies=movies,
      sports} {sports=cricket, tennis}
-->

   <commandProvider implClass="HelloWorldExtProvider">
      <taskCommandExts>
         <name>helloWorldTask</name>
         <steps name="additionalInfo" description="extended step to 
               additional information" title="Additional Information Step 
               Extension">
            <targetObjectAllowed>false</targetObjectAllowed>
            <priority>0</priority>
            <parameters name="hobbies" description="Hobbies" 
                  title="Hobbies">
               <type>[Ljava.lang.String;</type>
               <required>true</required>
             </parameters>
            <parameters name="sports" description="Sports" 
                  title="Sports">
               <type>[Ljava.lang.String;</type>
               <required>true</required>
             </parameters>
         </steps>
      </taskCommandExts>
   </commandProvider>

</Metadata>

public class HelloWorldTaskProvider extends CommandProvider
{
   /*
    * createCommand : All providers must provide this method. This method
    * will be called by command framework to create a new command.
    * This method should return TaskCommand that implements the command
    * specified by name commandName in the metadata passed.
    */
   public AbstractAdminCommand createCommand(CommandMetadata metadata)
   throws CommandNotFoundException
   {
      HelloWorldTaskCommand cmd = new HelloWorldTaskCommand((TaskCommandMetadata)
         metadata);
      // set initial values for table
      setInitialValues(cmd);
      return cmd;
   }

   /*
    * loadCommand : All providers must provide this method. This method
    * will be called by command framework to load a command.
    * This method should return TaskCommand that implements the command
    * specified by name commandName in the command data passed.
    */
   public AbstractAdminCommand loadCommand(CommandData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      HelloWorldTaskCommand cmd =  new HelloWorldTaskCommand((TaskCommandData)cmdData);
      // set initial values for table
      setInitialValues(cmd);
      return cmd; 
   }

   /*
    * createCommandStep : All providers must provide this method.
    * This method will be called by command framework to create
    * a step command.
    * This method should return CommandStep that implements the step
    * specified by stepName passed.
    */
   public AbstractCommandStep createCommandStep(AbstractTaskCommand taskCmd, String 
      stepName) 
   throws CommandNotFoundException
   {
      // get stepMetadata from task command metadata.
      // Command framework can improve this by passing stepMetadata.
      TaskCommandMetadata metadata = (TaskCommandMetadata) taskCmd.getCommandMetadata();
      CommandStepMetadata stepMetadata = null;
      for (Iterator iter = metadata.getSteps().iterator(); iter.hasNext();) {
         CommandStepMetadata temp = (CommandStepMetadata) iter.next();
         if (temp.getName().equals(stepName)) {
            stepMetadata = temp;
            break;
         }
      }

      if (stepMetadata == null)
         throw new CommandNotFoundException(taskCmd.getName(), stepName);

      if ( stepName.equals("getPerson") )
         return ((HelloWorldTaskCommand)taskCmd).new GetPerson((AbstractTaskCommand)
               taskCmd, stepMetadata);
      else if ( stepName.eqauls("contactInfo" )
         return ((HelloWorldTaskCommand)taskCmd).new ContactInfo((AbstractTaskCommand)
               taskCmd,stepMetadata);
      else
         throw new CommandNotFoundException(taskCmd.getName(), stepName);
   }

   /*
    * loadCommandStep : All providers must provide this method.
    * This method will be called by command framework to load
    * a step command.
    * This method should return CommandStep that implements the step
    * specified by stepName passed.
    */
   public AbstractCommandStep loadCommandStep(AbstractTaskCommand taskCmd, 
      CommandStepData stepData)
   throws CommandNotFoundException, CommandLoadException
   {
      // get taskname and stepname
      String taskName = taskCmd.getName();
      String stepName = stepData.getName();

      if ( !taskName.equals("helloWorldTask") )
         throw new CommandNotFoundException(taskName, stepName);
      if ( stepName.equals("getPerson") )
         return ((HelloWorldTaskCommand)taskCmd).new GetPerson((AbstractTaskCommand)
            taskCmd, stepData);
      else if ( stepName.equals("contactInfo") )
         return ((HelloWorldTaskCommand)taskCmd).new ContactInfo((AbstractTaskCommand)
            taskCmd, stepData);
      else
         throw new CommandNotFoundException(taskName, stepName);
   }
}

public class HelloWorldTaskProvider extends CommandProvider
{
   public AbstractAdminCommand createCommand(CommandMetadata metadata)
   throws CommandNotFoundException
   {
      HelloWorldTaskCommand cmd = new HelloWorldTaskCommand((TaskCommandMetadata)
         metadata);
      // set initial values for table
      setInitialValues(cmd);
      return cmd;
   }

   public AbstractAdminCommand loadCommand(CommandData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      HelloWorldTaskCommand cmd =  new HelloWorldTaskCommand((TaskCommandData)cmdData);
      // set initial values for table
      setInitialValues(cmd);
      return cmd; 
   }

...
...

   /**
    * setInitialvalues() : This method shows how to set initial values
    * of table paramter. In this example the table in the step is initialized
    * with two rows.
    */
   private void setInitialValues(HelloWorldTaskCommand cmd)
   {
      try {
         // get table step from the command
         HelloWorldTaskCommand.ContactInfo step =
            (HelloWorldTaskCommand.ContactInfo)cmd.getCommandStep("contactInfo");
      
         // create one row
         AttributeList rowData = new AttributeList();
         rowData.add(new Attribute("type", "home phone"));
         rowData.add(new Attribute("value", "xxx-xxx-xxxx"));

         // initialize step with one row at index 0
         step.initializeRow(rowData, 0);

         // create another row
         rowData.clear();
         rowData.add(new Attribute("type", "e-mail address"));
         rowData.add(new Attribute("value", "xxx@yyy.com"));
   
         // add another row to step at index 1
         step.initializeRow(rowData, 1);
      }
      catch (Exception e) {
         // error handling
      }
   }
}

/**
 * HelloExtProvider : A provider that provides an extension to
 * HelloWorldTaskCommand.
 * Since this provider only provides new steps to existing command,
 * only create and load step methods are required.
 */
public class HelloWorldExtProvider extends CommandProvider
{
   /*
    * createCommandStep : All providers must provide this method.
    * This method will be called by command framework to create
    * a step command.
    * This method should return CommandStep that implements the step
    * specified by stepName passed.
    */
   public AbstractCommandStep createCommandStep(AbstractTaskCommand taskCmd, 
   String stepName) throws CommandNotFoundException {

      // get stepMetadata from task command metadata.
      // Command framework can improve this by passing stepMetadata.
      TaskCommandMetadata metadata = (TaskCommandMetadata) taskCmd.getCommandMetadata();
      CommandStepMetadata stepMetadata = null;
      for (Iterator iter = metadata.getSteps().iterator(); iter.hasNext();) {
         CommandStepMetadata temp = (CommandStepMetadata) iter.next();
         if (temp.getName().equals(stepName)) {
            stepMetadata = temp;
            break;
         }
      }

      if (stepMetadata == null)
         throw new CommandNotFoundException(taskCmd.getName(), stepName);

      if ( stepName.equals("additionalInfo") )
         return new  HelloWorldExtStep((AbstractTaskCommand)taskCmd, stepMetadata);
      else
         throw new CommandNotFoundException(taskCmd.getName(), stepName);
   }

   /*
    * loadCommandStep : All providers must provide this method.
    * This method will be called by command framework to load
    * a step command.
    * This method should return CommandStep that implements the step
    * specified by stepName passed.
    */
   public AbstractCommandStep loadCommandStep(AbstractTaskCommand taskCmd, 
      CommandStepData stepData)
   throws CommandNotFoundException, CommandLoadException
   {
      // get taskname and stepname
      String taskName = taskCmd.getName();
      String stepName = stepData.getName();

      if ( taskName.equals("helloWorldTask") )
         throw new CommandNotFoundException(taskName, stepName);
      if ( stepName.equals("additionalInfo") )
         return new HelloWorldExtStep((AbstractTaskCommand)taskCmd, stepData);
      else
         throw new CommandNotFoundException(taskName, stepName);
   }
}

/**
 *
 * HelloWorldTaskCommand : A Hello World command. A task command with steps
 *
 * Note that a task command should not implement execute() method.
 * execute() method of AbsractTaskCommand calls beforeStepsExecuted() method
 * of the task command and then all the step's execute() methods and then
 * call afterStepsExecuted() method of the task command. If this execute()
 * method is overriden, the steps will not be executed automatically.
 *
 * Therefore, a task command should implement all the logic in either
 * beforeStepsExecuted() or afterStepsExecuted() methods depending on whether
 * steps execution depends on the task command execution result or vice-versa.
 *
 * For task commands, an empty command result is set before invoking execute()
 * method.  But, for steps, result is not set. Steps can either use command's
 * result or set its own result. In this example, steps use its task command's
 * result and add to it.
 */
public class HelloWorldTaskCommand extends AbstractTaskCommand
{
   /*
    * constructor to create task command using command metadata.
    * called during command create
    */
   public HelloWorldTaskCommand(TaskCommandMetadata metadata)
   throws CommandNotFoundException
   {
      super(metadata);
   }
   
   /*
    * constructor to create task command using command data.
    * called during command load
    */
   public HelloWorldTaskCommand(CommandData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      super(cmdData);
   }

   /*
    * This method is called before execution of the command and its
    * steps. This method can be used to validate the input parameters.
    * validate of command is called first and then the validate of all
    * steps are called.
    * Need not call super.valdate();
    */
   public void validate() throws CommandValidationException
   {
      // no validation in this case
   }

   /*
    * This method is called before executing any step.
    * This method can be used to setup data in the command result that
    * step can use during thier execution.
    */
   protected void beforeStepsExecuted()
   {
      TaskCommandResult result = getTaskCommandResult();
      List res = new ArrayList();
      res.add("Hello ");
      ((CommandResultImpl)result).setResult(res);
   }

   /*
    * This method is called after executing all steps.
    */
   protected void afterStepsExecuted()
   {
      TaskCommandResult result = getTaskCommandResult();
      List res = (List)result.getResult();
   }
}

/*
 * Implementation of comand steps
 */
public class GetPerson extends AbstractCommandStep
{
   /*
    * constructor to create command step.
    * This constructor will be called to create a new step.
    */
   public GetPerson(AbstractTaskCommand parent, CommandStepMetadata metadata)
   throws CommandNotFoundException
   {
      super(parent, metadata);
   }

   /*
    * constructor to load command step.
    * This constructor will be called to load step.
    */
   public GetPerson(AbstractTaskCommand parent, CommandStepData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      super(parent, cmdData);
   }

   /*
    * This method will be called before executeStep.
    * Should call super.valdate();
    */
   public void validate() throws CommandValidationException
   {
      super.validate();
      // perform more validation
   }

   /*
    * This method will be called to execute the step
    */
   protected void executeStep()
   {
      // get all parameters
      String personName = null;
      String countryName = null;
      String personInfo = null;
      try {
         personName = (String)getParameter("personName");
         countryName = (String)getParameter("countryName");
      }
      catch (InvalidParameterNameException e) {
         CommandResultImpl result = (CommandResultImpl)taskCmd.getCommandResult();
         result.setException(e);
         return;
      }
      
      // execute
      if ( personName != null )
         personInfo = personName + "," + countryName;

      // get task command result
      CommandResult result = taskCmd.getCommandResult();
      List res = (List)result.getResult();

      // update task command result
      res.add(personInfo);
   }
}

public class ContactInfo extends AbstractCommandStep
{
   /*
    * constructor to create command step.
    * This constructor will be called to create a new step.
    */
   public ContactInfo(AbstractTaskCommand parent, CommandStepMetadata metadata)
   throws CommandNotFoundException
   {
      super(parent, metadata);
   }

   /*
    * constructor to load command step.
    * This constructor will be called to load step.
    */
   public ContactInfo(AbstractTaskCommand parent, CommandStepData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      super(parent, cmdData);
   }

   /*
    * This method will be called before executeStep.
    * Should call super.valdate();
    */
   public void validate() throws CommandValidationException
   {
      super.validate();
      // perform more validation
   }

   /*
    * This method will be called to execute the step
    */
   protected void executeStep()
   {
      // get number of rows
      int rows = getNumberOfRows();
      StringBuffer sb = new StringBuffer();
      sb.append("{");
      try {
         // get each row
         for (int i=0; i<rows; i++) {
            // get type parameter indexed at "i"
            String type = (String)getParameter("type", i);
            // get value parameter indexed at "i"
            String value = (String)getParameter("value", i);

            if ( i!=0 ) sb.append(" ; ");
            sb.append(type);
            sb.append("=");
            sb.append(value);
         }
      }
      catch (InvalidParameterNameException e) {
         CommandResultImpl result = (CommandResultImpl)taskCmd.getCommandResult();
         result.setException(e);
         return;
      }
      sb.append("}");
      
      // execute
      String contactInfo = sb.toString();

      // get task command result
      CommandResult result = taskCmd.getCommandResult();
      List res = (List)result.getResult();

      // update task command result
      res.add(contactInfo);
   }

   /**
    * This method has protected access in
    * com.ibm.websphere.management.cmdframework.provider.AbstractCommandStep.
    * Therefore, we need to overwrite this method so that
    * the provider can initialze the rows.
    */
   protected void initializeRow(AttributeList rowData, int rowIndex)
   throws InvalidParameterValueException, IndexOutOfBoundsException
   {
      super.initializeRow(rowData, rowIndex);
   }
}

/**
 *
 * HelloWorldExtStep : An extended step to HelloWorld command
 *
 */
public class HelloWorldExtStep extends AbstractCommandStep
{
   /*
    * constructor to create command step.
    * This constructor will be called to create a new step.
    */
   public HelloWorldExtStep(AbstractTaskCommand parent, CommandStepMetadata metadata)
   throws CommandNotFoundException
   {
      super(parent, metadata);
   }

   /*
    * constructor to load command step.
    * This constructor will be called to load step.
    */
   public HelloWorldExtStep(AbstractTaskCommand parent, CommandStepData cmdData)
   throws CommandNotFoundException, CommandLoadException
   {
      super(parent, cmdData);
   }

   /*
    * This method will be called before executeStep.
    * Should call super.valdate();
    */
   public void validate() throws CommandValidationException
   {
      super.validate();
   }

   /*
    * This method will be called to execute the step
    */
   protected void executeStep()
   {
      // get parameters
      String[] hobbies = null;
      String[] sports = null;
      try {
         hobbies = (String[])getParameter("hobbies");
         sports = (String[])getParameter("sports");
      }
      catch (InvalidParameterNameException e) {
         CommandResultImpl result = (CommandResultImpl)taskCmd.getCommandResult();
         result.setException(e);
         return;
      }

      // execute
      StringBuffer sb = new StringBuffer();
      if ( hobbies != null ) {
         sb.append("hobbies =  ");
         for (int i=0; i<hobbies.length; i++) {
            if ( i!=0 ) sb.append(",");
            sb.append(hobbies[i]);
         }
      }
      sb.append("\n");
      if ( sports != null ) {
         sb.append("sports =  ");
         for ( int i=0; i<sports.length; i++ ) {
            if ( i!=0 ) sb.append(",");
            sb.append(sports[i]);
         }
      }

      String additionalInfo = sb.toString();

      // set any additional result in the task command
      CommandResultImpl result = (CommandResultImpl)taskCmd.getCommandResult();
      List res = (List)result.getResult();
      res.add(additionalInfo);
   }
}

META-INF/admin-command-def.xml
HelloWorldProvider.class
HelloWorldTaskProvider.class
HelloWorldTaskCommand.class

HelloWorldCommand.class
HelloWorldTaskCommand.class
HelloWorldExtStep.class

wsadmin>$AdminTask helloWorld -interactive
Hello World Command

Hello World command

Name of Person (personName): John
Properties of person (personalInfo): {cellPhone 123-456-7890} 
   {homePhone 123-456-7891} {WorkPhone 123-456-7892}  
Array of Pets owned (pets): dog;cat
Unique ObjectName representing the person (personID): 
PersonId=John(organization=ibm,country=usa,state=texas,city=austin)

Hello World Command

F (Finish)
C (Cancel)

Select [F, C]: [F]
WASX7278I: Generated command line: $AdminTask helloWorld 
{-personName John -personalInfo " { {cellPhone 123-456-7890} 
   {workPhone 123-456-7892} {homePhone 123-456-7891} }" -pets dog;cat 
   -personID WebSphere:John(organization=ibm,country=usa,state=texas,city=austin)}

Hello World John ID =  WebSphere:John(organization=ibm,country=usa,state=texas,
   city=austin) PersonalInfo = {cellPhone=123-456-7890, workPhone=123-456-7892, 
   homePhone=123-456-7891} pets =  dog,cat

wsadmin>$AdminTask helloWorld 
{-personName John -personalInfo " { {cellPhone 123-456-7890} 
   {WorkPhone 123-456-7892} {homePhone 123-456-7891} }" 
   -pets dog;cat -personID WebSphere:John(organization=ibm,country=usa,
   state=texas,city=austin)}

Hello World John ID =  WebSphere:John(organization=ibm,country=usa,
   state=texas,city=austin) PersonalInfo = {cellPhone=123-456-7890, 
   WorkPhone=123-456-7892, homePhone=123-456-7891} pets =  dog,cat 

wsadmin>AdminTask.helloWorld('-interactive')
Hello World Command

Hello World command

Name of Person (personName): John
Properties of person (personalInfo): [cellPhone 123-456-7890] 
   [homePhone 123-456-7891] [workPhone 123-456-7892]
Array of Pets owned (pets): dog;cat;bird
Unique ObjectName representing the person (personID): 
John(organization=ibm,country=usa,state=texas,city=austin)

Hello World Command

F (Finish)
C (Cancel)

Select [F, C]: [F]
WASX7278I: Generated command line: AdminTask.helloWorld('[-personName 
   John -personalInfo "[ [cellPhone 123-456-7890] [workPhone 123-456-7892] 
   [homePhone 123-456-7891] ]" -pets dog;cat -personID WebSphere:John
   (organization=ibm,country=usa,state=texas,city=austin)]')

'Hello World John ID =  WebSphere:John(organization=ibm,country=usa,
   state=texas,city=austin) Personal Info = {cellPhone=123-456-7890, 
   workPhone=123-456-7892, homePhone=123-456-7891} pets =  dog,cat'

wsadmin>print AdminTask.helloWorld('[-personName John 
   -personalInfo "[ [cellPhone 123-456-7890] [workPhone 123-456-7892] 
   [homePhone 123-456-7891] ]" -pets dog;cat -personID WebSphere:
   John(organization=ibm,country=usa,state=texas,city=austin)]')

'Hello World John ID =  WebSphere:John(organization=ibm,country=usa,
   state=texas,city=austin) Personal Info = {cellPhone=123-456-7890, 
   workPhone=123-456-7892, homePhone=123-456-7891} pets =  dog,cat'

1) Choose the "Select Row" option to modify the existing 
   row property values in the table

wsadmin>$AdminTask helloWorldTask -interactive
Hello World Task Command

HelloWorld Task Command

-> *1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
C (Cancel)
H (Help)


Select [S, N, C, H]: [S]

personal information step (getPerson)

*Name of Person (personName):
*Name of Country (countryName):


Select [C (Cancel), E (Edit)]: [E]
*Name of Person (personName): John
*Name of Country (countryName): USA
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
->  2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
P (Previous)
C (Cancel)
H (Help)


Select [S, N, P, C, H]: [S]

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
->  | home phone, xxx-xxx-xxxx
    | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, A, D, F, H]: [F] S
*contact type (type): [home phone] phone
*contact value (value): [xxx-xxx-xxxx] 123-456-7890

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | phone, 123-456-7890
->  | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
P (Previous)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, P, A, D, F, H]: [F] S
*contact type (type): [e-mail address] e-mail
*contact value (value): [xxx@yyy.com] john@yahoo.com

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | phone, 123-456-7890
    | e-mail, john@yahoo.com
->

contact type, contact value must be provided to specific a row in batch mode.

P (Previous)
A (Add Row Before)
F (Finish)
H (Help)


Select [P, A, F, H]: [F]
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
-> *3. Additional Information Step Extension (additionalInfo)

S (Select Row)
P (Previous)
C (Cancel)
H (Help)


Select [S, P, C, H]: [S]

Additional Information Step Extension (additionalInfo)

*Hobbies (hobbies):
*Sports (sports):


Select [C (Cancel), E (Edit)]: [E]
*Hobbies (hobbies): movies;sports
*Sports (sports): cricket;tennis
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
    3. Additional Information Step Extension (additionalInfo)
->  End of task

P (Previous)
F (Finish)
C (Cancel)
H (Help)


Select [P, F, C, H]: [F]
WASX7278I: Generated command line: $AdminTask helloWorldTask {-getPerson {-personName 
   John -countryName USA} -contactInfo {{phone 123-456-7890} {e-mail john@yahoo.com}} 
   -additionalInfo {-hobbies movies;sports -sports cricket;tennis}}
"Hello World"
John,USA
{phone=123-456-7890 ; e-mail=john@yahoo.com}
{hobbies=movies,sports}{sports=cricket,tennis}


2) Choose the "Add Row Before" option to add new rows into table

wsadmin>$AdminTask helloWorldTask -interactive
Hello World Task Command

HelloWorld Task Command

-> *1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
C (Cancel)
H (Help)


Select [S, N, C, H]: [S]

personal information step (getPerson)

*Name of Person (personName):
*Name of Country (countryName):


Select [C (Cancel), E (Edit)]: [E]
*Name of Person (personName): John
*Name of Country (countryName): USA
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
->  2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
P (Previous)
C (Cancel)
H (Help)


Select [S, N, P, C, H]: [S]

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
->  | home phone, xxx-xxx-xxxx
    | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, A, D, F, H]: [F] A
*contact type (type): phone
*contact value (value): 123-456-7890

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | phone, 123-456-7890
->  | home phone, xxx-xxx-xxxx
    | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
P (Previous)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, P, A, D, F, H]: [F] N

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | phone, 123-456-7890
    | home phone, xxx-xxx-xxxx
->  | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
P (Previous)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, P, A, D, F, H]: [F] A
*contact type (type): e-mail
*contact value (value): john@yahoo.com

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | phone, 123-456-7890
    | home phone, xxx-xxx-xxxx
    | e-mail, john@yahoo.com
->  | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
P (Previous)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, P, A, D, F, H]: [F]
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
-> *3. Additional Information Step Extension (additionalInfo)

S (Select Row)
P (Previous)
C (Cancel)
H (Help)


Select [S, P, C, H]: [S]

Additional Information Step Extension (additionalInfo)

*Hobbies (hobbies):
*Sports (sports):


Select [C (Cancel), E (Edit)]: [E]
*Hobbies (hobbies): movies;sports
*Sports (sports): cricket;tennis
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
    3. Additional Information Step Extension (additionalInfo)
->  End of task

P (Previous)
F (Finish)
C (Cancel)
H (Help)


Select [P, F, C, H]: [F]
WASX7278I: Generated command line: $AdminTask helloWorldTask {-getPerson {-personName 
   John -countryName USA} -contactInfo {{phone 123-456-7890} {"home phone" 
   xxx-xxx-xxxx} {e-mail john@yahoo.com} {"e-mail address" xxx@yyy.com}} 
   -additionalInfo {-hobbies movies;sports -sports cricket;tennis}}
"Hello World "
John,USA
{phone=123-456-7890 ; home phone=xxx-xxx-xxxx ; e-mail=john@yahoo.com ; e-mail 
   address=xxx@yyy.com}
{hobbies=movies,sports}{sports=cricket,tennis}


3) Choose the "Delete Row" option to delete the selected row in the table

wsadmin>$AdminTask helloWorldTask -interactive
Hello World Task Command

HelloWorld Task Command

-> *1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
C (Cancel)
H (Help)


Select [S, N, C, H]: [S]

personal information step (getPerson)

*Name of Person (personName):
*Name of Country (countryName):


Select [C (Cancel), E (Edit)]: [E]
*Name of Person (personName): John
*Name of Country (countryName): USA
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
->  2. Contact information step. (contactInfo)
   *3. Additional Information Step Extension (additionalInfo)

S (Select)
N (Next)
P (Previous)
C (Cancel)
H (Help)


Select [S, N, P, C, H]: [S]

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
->  | home phone, xxx-xxx-xxxx
    | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, A, D, F, H]: [F] D

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
->  | e-mail address, xxx@yyy.com

contact type, contact value must be provided to specific a row in batch mode.

S (Select Row)
N (Next)
A (Add Row Before)
D (Delete Row)
F (Finish)
H (Help)


Select [S, N, A, D, F, H]: [F] D

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------

A (Add Row)
F (Finish)
H (Help)


Select [A, F, H]: [A]
*contact type (type): home phone
*contact value (value): 123-456-7890

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | home phone, 123-456-7890
->

contact type, contact value must be provided to specific a row in batch mode.

P (Previous)
A (Add Row Before)
F (Finish)
H (Help)


Select [P, A, F, H]: [F] A
*contact type (type): e-mail address
*contact value (value): john@yahoo.com

Contact information step. (contactInfo)

    | contact type (type), contact value (value)
    --------------------------------------------
    | home phone, 123-456-7890
    | e-mail address, john@yahoo.com
->

contact type, contact value must be provided to specific a row in batch mode.

P (Previous)
A (Add Row Before)
F (Finish)
H (Help)


Select [P, A, F, H]: [F]
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
-> *3. Additional Information Step Extension (additionalInfo)

S (Select Row)
P (Previous)
C (Cancel)
H (Help)


Select [S, P, C, H]: [S]

Additional Information Step Extension (additionalInfo)

*Hobbies (hobbies):
*Sports (sports):


Select [C (Cancel), E (Edit)]: [E]
*Hobbies (hobbies): movies;sports
*Sports (sports): cricket;tennis
Hello World Task Command

HelloWorld Task Command

    1. personal information step (getPerson)
    2. Contact information step. (contactInfo)
    3. Additional Information Step Extension (additionalInfo)
->  End of task

P (Previous)
F (Finish)
C (Cancel)
H (Help)


Select [P, F, C, H]: [F]
WASX7278I: Generated command line: $AdminTask helloWorldTask {-getPerson {-personName 
   John -countryName USA} -contactInfo {{"home phone" 123-456-7890} {"e-mail 
   address" john@yahoo.com}} -additionalInfo {-hobbies movies;sports -sports 
   cricket;tennis}}
"Hello World "
John,USA
{home phone=123-456-7890 ; e-mail address=john@yahoo.com}
{hobbies=movies,sports}{sports=cricket,tennis}

wsadmin>$AdminTask helloWorldTask {-getPerson {-personName John -countryName 
   USA} -contactInfo {{phone 123-456-7890} {"home phone" xxx-xxx-xxxx} 
   {e-mail john@yahoo.com} {"e-mail address" xxx@yyy.com}} -additionalInfo 
   {-hobbies movies;sports -sports cricket;tennis}}
"Hello World "
John,USA
{phone=123-456-7890 ; home phone=xxx-xxx-xxxx ; e-mail=john@yahoo.com ; e-mail 
   address=xxx@yyy.com}
{hobbies=movies,sports}{sports=cricket,tennis}

1) Choose the "Select Row" option to modify the existing row 
      property values in the table

wsadmin>AdminTask.helloWorldTask('-interactive')
//same as Jacl interactive mode 
 ...
Select [P, F, C, H]: [F]
WASX7278I: Generated command line: AdminTask.helloWorldTask('[-getPerson 
   [-personName John -countryName USA] -contactInfo [[phone 123-456-7890] [e-mail 
   john@yahoo.com]] -additionalInfo [-hobbies movies;sports -sports ricket;tennis]]')
'Hello World \r\nJohn,USA\r\n{phone=123-456-7890 ; e-mail=john@yahoo.com}\r\n
   {hobbies=movies,sports}
{sports=cricket,tennis}'

2) Choose the "Add Row Before" option to add new rows into table

wsadmin>AdminTask.helloWorldTask('-interactive')
//same as Jacl interactive mode 
 ...
Select [P, F, C, H]: [F]
WASX7278I: Generated command line: AdminTask.helloWorldTask('[-getPerson [-personName 
   John -countryName USA] -contactInfo [["home phone" 123-456-7890] ["home 
   phone" xxx-xxx-xxxx] ["e-mail address" john@yahoo.com] ["e-mail address" 
   xxx@yyy.com]] -additionalInfo [-hobbies movies;sports -sports cricket;tennis]]')
'Hello World \r\nJohn,USA\r\n{home phone=123-456-7890 ; home phone=xxx-xxx-xxxx ; e-mail 
   address=john@yahoo.com ; e-mail address=xxx@yyy.com}\r\n{hobbies=movies,sports}{sports=
   cricket,tennis}'

3) Choose the "Delete Row" option to delete the selected row in the table

wsadmin>AdminTask.helloWorldTask('-interactive')
//same as Jacl interactive mode 
WASX7278I: Generated command line: AdminTask.helloWorldTask('[-getPerson [-personName 
   John -countryName USA] -contactInfo [[e-mail john@yahoo.com]] -additionalInfo 
   [-hobbies movies;sports -sports cricket;tennis]]')
'Hello World \r\nJohn,USA\r\n{e-mail=john@yahoo.com}\r\n{hobbies=movies,sports}
   {sports=cricket,tennis}'

wsadmin>print AdminTask.helloWorldTask('[-getPerson [-personName John 
   -countryName USA] -contactInfo [["home phone" 123-456-7890] 
   ["home phone" xxx-xxx-xxxx] ["e-mail address" john@yahoo.com] 
   ["e-mail address" xxx@yyy.com]] -additionalInfo [-hobbies movies;sports 
   -sports cricket;tennis]]')
Hello World
John,USA
{home phone=xxx-xxx-xxxx ; e-mail address=xxx@yyy.com ; home phone=123-456-7890 ; 
   e-mail address=john@yahoo.com}
{hobbies=movies,sports}{sports=cricket,tennis}

Return type: String:
		Using Jacl:
		wsadmin>$AdminTask helloWorld {-personName John}
	
		Using Jython:
		Wsadmin>print AdminTask.helloWorld('[-personName John]')
		Hello World John

Return type: java.util.Properties:
		Using Jacl:
wsadmin>$AdminTask helloWorld {-personalInfo "{ {cellPhone
   123-456-7890} {workPhone 123-456-7892} {homePhone 123-456-7891} }"}
		{cellPhone 123-456-7890}
		{workPhone 123-456-7892}
		{homePhone 123-456-7891} 

		Using Jython:
Wsadmin>print AdminTask.helloWorld('[-personalInfo "[ [cellPhone 
   123-456-7890] [workPhone 123-456-7892] [homePhone 123-456-7891] ]" 
   ]')
		[cellPhone 123-456-7890]
		[workPhone 123-456-7892]
		[homePhone 123-456-7891]

Return type: String[]:
		Using Jacl:
		wsadmin>$AdminTask helloWorld {-pets dog;cat}

		Using Jython:
		Wsadmin>print AdminTask.helloWorld('[-pets dog;cat]')
		dog
		cat

Return type: javax.management.AttributeList 
	Using Jacl:
	wsadmin>$AdminTask helloWorld {-pets dog;cat}
	{pet dog}
	{pet cat}
	
	Using Jython:
	wsadmin>print AdminTask.helloWorld('[-pets dog;cat]')
	[pet dog]
	[pet cat]

Return type: java.util.ArrayList, java.util.List or java.util.Collection 
	Using Jacl: 
	wsadmin>$AdminTask helloWorld {-pets dog;cat}
		
	Using Jython:
	wsadmin>print AdminTask.helloWorld('[-pets dog;cat]')
	dog
	cat

Return type: javax.management.ObjectName
		Using Jacl:
	wsadmin> $AdminTask helloWorld {-personID WebSphere:
	John(organization=ibm,country=usa,state=texas,city=austin)}

		Using Jython:
	Wsadmin>print AdminTask.helloWorld('[-personID WebSphere:
	John(organization=ibm,country=usa,state=texas,city=austin)]')

		WebSphere:
	John(organization=ibm,country=usa,state=texas,city=Austin