com.ibm.commerce.messaging.commands

Class NewInboundMessageCmdImpl

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.messaging.commands.NewInboundMessageCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, NewInboundMessageCmd, Protectable, 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 NewInboundMessageCmdImpl
extends ControllerCommandImpl
implements NewInboundMessageCmd

This is the default implementation of NewInboundMessageCmd. It is called by customized inbound messages that are not implemented using the user_template.xml inbound message template definition file.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.
java.lang.String	message The message buffer

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

LOCAL

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

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
NewInboundMessageCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage() This method retrieves the message passed in the message buffer.
java.lang.Long[]	getResourceOwners() This method returns the organization unit reference numbers for all the resources accessed by this command.
boolean	isReadyToCallExecute() This method checks if the command is ready to run and if the message buffer is null.
void	performExecute() This method needs to be implemented to process new inbound message unknown to WebSphere Commerce Server.
void	setMessage(java.lang.String newMessage) This method sets the content of the message buffer.
void	setRequestProperties(TypedProperty aRequestProperties) This method sets the request properties as input for the command where the message is retrieved from.

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, 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, validateParameters

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, isGeneric, isRetriable, mergeProperties, setGeneric, 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, 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, validateParameters

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

The internal copyright field.

See Also:

Constant Field Values

message

public java.lang.String message

The message buffer

Constructor Detail

NewInboundMessageCmdImpl

public NewInboundMessageCmdImpl()

Method Detail

getMessage

public java.lang.String getMessage()

This method retrieves the message passed in the message buffer.

Returns:

The inbound message that triggers this command.

getResourceOwners

public java.lang.Long[] getResourceOwners()
                                   throws ECException

This method returns the organization unit reference numbers for all the resources accessed by this command. It returns null if no resource is being accessed by this command.

Specified by:

getResourceOwners in interface AccCommand

Overrides:

getResourceOwners in class ControllerCommandImpl

Returns:

An array of all organization unit reference numbers.

Throws:

ECException

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method checks if the command is ready to run and if the message buffer is null.

Specified by:

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

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

True if ready to run, otherwise false.

performExecute

public void performExecute()
                    throws ECException

This method needs to be implemented to process new inbound message unknown to WebSphere Commerce Server. By default, it throws an exception indicating that this method is not customized.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface NewInboundMessageCmd

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - Raised with message _ERR_NI_NOT_CUSTOMIZED as there is no customized implementation

setMessage

public void setMessage(java.lang.String newMessage)

This method sets the content of the message buffer.

Parameters:

newMessage - A String to set the content of the message buffer.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)

This method sets the request properties as input for the command where the message is retrieved from.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

aRequestProperties - name-value pairs containing attributes for this command. The message content is retrieved using the key "message" and stored in the local variable "message"