com.ibm.commerce.messaging.commands
Class MsgStoreIncrementRetriesCmdImpl

java.lang.Object
  |
  +--MessagingAdminCmd
        |
        +--com.ibm.commerce.messaging.commands.MsgStoreIncrementRetriesCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, MsgStoreIncrementRetriesCmd, ToolsControllerCommand

public class MsgStoreIncrementRetriesCmdImpl
extends MessagingAdminCmd
implements MsgStoreIncrementRetriesCmd

This is the default implementation of MsgStoreIncrementRetriesCmd. validateParameters retrieves msg_id and transport_id from the request properties performExecute increments the retries count in the MSGSTORE table for all the messages identified by the msg_id and transport_id. The msg_id attribute value can be comma delimited identifying multiple values.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright field
 
Fields inherited from interface com.ibm.commerce.messaging.commands. MsgStoreIncrementRetriesCmd
defaultCommandClassName, NAME
 
Constructor Summary
MsgStoreIncrementRetriesCmdImpl()
          MsgStoreIncrementRetriesCmdImpl default cosntructor
 
Method Summary
 boolean isGeneric()
          Check to see if this is a generic command.
 boolean isReadyToCallExecute()
          Check whether this command is ready to be executed
 boolean isRetriable()
          Check to see if this command is retriable on errors like rollback exception
 void performExecute()
          The business logic for this controller command.
 void validateParameters()
          ControllerCommandImpl calls checkParameter in performExecute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright field
See Also:
Constant Field Values
Constructor Detail

MsgStoreIncrementRetriesCmdImpl

public MsgStoreIncrementRetriesCmdImpl()
MsgStoreIncrementRetriesCmdImpl default cosntructor
Method Detail

isGeneric

public boolean isGeneric()
Check to see if this is a generic command. A generic command can be called by a generic user. The default is false.
Specified by:
isGeneric in interface ControllerCommand
Returns:
true if this command can be called by a generic user false if this command cannot be called by a generic user

isReadyToCallExecute

public boolean isReadyToCallExecute()
Check whether this command is ready to be executed
Returns:
true if this command is ready to be executed false if this command is not ready to be executed

isRetriable

public boolean isRetriable()
Check to see if this command is retriable on errors like rollback exception
Specified by:
isRetriable in interface ControllerCommand
Returns:
true if this command is retriable false if this command is not retriable

performExecute

public void performExecute()
                    throws ECException
The business logic for this controller command. This method uses MsgStoreAccessBean to retrieve entry from MSGSTORE based on msg_id and transport_id and increments the retries count by one. msg_id can contain multiple values by using "," (comma) as a delimiter.
Specified by:
performExecute in interface ECCommand
Throws:
ECException - Raised with mesages _ERR_ADM_FINDEREXCEPTION, _ERR_ADM_CREATEEXCEPTION, _ERR_ADM_REMOTEEXCEPTION, _ERR_ADM_NAMINGEXCEPTION when the ejb MsgStoreBean thorws any exception

validateParameters

public void validateParameters()
                        throws ECException
ControllerCommandImpl calls checkParameter in performExecute. It is the responsibility of the command writers to implements this method if they want to perform server side parameter checking. They should either calls checkParameters inside their performExecute or calls super.performExecute() as the first statement in the performExecute method. It retrieves attributes from the request proerties using key names "msg_id" and "transport_id"
Specified by:
validateParameters in interface ECCommand
Throws:
ECException - Raised with message _ERR_CMD_MISSING_PARAM if msg_id or transport_id is not found in the request properties (PrameterNotFoundException)