com.ibm.commerce.messaging.commands

Class MsgStoreIncrementRetriesCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.tools.command.ToolsControllerCommandImpl

com.ibm.commerce.messaging.commands.MessagingAdminCmd

com.ibm.commerce.messaging.commands.MsgStoreIncrementRetriesCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, MsgStoreIncrementRetriesCmd, Protectable, ToolsControllerCommand, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class MsgStoreIncrementRetriesCmdImpl
extends com.ibm.commerce.messaging.commands.MessagingAdminCmd
implements MsgStoreIncrementRetriesCmd

This is the default implementation of MsgStoreIncrementRetriesCmd. The validateParameters method retrieves the msg_id and transport_id from the request properties. Next, performExecute increments the retry 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 to identify multiple values.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright field

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.messaging.commands.MsgStoreIncrementRetriesCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
MsgStoreIncrementRetriesCmdImpl() The MsgStoreIncrementRetriesCmdImpl default constructor calls its parents constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isGeneric() This method checks to see if this is a generic command.
boolean	isReadyToCallExecute() This method checks whether this command is ready to execute.
boolean	isRetriable() This method checks to see if this command may be retried after errors (for example, rollback exceptions).
void	performExecute() The business logic for this controller command.
void	validateParameters() ControllerCommandImpl calls checkParameter in performExecute.

Methods inherited from class com.ibm.commerce.messaging.commands.MessagingAdminCmd

createSuccessResponse, createSuccessResponseForDynamicList, getOptionalParameter, getOptionalParameter, getRequiredParameter, getRequiredParameter, throwException, throwException

Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl

getViewInputProperties, setRequestProperties

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, 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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command

reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright field

See Also:

Constant Field Values

Constructor Detail

MsgStoreIncrementRetriesCmdImpl

public MsgStoreIncrementRetriesCmdImpl()

The MsgStoreIncrementRetriesCmdImpl default constructor calls its parents constructor.

Method Detail

isGeneric

public boolean isGeneric()

This method checks 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

Overrides:

isGeneric in class ControllerCommandImpl

Returns:

True if this command can be called by a generic user, otherwise false.

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method checks whether this command is ready to execute.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

True if this command is ready to be executed, otherwise false.

isRetriable

public boolean isRetriable()

This method checks to see if this command may be retried after errors (for example, rollback exceptions).

Specified by:

isRetriable in interface ControllerCommand

Overrides:

isRetriable in class ControllerCommandImpl

Returns:

True if this command may be retried, otherwise false.

performExecute

public void performExecute()
                    throws ECException

The business logic for this controller command. This method uses the MsgStoreAccessBean to retrieve entries from MSGSTORE based on msg_id and transport_id and increments the retry count by one. msg_id can contain multiple values by using a "," (comma) as a delimiter.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - Raised with messages _ERR_ADM_FINDEREXCEPTION, _ERR_ADM_CREATEEXCEPTION, _ERR_ADM_REMOTEEXCEPTION, _ERR_ADM_NAMINGEXCEPTION when the MsgStoreBean throws any exception.

validateParameters

public void validateParameters()
                        throws ECException

ControllerCommandImpl calls checkParameter in performExecute. It is the responsibility of the command writers to implement this method if they want to perform server side parameter checking. They should either call checkParameters inside their performExecute method or call super.performExecute() as the first statement in the performExecute method. This retrieves attributes from the request properties using key names msg_id and transport_id

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - Raised with message _ERR_CMD_MISSING_PARAM if msg_id or transport_id is not found in the request properties (PrameterNotFoundException)