|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.websphere.management.cmdframework.CommandMgr
public abstract class CommandMgr
Main interface for the command framework component.
Wherever the term of admin command is referred here, it refers to either a
simple admin command AdminCommand
or a complex admin command,
i.e. a TaskCommand
that includes multiple CommandSteps
Each admin command and command group must have a unique non-localized name for user to identify the command or command group. The concept of command group is introduced to group a set of related commands together so that users can find the related commands easily. A command may belong to multiple command groups if a command may be used in multiple areas. In other words, a command group does not own the commands in the group.
This class provides following areas of functionalities:
Field Summary | |
---|---|
protected static CommandMgr |
cmdMgr
|
protected static boolean |
initialized
|
Constructor Summary | |
---|---|
CommandMgr()
|
Method Summary | |
---|---|
abstract AdminCommand |
createCommand(java.lang.String command)
Creates an admin command |
abstract java.util.Collection |
getAllCommandGroupMetadata()
Returns the metadata for a all the command groups. |
abstract java.util.Collection |
getAllCommandMetadata()
|
static CommandMgr |
getClientCommandMgr(AdminClient adminclient)
Access method to get the CommandMgr instance in client mode. |
abstract CommandGroupMetadata |
getCommandGroupMetadata(java.lang.String commandGrp)
Returns the metadata for a particular command group. |
abstract CommandMetadata |
getCommandMetadata(java.lang.String commandName)
Returns the command metadata for a particular command. |
static CommandMgr |
getCommandMgr()
Access method to get the CommandMgr instance. |
abstract CommandProviderHelper |
getCommandProviderHelper()
Returns a proper implementation of CommandProviderHelper for the current command execution environment. |
abstract java.util.Collection |
listAllCommands()
|
abstract java.util.Collection |
listCommandGroups()
Lists all the admin command groups. |
abstract java.util.Collection |
listCommands()
Lists all the admin commands. |
abstract java.util.Collection |
listCommands(java.lang.String commandGroup)
Lists all the admin commands in a particular command group. |
abstract AdminCommand |
loadCommand(java.io.InputStream serializedCmd)
Loads an admin command from its serialized format into memory. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static CommandMgr cmdMgr
protected static boolean initialized
Constructor Detail |
---|
public CommandMgr()
Method Detail |
---|
public static CommandMgr getCommandMgr()
public static CommandMgr getClientCommandMgr(AdminClient adminclient) throws CommandMgrInitException
CommandMgrInitException.
CommandMgrInitException
public abstract java.util.Collection listCommandGroups() throws ConnectorException, CommandException
ConnectorException
CommandException
public abstract java.util.Collection listCommands(java.lang.String commandGroup) throws ConnectorException, CommandException
commandGroup
- a command group name.
ConnectorException
CommandException
public abstract java.util.Collection listCommands() throws ConnectorException, CommandException
ConnectorException
CommandException
public abstract java.util.Collection listAllCommands() throws ConnectorException, CommandException
ConnectorException
CommandException
public abstract CommandMetadata getCommandMetadata(java.lang.String commandName) throws ConnectorException, CommandNotFoundException, CommandException
commandName
- an admin command name.
CommandNotFoundException
- if the specified admin command is not found.
ConnectorException
CommandException
public abstract java.util.Collection getAllCommandMetadata() throws ConnectorException, CommandException
ConnectorException
CommandException
public abstract CommandGroupMetadata getCommandGroupMetadata(java.lang.String commandGrp) throws ConnectorException, CommandNotFoundException, CommandException
commandGrp
- a command group name
CommandNotFoundException
- if the specified command group is not found.
ConnectorException
CommandException
public abstract java.util.Collection getAllCommandGroupMetadata() throws ConnectorException, CommandNotFoundException, CommandException
CommandNotFoundException
- if the specified command group is not found.
ConnectorException
CommandException
public abstract AdminCommand createCommand(java.lang.String command) throws CommandNotFoundException, CommandException, ConnectorException
command
- an admin command name.
CommandNotFoundException
- if the specified admin command is not found.
CommandException
ConnectorException
public abstract AdminCommand loadCommand(java.io.InputStream serializedCmd) throws CommandLoadException, ConnectorException, CommandException
serialziedCmd
- an inputstream that contains a serialized admin command.
CommandLoadException
- command framework failed to load the admin command.
ConnectorException
CommandException
public abstract CommandProviderHelper getCommandProviderHelper()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |