com.ibm.commerce.messaging.commands
Class NewInboundMessageCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.messaging.commands.NewInboundMessageCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, NewInboundMessageCmd

public class NewInboundMessageCmdImpl
extends ControllerCommandImpl
implements NewInboundMessageCmd

This is the default implementation of NewInboundMessageCmd and 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
static java.lang.String COPYRIGHT
          The internal copyright field.
 java.lang.String message
          The message buffer
 
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.messaging.commands. NewInboundMessageCmd
defaultCommandClassName, NAME
 
Constructor Summary
NewInboundMessageCmdImpl()
           
 
Method Summary
 java.lang.String getMessage()
          This method retrieve the message passed in message buffer
 java.lang.Long[] getResourceOwners()
          This method returns the Organization unit reference numbers for all the resources accessed by this command It will return null if no resource if being accessed by this command.
 boolean isReadyToCallExecute()
          This method checks if command is ready to be executed and if message buffer is null.
 void performExecute()
          This method needs to be implemented to process new inbound message unknown to Websphere Commerce Suite.
 void setMessage(java.lang.String newMessage)
          Set the content of the message buffer
 void setRequestProperties( TypedProperty aRequestProperties)
          Set 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, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
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
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
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 retrieve the message passed in message buffer
Returns:
the inbound message which 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 will return null if no resource if 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 command is ready to be executed and if message buffer is null.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
true if ready to be executed, false indicating the command is not ready

performExecute

public void performExecute()
                    throws ECException
This method needs to be implemented to process new inbound message unknown to Websphere Commerce Suite. By default it would throw an exception indicating this method is not customized
Specified by:
performExecute in interface NewInboundMessageCmd
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - Raised with message _ERR_NI_NOT_CUSTOMIZED because there is no customized implementation

setMessage

public void setMessage(java.lang.String newMessage)
Set the content of the message buffer
Parameters:
newMessage - the content of message buffer to be set

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
Set 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 - NVP containing attributes for this command The message content is retrived using the key "message" and stored in local variable "message"