com.ibm.commerce.messaging.commands
Class NewInboundMessageCmdImpl

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

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.


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
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, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
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, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
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.

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:
java.lang.String message

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:
Long[] - an array of all organization unit reference numbers

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:
boolean - true/false

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
Specified by:
performExecute in interface NewInboundMessageCmd
Overrides:
performExecute in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

setMessage

public void setMessage(java.lang.String newMessage)
Set the content of the message buffer

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
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -