org.rhq.enterprise.communications.command.impl.identify
Class IdentifyCommand

java.lang.Object
  org.rhq.enterprise.communications.command.AbstractCommand
      org.rhq.enterprise.communications.command.impl.identify.IdentifyCommand

All Implemented Interfaces:

Serializable, Command

public class IdentifyCommand
extends AbstractCommand

The IDENTIFY command used for clients to ask a server for identification.

Author:

John Mazzitelli

See Also:

Serialized Form

Field Summary

static CommandType

COMMAND_TYPE command type constant identifying this type of command

Constructor Summary

IdentifyCommand()
Constructor for IdentifyCommand.

IdentifyCommand(Command commandToTransform)
Constructor for IdentifyCommand.

Method Summary

protected CommandType	buildCommandType() Builds the command type of this command.
protected ParameterDefinition[]	buildParameterDefinitions() Builds the set of parameter definitions that this command will use.

Methods inherited from class org.rhq.enterprise.communications.command.AbstractCommand

allowAnyParameter, checkParameterValidity, convertParameters, getCommandType, getConfiguration, getParameterDefinition, getParameterDefinitions, getParameterValue, getParameterValues, getParameterValuesInternalMap, hasParameterValue, initializeMetadata, isCommandInResponse, removeParameterValue, removeParameterValues, setCommandInResponse, setParameterValue, setParameterValuesInternalMap, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMAND_TYPE

public static final CommandType COMMAND_TYPE

command type constant identifying this type of command

Constructor Detail

IdentifyCommand

public IdentifyCommand()
                throws IllegalArgumentException,
                       InvalidParameterDefinitionException

Constructor for IdentifyCommand.

Throws:

IllegalArgumentException

InvalidParameterDefinitionException

See Also:

AbstractCommand.AbstractCommand()

IdentifyCommand

public IdentifyCommand(Command commandToTransform)

Constructor for IdentifyCommand.

See Also:

AbstractCommand.AbstractCommand(Command)

Method Detail

buildCommandType

protected CommandType buildCommandType()

Description copied from class: AbstractCommand

Builds the command type of this command. It must not be null.

This method is called by the command's constructors.

Specified by:

buildCommandType in class AbstractCommand

Returns:

the command's type definition; must not be null

See Also:

AbstractCommand.buildCommandType()

buildParameterDefinitions

protected ParameterDefinition[] buildParameterDefinitions()

Description copied from class: AbstractCommand

Builds the set of parameter definitions that this command will use. Parameter definitions define what parameters this command accepts. Implementors must return one of the following:

• An array of one or more definitions if the command accepts required and/or optional parameters
• An empty array if the command does not accept any parameters (i.e. a no-arg command)
• null if the command accepts any and all parameters, regardless of name or type

This method is called by the command's constructors.

Specified by:

buildParameterDefinitions in class AbstractCommand

Returns:

an array of parameter definitions or null

See Also:

AbstractCommand.buildParameterDefinitions()