|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.integrations.BaseCommand
public abstract class BaseCommand
Base Command class that specific implementations can extend. This class
provides default implementations of all methods except for the
invokeRPC(Object)
.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
BaseCommand()
|
Method Summary | |
---|---|
void |
doStartService()
This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. |
CommandResult |
execute(java.lang.Object pInput)
Application code should call this method to execute a RPC call This method will check to see if there is a CommandHandler configured on this component and if so, will call the executeCommand()
on that particular CommandHandler. |
CommandHandler |
getCommandHandler()
The CommandHandler that will be called by this RPC Client to handle the execution of a Command. |
java.util.Map |
getContext()
Contextual information that can be passed. |
abstract CommandResult |
invokeRPC(java.lang.Object pInput)
Abstract method. |
void |
setCommandHandler(CommandHandler pCommandHandler)
Set the CommandHandler property. |
void |
setContext(java.util.Map pContext)
Set the Conext property. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public BaseCommand()
Method Detail |
---|
public CommandHandler getCommandHandler()
execute()
is called on
this component it checks this property for a configured CommandHandler.
getCommandHandler
in interface Command
public void setCommandHandler(CommandHandler pCommandHandler)
pCommandHandler
- public java.util.Map getContext()
getContext
in interface Command
public void setContext(java.util.Map pContext)
pContext
- public void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic CommandResult execute(java.lang.Object pInput) throws CommandInvocationException, CommandTimeoutException, InvalidInputException
executeCommand()
on that particular CommandHandler.
If no CommandHandler is configured then the
invokeRPC(Object)
method is called.
This method has PerformanceMonitor code associated with it. If the PerformanceMonitor is enabled, this method will generate statistics on how long it takes to execute the Command.
execute
in interface Command
pInput
- input object to pass to the command
CommandInvocationException
- if an error occurs
CommandTimeoutException
- if time expires for the command.
InvalidInputException
- if input object passed is invalid.public abstract CommandResult invokeRPC(java.lang.Object pInput) throws CommandInvocationException, CommandTimeoutException, InvalidInputException
invokeRPC
in interface Command
pInput
- object
CommandInvocationException
- if an error occurs
CommandTimeoutException
- if time expires for the command.
InvalidInputException
- if input object passed is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |