java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.scheduler.commands.UpdateRegistryCmdImpl
Refreshes a registry component in the runtime cache.
The parameters the command recognizes are as follows.
This command creates a broadcast job that runs the UpdateLocalRegistry command. After puts the information needed to redirect to the specified URL.
Field Summary | |
---|---|
protected
java.lang.String |
action |
protected
java.lang.Long |
jobId |
protected
java.lang.Long |
jobInstanceId |
protected
java.lang.String |
key |
protected
Registry |
registry |
protected
java.lang.String |
registryName |
protected
java.lang.String |
url |
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.scheduler.commands. UpdateRegistryCmd |
COPYRIGHT,
defaultCommandClassName,
URLNAME |
Fields inherited from interface com.ibm.commerce.command. ControllerCommand |
COPYRIGHT |
Constructor Summary | |
---|---|
UpdateRegistryCmdImpl() Creates the UpdateRegistry command object. |
Method Summary | |
---|---|
protected
java.lang.String |
getItemKey() Deprecated. use getKey() instead. |
java.lang.Long |
getJobId() Gets the job reference number of schedule job that will execute UpdateLocalRegistry. |
java.lang.Long |
getJobInstanceId() Gets the job instance number that indicates when to run the job. |
protected
java.lang.String |
getKey() Gets the cache key. |
protected
java.lang.String |
getRegistryName() Gets the name of the registry to be refreshed. |
AccessVector |
getResources() Gets the access vector accessed by this command. |
protected
java.lang.String |
getUrl() Gets the URL to be redirected to at the end of the command. |
void |
performExecute() Creates a broadcast job to execute the UpdateLocalRegistry command and then updates the response properties so the specified URL can be redirect to. |
void |
setAction(java.lang.String action) Sets the action to perform. |
void |
setItemKey(java.lang.String key) Deprecated. use setKey(String) instead. |
void |
setKey(java.lang.String key) Sets the cache Key. |
void |
setRegistryName(java.lang.String name) Sets the name of the registry to be refreshed. |
void |
setRequestProperties(com.ibm.commerce.datatype.TypedProperty reqParms) This method extracts the required parameters from the request properties and sets it locally in the command. |
void |
setUrl(java.lang.String url) Sets the URL to be redirected to at the end of the command. |
void |
validateParameters() Validates the parameters passed to the command. |
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,
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,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
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,
mergeProperties,
setRequestProperties,
setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
setAccCheck |
Field Detail |
protected java.lang.String action
protected java.lang.String key
protected Registry registry
protected java.lang.String registryName
protected java.lang.String url
protected java.lang.Long jobId
protected java.lang.Long jobInstanceId
Constructor Detail |
public UpdateRegistryCmdImpl()
Method Detail |
protected java.lang.String getKey()
protected java.lang.String getItemKey()
public java.lang.Long getJobId()
public java.lang.Long getJobInstanceId()
protected java.lang.String getRegistryName()
public AccessVector getResources() throws ECException
getResources
in class
AbstractECTargetableCommand
Should
- never happen since only null is being returned.ECException
protected java.lang.String getUrl()
public void performExecute() throws ECException
performExecute
in class
AbstractECTargetableCommand
ECException
- if there was a problem creating the new
broadcast job.public void setAction(java.lang.String action)
setAction
in interface
UpdateRegistryCmd
action
- the action.public void setKey(java.lang.String key)
setKey
in interface
UpdateRegistryCmd
key
- the cache keypublic void setItemKey(java.lang.String key)
setItemKey
in interface
UpdateRegistryCmd
key
- the cache keypublic void setRegistryName(java.lang.String name)
setRegistryName
in interface
UpdateRegistryCmd
name
- the registry namepublic void setRequestProperties(com.ibm.commerce.datatype.TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in class
ControllerCommandImpl
reqParms
- the parameters passed to the command.com.ibm.commerce.exception.ECApplicationException
- if the
require parameter is not specified.ECApplicationException
public void setUrl(java.lang.String url)
url
- the URL to redirect to.public void validateParameters() throws ECException
validateParameters
in class
AbstractECTargetableCommand
ECException
- if any of the parameters specified is
invalid.