org.rhq.enterprise.communications.command.impl.remotepojo

Class RemotePojoInvocationCommand

java.lang.Object

org.rhq.enterprise.communications.command.AbstractCommand

org.rhq.enterprise.communications.command.impl.remotepojo.RemotePojoInvocationCommand

All Implemented Interfaces:

Serializable, Command

public class RemotePojoInvocationCommand
extends AbstractCommand

The command to be sent when a remote invocation on a POJO is to be made.

Author:

John Mazzitelli

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CommandType	COMMAND_TYPE command type constant identifying this type of command
static ParameterDefinition	PARAM_INVOCATION the required command parameter name containing the NameBasedInvocation object to describe what method to invoke on the remote POJO.
static ParameterDefinition	PARAM_TARGET_INTERFACE_NAME the remote POJO's interface that the command wants to invoke.

Constructor Summary

Constructors

Constructor and Description
RemotePojoInvocationCommand() Constructor for RemotePojoInvocationCommand.
RemotePojoInvocationCommand(Command commandToTransform) Constructor for RemotePojoInvocationCommand.
RemotePojoInvocationCommand(Map<String,Object> commandParameters) Constructor for RemotePojoInvocationCommand.

Method Summary

Methods

Modifier and Type	Method and Description
protected CommandType	buildCommandType() Builds the command type of this command.
protected ParameterDefinition[]	buildParameterDefinitions() Builds the set of parameter definitions that this command will use.
org.jboss.remoting.invocation.NameBasedInvocation	getNameBasedInvocation() Gets the invocation information that describes what needs to be invoked on the remote POJO.
String	getTargetInterfaceName() Returns the name of the remote POJO's target interface that is being invoked.
void	setNameBasedInvocation(org.jboss.remoting.invocation.NameBasedInvocation invocation) Sets the invocation information that describes what needs to be invoked on the remote POJO.
void	setTargetInterfaceName(String targetInterfaceName) Sets the name of the remote POJO's target interface that is being invoked.

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

PARAM_INVOCATION

public static final ParameterDefinition PARAM_INVOCATION

the required command parameter name containing the NameBasedInvocation object to describe what method to invoke on the remote POJO.

PARAM_TARGET_INTERFACE_NAME

public static final ParameterDefinition PARAM_TARGET_INTERFACE_NAME

the remote POJO's interface that the command wants to invoke.

Constructor Detail

RemotePojoInvocationCommand

public RemotePojoInvocationCommand()
                            throws IllegalArgumentException,
                                   InvalidParameterDefinitionException

Constructor for RemotePojoInvocationCommand.

Throws:

IllegalArgumentException

InvalidParameterDefinitionException

See Also:

AbstractCommand.AbstractCommand()

RemotePojoInvocationCommand

public RemotePojoInvocationCommand(Map<String,Object> commandParameters)
                            throws IllegalArgumentException,
                                   InvalidParameterDefinitionException

Constructor for RemotePojoInvocationCommand.

Throws:

IllegalArgumentException

InvalidParameterDefinitionException

See Also:

AbstractCommand.AbstractCommand(Map)

RemotePojoInvocationCommand

public RemotePojoInvocationCommand(Command commandToTransform)

Constructor for RemotePojoInvocationCommand.

See Also:

AbstractCommand.AbstractCommand(Command)

Method Detail

getNameBasedInvocation

public org.jboss.remoting.invocation.NameBasedInvocation getNameBasedInvocation()

Gets the invocation information that describes what needs to be invoked on the remote POJO.

Returns:

the invocation information

setNameBasedInvocation

public void setNameBasedInvocation(org.jboss.remoting.invocation.NameBasedInvocation invocation)

Sets the invocation information that describes what needs to be invoked on the remote POJO.

Parameters:

invocation - the invocation information

getTargetInterfaceName

public String getTargetInterfaceName()

Returns the name of the remote POJO's target interface that is being invoked.

Returns:

the name of the target POJO's interface

setTargetInterfaceName

public void setTargetInterfaceName(String targetInterfaceName)

Sets the name of the remote POJO's target interface that is being invoked.

Parameters:

targetInterfaceName - the name of the target POJO's interface

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()