com.ibm.websphere.management.cmdframework

Class CommandMgr

java.lang.Object

com.ibm.websphere.management.cmdframework.CommandMgr

public abstract class CommandMgr
extends java.lang.Object

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:

• query available admin commands and admin command groups
• query meta data regarding to any admin command.
• create an admin command
• load a serialized admin command
• basic command history functionality

Field Summary

Fields

Modifier and Type	Field and Description
protected static CommandMgr	cmdMgr
protected static boolean	initialized

Constructor Summary

Constructors

Constructor and Description
CommandMgr()

Method Summary

Methods

Modifier and Type	Method and Description
abstract AdminCommand	createCommand(java.lang.String command) Creates an admin command
static AdminClient	getAdminClient() Get the AdminClient associate with the most recent ClientCommandMgr called by getCommandMgr(AdminClient adminclient).
abstract java.util.Collection	getAllCommandGroupMetadata() Returns the metadata for a all the command groups.
abstract java.util.Collection	getAllCommandMetadata()
static CommandMgr	getClientCommandMgr(AdminClient adminclient) Deprecated. As of release 7.0, replaced by getCommandMgr(AdminClient)
abstract com.ibm.websphere.management.cmdframework.commandmetadata.CommandGroupMetadata	getCommandGroupMetadata(java.lang.String commandGrp) Returns the metadata for a particular command group.
abstract com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata	getCommandMetadata(java.lang.String commandName) Returns the command metadata for a particular command.
static CommandMgr	getCommandMgr() Access method to get the CommandMgr instance.
static CommandMgr	getCommandMgr(AdminClient adminclient) Access method to get the CommandMgr instance in client mode.
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

cmdMgr

protected static CommandMgr cmdMgr

initialized

protected static boolean initialized

Constructor Detail

CommandMgr

public CommandMgr()

Method Detail

getCommandMgr

public static CommandMgr getCommandMgr()

Access method to get the CommandMgr instance.

Returns:

the CommandMgr instance. Returns null if the CommandMgrinitializer failed to initialize command manager properly.

If getClientCommandMgr(AdminClient) has been called prior to call this getCommandMgr() then the same client command manager will be returned.

Otherwise, it will return a server command manager if AdminService is available, or return a local command manager if AdminService is not available. The subsequence getCommandMgr() call after this will return the same server (or local) command manager.

getClientCommandMgr

public static CommandMgr getClientCommandMgr(AdminClient adminclient)
                                      throws CommandMgrInitException

Deprecated. As of release 7.0, replaced by getCommandMgr(AdminClient)

Access method to get the CommandMgr instance in client mode. The subsequence getCommandMgr() call after this getClientCommandMgr(AdminClient) will return the same client command manager.

Returns:

the CommandMgr instance.

Throws:

CommandMgrInitException.

CommandMgrInitException

getCommandMgr

public static CommandMgr getCommandMgr(AdminClient adminclient)
                                throws CommandMgrInitException

Access method to get the CommandMgr instance in client mode. As of release 7.0, this method is the replacement of getClientCommandMgr(AdminClient). Unlike getClientCommandMgr(AdminClient), the subsequence getCommandMgr() call after this getCommandMgr(AdminClient) will not return a client command manager. Caller to this method needs to cache and manage the returned CommandMgr object for reuse.

Parameters:

adminclient - the AdminClient object that represents a remote server for command execution.

Returns:

A new CommandMgr instance.

Throws:

CommandMgrInitException

getAdminClient

public static AdminClient getAdminClient()

Get the AdminClient associate with the most recent ClientCommandMgr called by getCommandMgr(AdminClient adminclient). This method may return a null pointer if ClientCommandMgr has not been initialized by calling getCommandMgr(AdminClient adminclient). It is caller's responsibility to check the returned object, before using it.

Returns:

an AdminClient object that is associate with the ClientCommandMgr.

listCommandGroups

public abstract java.util.Collection listCommandGroups()
                                                throws ConnectorException,
                                                       CommandException

Lists all the admin command groups.

Returns:

a collection of the command group names.

Throws:

ConnectorException

CommandException

listCommands

public abstract java.util.Collection listCommands(java.lang.String commandGroup)
                                           throws ConnectorException,
                                                  CommandException

Lists all the admin commands in a particular command group.

Parameters:

commandGroup - a command group name.

Returns:

a collection of admin command names in the specified command group.

Throws:

ConnectorException

CommandException

listCommands

public abstract java.util.Collection listCommands()
                                           throws ConnectorException,
                                                  CommandException

Lists all the admin commands.

Returns:

a collection of admin command names.

Throws:

ConnectorException

CommandException

listAllCommands

public abstract java.util.Collection listAllCommands()
                                              throws ConnectorException,
                                                     CommandException

Throws:

ConnectorException

CommandException

getCommandMetadata

public abstract com.ibm.websphere.management.cmdframework.commandmetadata.CommandMetadata getCommandMetadata(java.lang.String commandName)
                                                                                                      throws ConnectorException,
                                                                                                             CommandNotFoundException,
                                                                                                             CommandException

Returns the command metadata for a particular command.

Parameters:

commandName - an admin command name.

Returns:

the command metadata of the specified admin command.

Throws:

CommandNotFoundException - if the specified admin command is not found.

ConnectorException

CommandException

getAllCommandMetadata

public abstract java.util.Collection getAllCommandMetadata()
                                                    throws ConnectorException,
                                                           CommandException

Throws:

ConnectorException

CommandException

getCommandGroupMetadata

public abstract com.ibm.websphere.management.cmdframework.commandmetadata.CommandGroupMetadata getCommandGroupMetadata(java.lang.String commandGrp)
                                                                                                                throws ConnectorException,
                                                                                                                       CommandNotFoundException,
                                                                                                                       CommandException

Returns the metadata for a particular command group.

Parameters:

commandGrp - a command group name

Returns:

metadata for the specified command group.

Throws:

CommandNotFoundException - if the specified command group is not found.

ConnectorException

CommandException

getAllCommandGroupMetadata

public abstract java.util.Collection getAllCommandGroupMetadata()
                                                         throws ConnectorException,
                                                                CommandNotFoundException,
                                                                CommandException

Returns the metadata for a all the command groups.

Returns:

Collection of metadata for the command groups.

Throws:

CommandNotFoundException - if the specified command group is not found.

ConnectorException

CommandException

createCommand

public abstract AdminCommand createCommand(java.lang.String command)
                                    throws CommandNotFoundException,
                                           CommandException,
                                           ConnectorException

Creates an admin command

Parameters:

command - an admin command name.

Returns:

an admin Command instance for the specified command name.

Throws:

CommandNotFoundException - if the specified admin command is not found.

CommandException

ConnectorException

loadCommand

public abstract AdminCommand loadCommand(java.io.InputStream serializedCmd)
                                  throws CommandLoadException,
                                         ConnectorException,
                                         CommandException

Loads an admin command from its serialized format into memory.

Parameters:

serializedCmd - an inputstream that contains a serialized admin command.

Returns:

an instance of admin Command.

Throws:

CommandLoadException - command framework failed to load the admin command.

ConnectorException

CommandException

getCommandProviderHelper

public abstract CommandProviderHelper getCommandProviderHelper()

Returns a proper implementation of CommandProviderHelper for the current command execution environment.