Uses of Class
org.rhq.enterprise.communications.command.param.ParameterDefinition

Packages that use ParameterDefinition

Package	Description
org.rhq.enterprise.communications.command
org.rhq.enterprise.communications.command.impl.echo
org.rhq.enterprise.communications.command.impl.generic
org.rhq.enterprise.communications.command.impl.identify
org.rhq.enterprise.communications.command.impl.remotepojo
org.rhq.enterprise.communications.command.impl.start
org.rhq.enterprise.communications.command.impl.stream
org.rhq.enterprise.communications.command.param

Uses of ParameterDefinition in org.rhq.enterprise.communications.command

Methods in org.rhq.enterprise.communications.command that return ParameterDefinition

Modifier and Type	Method and Description
protected abstract ParameterDefinition[]	AbstractCommand.buildParameterDefinitions() Builds the set of parameter definitions that this command will use.
ParameterDefinition	Command.getParameterDefinition(String paramName) Returns the definition of the named parameter.
ParameterDefinition	AbstractCommand.getParameterDefinition(String paramName)
ParameterDefinition[]	Command.getParameterDefinitions() Returns the set of parameter definitions for all allowable parameters this command accepts.
ParameterDefinition[]	AbstractCommand.getParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.echo

Fields in org.rhq.enterprise.communications.command.impl.echo declared as ParameterDefinition

Modifier and Type	Field and Description
static ParameterDefinition	EchoCommand.PARAM_MESSAGE the required command parameter name that identifies the message to echo back to the client
static ParameterDefinition	EchoCommand.PARAM_PREFIX the optional command parameter name that identifies a string to prefix the echo message

Methods in org.rhq.enterprise.communications.command.impl.echo that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	EchoCommand.buildParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.generic

Methods in org.rhq.enterprise.communications.command.impl.generic that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	GenericCommand.buildParameterDefinitions()

Methods in org.rhq.enterprise.communications.command.impl.generic with parameters of type ParameterDefinition

Modifier and Type	Method and Description
void	GenericCommand.setParameterDefinitions(ParameterDefinition[] newParameterDefinitions) Allows the caller to modify this custom command's parameter definitions.

Constructors in org.rhq.enterprise.communications.command.impl.generic with parameters of type ParameterDefinition

Constructor and Description
GenericCommand(CommandType commandType, ParameterDefinition[] paramDefs) Specialized constructor for GenericCommand that allows the instantiator to dynamically define this generic commands metadata at runtime.

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.identify

Methods in org.rhq.enterprise.communications.command.impl.identify that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	IdentifyCommand.buildParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.remotepojo

Fields in org.rhq.enterprise.communications.command.impl.remotepojo declared as ParameterDefinition

Modifier and Type	Field and Description
static ParameterDefinition	RemotePojoInvocationCommand.PARAM_INVOCATION the required command parameter name containing the NameBasedInvocation object to describe what method to invoke on the remote POJO.
static ParameterDefinition	RemotePojoInvocationCommand.PARAM_TARGET_INTERFACE_NAME the remote POJO's interface that the command wants to invoke.

Methods in org.rhq.enterprise.communications.command.impl.remotepojo that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	RemotePojoInvocationCommand.buildParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.start

Fields in org.rhq.enterprise.communications.command.impl.start declared as ParameterDefinition

Modifier and Type	Field and Description
static ParameterDefinition	StartCommand.PARAM_ARGS identifies the parameter whose value is an array of arguments to pass to the executable
static ParameterDefinition	StartCommand.PARAM_BACKUP_OUTPUT_FILE identifies the parameter whose value is the flag to determine whether to backup any previously existing output file; if false, it will be overwritten
static ParameterDefinition	StartCommand.PARAM_CAPTURE_OUTPUT identifies the parameter whose value is the flag to determine if the started process's output should be dumped to the output file
static ParameterDefinition	StartCommand.PARAM_ENV identifies the parameter whose value is an Properties object containing environment variable name/value pairs to give to the process
static ParameterDefinition	StartCommand.PARAM_INPUT_DIR identifies the parameter whose value is the directory location of the file that contains data to be fed into the programs' stdin input stream
static ParameterDefinition	StartCommand.PARAM_INPUT_FILE identifies the parameter whose value is the file name that contains data to be fed into the programs' stdin input stream
static ParameterDefinition	StartCommand.PARAM_OUTPUT_DIR identifies the parameter whose value is the directory where the process's output log will be written
static ParameterDefinition	StartCommand.PARAM_OUTPUT_FILE identifies the parameter whose value is the filename (in the output directory) where the process's stdout/stderr output log will be written
static ParameterDefinition	StartCommand.PARAM_PROGRAM_DIR identifies the parameter whose value is the full path to the program's executable
static ParameterDefinition	StartCommand.PARAM_PROGRAM_EXE identifies the parameter whose value is the name of the program to execute
static ParameterDefinition	StartCommand.PARAM_PROGRAM_TITLE identifies the parameter whose value is a simple title for this start command configuration (may be used for output filename)
static ParameterDefinition	StartCommand.PARAM_WAIT_FOR_EXIT identifies the parameter whose value is the time to wait until the process has exited
static ParameterDefinition	StartCommand.PARAM_WORKING_DIR identifies the parameter whose value is directory location to start the process in (the working directory).

