com.ibm.commerce.command
Class AsyncControllerCommandImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.command.AsyncControllerCommandImpl
- All Implemented Interfaces:
- AccCommand, AsyncCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable
- Direct Known Subclasses:
- 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.
Method Summary |
java.lang.Long |
getJobInstanceId()
Return the instance Id for this job as set in the SCHSTATUS table. |
java.lang.Long |
getJobReferenceId()
Return 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 |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setRequestProperties, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, performExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
jobInstanceId
protected java.lang.Long jobInstanceId
jobReferenceId
protected java.lang.Long jobReferenceId
AsyncControllerCommandImpl
public AsyncControllerCommandImpl()
- AsyncControllerCommandImpl constructor.
getJobInstanceId
public final java.lang.Long getJobInstanceId()
- Return the instance Id for this job as set in the SCHSTATUS table.
- Specified by:
getJobInstanceId
in interface AsyncCommand
- Returns:
- java.lang.Long
getJobReferenceId
public final java.lang.Long getJobReferenceId()
- Return the refernce Id for this job as set in the SCHCONFIG table.
- Specified by:
getJobReferenceId
in interface AsyncCommand
- Returns:
- java.lang.Long
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
- java.lang.Long
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:
param
- java.lang.Long