com.ibm.commerce.command
Class AsyncControllerCommandImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.command.AsyncControllerCommandImpl
All Implemented Interfaces:
AccCommand, AsyncCommand, ControllerCommand, ECCommand, ECTargetableCommand
Direct Known Subclasses:
ContractTCDeployCmdImpl, RefreshLocalRegistryCmdImpl, ScheduledContractDeployCmdImpl

public class AsyncControllerCommandImpl
extends ControllerCommandImpl
implements AsyncCommand

AsyncControllerCommandImpl is the default based implementation of a controller command that implements the AsyncCommand interface. A long running job that needs to be scheduled by the scheduler can extends from the class. An asynchronize controller command will be invoke by the scheduler. The scheduler will not update the SCHSTATUS table when it returns from the execute method of the asynchronize controller command. Instead, the command will be passed the job instance Id (SCHSTATUS table) and the job reference Id (SCHCONFIG table) The command would typically dispatch a job to be run on a seperate thread and then returns. The job will update the SCHSTATUS table when it finishes execution.

See Also:
Serialized Form

Field Summary
protected  java.lang.Long jobInstanceId
           
protected  java.lang.Long jobReferenceId
           
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.command. AsyncCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ControllerCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand
COPYRIGHT
 
Constructor Summary
AsyncControllerCommandImpl()
          Constructor for AsyncControllerCommandImpl.
 
Method Summary
 java.lang.Long getJobInstanceId()
          Gets the instance Id for this job as set in the SCHSTATUS table.
 java.lang.Long getJobReferenceId()
          Gets the refernce Id for this job as set in the SCHCONFIG table.
 void setJobInstanceId(java.lang.Long val)
          Sets the instance Id for this job as set in the SCHSTATUS table.
 void setJobReferenceId(java.lang.Long val)
          Sets the refernce Id for this job as set in the SCHCONFIG table.
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setRequestProperties, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
execute
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, setAccCheck
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail

jobReferenceId

protected java.lang.Long jobReferenceId

jobInstanceId

protected java.lang.Long jobInstanceId
Constructor Detail

AsyncControllerCommandImpl

public AsyncControllerCommandImpl()
Constructor for AsyncControllerCommandImpl.
Method Detail

getJobInstanceId

public final java.lang.Long getJobInstanceId()
Gets the instance Id for this job as set in the SCHSTATUS table.
Specified by:
getJobInstanceId in interface AsyncCommand
Returns:
job instance ID

getJobReferenceId

public final java.lang.Long getJobReferenceId()
Gets the refernce Id for this job as set in the SCHCONFIG table.
Specified by:
getJobReferenceId in interface AsyncCommand
Returns:
job reference ID

setJobInstanceId

public final void setJobInstanceId(java.lang.Long val)
Sets the instance Id for this job as set in the SCHSTATUS table.
Specified by:
setJobInstanceId in interface AsyncCommand
Parameters:
val - job instance ID

setJobReferenceId

public final void setJobReferenceId(java.lang.Long val)
Sets the refernce Id for this job as set in the SCHCONFIG table.
Specified by:
setJobReferenceId in interface AsyncCommand
Parameters:
val - job reference ID