RemoteCommandMgr MBean

Partial ObjectName:
WebSphere:*,type=RemoteCommandMgr


MBean RemoteCommandMgr

Remote Command Manager for Command Framework


Operation Summary
java.util.ArrayListlistCommandGroups()
           List available command groups
java.util.ArrayListlistCommands(java.lang.String commandGroup)
           List available commands in command group
java.util.ArrayListlistCommands()
           List available commands
java.util.ArrayListlistAllCommands()
           List All available commands
com.ibm.websphere.management.cmdframework.CommandResultexecute(com.ibm.ws.management.cmdframework.impl.EObjectSerializer command)
           execute a admin command.
com.ibm.websphere.management.cmdframework.CommandResultexecute(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session, com.ibm.ws.management.cmdframework.impl.EObjectSerializer command)
           execute a admin task command.
com.ibm.ws.management.cmdframework.impl.EObjectSerializergetCurrentStep(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session, com.ibm.ws.management.cmdframework.impl.EObjectSerializer cliCmdStepDataEObj, java.lang.Integer operationType, java.lang.String operationType)
           Returns current step in the task
java.util.ArrayListcontructSteps(java.lang.String taskCmdName)
           Construct steps in the task
com.ibm.ws.management.cmdframework.impl.EObjectSerializergetCommandGroupMetaInfo(java.lang.String commandGrpName, java.util.Locale locale)
           returns the group meta information for the specified command.
com.ibm.ws.management.cmdframework.impl.EObjectSerializergetCommandMetaInfo(java.lang.String commandName, java.util.Locale locale)
           returns the meta information for the specified command.
java.util.CollectiongetAllCommandMetaInfo(java.util.Locale locale)
           returns the meta information for the all commands.

Operation Detail

listCommandGroups

public java.util.ArrayList listCommandGroups()
List available command groups
Security Roles:
administrator
operator
configurator
monitor

listCommands

public java.util.ArrayList listCommands(java.lang.String commandGroup)
List available commands in command group
Parameters:
commandGroup - command group name
Security Roles:
administrator
operator
configurator
monitor

listCommands

public java.util.ArrayList listCommands()
List available commands
Security Roles:
administrator
operator
configurator
monitor

listAllCommands

public java.util.ArrayList listAllCommands()
List All available commands
Security Roles:
administrator
operator
configurator
monitor

execute

public com.ibm.websphere.management.cmdframework.CommandResult execute(com.ibm.ws.management.cmdframework.impl.EObjectSerializer command)
execute a admin command.
Parameters:
command - command parameter
Security Roles:
administrator
operator
configurator
monitor

execute

public com.ibm.websphere.management.cmdframework.CommandResult execute(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session, com.ibm.ws.management.cmdframework.impl.EObjectSerializer command)
execute a admin task command.
Parameters:
session - command parameter1
command - command parameter2
Security Roles:
administrator
operator
configurator
monitor

getCurrentStep

public com.ibm.ws.management.cmdframework.impl.EObjectSerializer getCurrentStep(com.ibm.ws.management.cmdframework.impl.TaskCommandSession session, com.ibm.ws.management.cmdframework.impl.EObjectSerializer cliCmdStepDataEObj, java.lang.Integer operationType, java.lang.String operationType)
Returns current step in the task
Parameters:
session - The session for the task
cliCmdStepDataEObj - The step data from client
operationType - The operation to perform
operationType - The step to goto perform
Security Roles:
administrator
operator
configurator
monitor

contructSteps

public java.util.ArrayList contructSteps(java.lang.String taskCmdName)
Construct steps in the task
Parameters:
taskCmdName - The name for the task
Security Roles:
administrator
operator
configurator
monitor

getCommandGroupMetaInfo

public com.ibm.ws.management.cmdframework.impl.EObjectSerializer getCommandGroupMetaInfo(java.lang.String commandGrpName, java.util.Locale locale)
returns the group meta information for the specified command.
Parameters:
commandGrpName - Command group name to look up command metadata
locale - The locale of the client
Security Roles:
administrator
operator
configurator
monitor

getCommandMetaInfo

public com.ibm.ws.management.cmdframework.impl.EObjectSerializer getCommandMetaInfo(java.lang.String commandName, java.util.Locale locale)
returns the meta information for the specified command.
Parameters:
commandName - Command name to look up command metadata
locale - The locale of the client
Security Roles:
administrator
operator
configurator
monitor

getAllCommandMetaInfo

public java.util.Collection getAllCommandMetaInfo(java.util.Locale locale)
returns the meta information for the all commands.
Parameters:
locale - The locale of the client
Security Roles:
administrator
operator
configurator
monitor

Copyright IBM Corp. 1996-2005