Methods in org.rhq.enterprise.communications.command.impl.start that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	StartCommand.buildParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.impl.stream

Fields in org.rhq.enterprise.communications.command.impl.stream declared as ParameterDefinition

Modifier and Type	Field and Description
static ParameterDefinition	RemoteOutputStreamCommand.PARAM_INVOCATION the required command parameter name containing the NameBasedInvocation object to describe what method to invoke on the remote stream.
static ParameterDefinition	RemoteInputStreamCommand.PARAM_INVOCATION the required command parameter name containing the NameBasedInvocation object to describe what method to invoke on the remote stream.
static ParameterDefinition	RemoteOutputStreamCommand.PARAM_STREAM_ID the required command parameter name containing the opaque identification object used to specify the particular output stream that is to be invoked.
static ParameterDefinition	RemoteInputStreamCommand.PARAM_STREAM_ID the required command parameter name containing the opaque identification object used to specify the particular input stream that is to be invoked.

Methods in org.rhq.enterprise.communications.command.impl.stream that return ParameterDefinition

Modifier and Type	Method and Description
protected ParameterDefinition[]	RemoteOutputStreamCommand.buildParameterDefinitions()
protected ParameterDefinition[]	RemoteInputStreamCommand.buildParameterDefinitions()

Uses of ParameterDefinition in org.rhq.enterprise.communications.command.param

Subclasses of ParameterDefinition in org.rhq.enterprise.communications.command.param

Modifier and Type	Class and Description
class	DynamicFixedValuesParameterDefinition Provides a fixed set of parameter values that are allowed just like its superclass, however, this subclass allows that set of fixed values to be changed dynamically after this object is instantiated.
class	FixedValuesParameterDefinition An extenstion to a parameter definition that defines a limited, fixed set of values that are allowed to be assigned to the parameter.
class	MapValueParameterDefinition An extension to a parameter definition that marks the parameter as holding a map of values.

Methods in org.rhq.enterprise.communications.command.param that return ParameterDefinition

Modifier and Type	Method and Description
ParameterDefinition	Parameter.getDefinition() Returns the parameter's definition.
ParameterDefinition	Parameters.getParameterDefinition(String parameterName) Given the name of a parameter, this will return the parameter's definition.
ParameterDefinition	ParametersImpl.getParameterDefinition(String parameterName)

Constructors in org.rhq.enterprise.communications.command.param with parameters of type ParameterDefinition

Constructor and Description
AbstractParameterDefinitionIterator(ParameterDefinition[] parameterDefinitions, boolean required) A convienence constructor that allows you to create a new AbstractParameterDefinitionIterator object given an array of parameter definitions, as opposed to a Collection.
OptionalParameterDefinitionIterator(ParameterDefinition[] parameterDefinitions) Constructor for OptionalParameterDefinitionIterator that provides an iterator over an array of parameter definitions - of which only the optional ones will be iterated.
Parameter(ParameterDefinition definition, Object value) Constructor for Parameter with the given initializers.
Parameter(ParameterDefinition definition, Object value, boolean isDirty) Creates a new Parameter object given the individual parts of the parameter.
RequiredParameterDefinitionIterator(ParameterDefinition[] parameterDefinitions) Constructor for RequiredParameterDefinitionIterator that provides an iterator over an array of parameter definitions - of which only the required ones will be iterated.

Constructor parameters in org.rhq.enterprise.communications.command.param with type arguments of type ParameterDefinition

Constructor and Description
AbstractParameterDefinitionIterator(Collection<ParameterDefinition> parameterDefinitions, boolean required) Constructor for AbstractParameterDefinitionIterator given the collection of parameter definitions.
OptionalParameterDefinitionIterator(Collection<ParameterDefinition> parameterDefinitions) Constructor for OptionalParameterDefinitionIterator that provides an iterator over a collection of parameter definitions - of which only the optional ones will be iterated.
RequiredParameterDefinitionIterator(Collection<ParameterDefinition> parameterDefinitions) Constructor for RequiredParameterDefinitionIterator that provides an iterator over a collection of parameter definitions - of which only the required ones will be iterated.