com.ibm.commerce.tools.segmentation

Class CreateSegmentFromXMLCmdImpl

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.segmentation.CreateSegmentFromXMLCmdImpl

All Implemented Interfaces:

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

This class implements the CreateSegmentFromXMLCmd interface to provide the controller command that creates a customer segment based on data received from an external source.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright
static java.lang.String	GET_REG_USERS_QUERY The Query executed to get the list of users present in the segment xml
static java.lang.String	GUEST_USER_TYPE The User Registration type
static java.lang.String	STATUS_MSG_ALL_OK Status message - All actions completed successfully
static java.lang.String	STATUS_MSG_DUPLICATE_MEMBERS_WARNING Status message - Duplicate members
static java.lang.String	STATUS_MSG_EMPTY_MEMBER_LIST_ERROR Status message - Empty member list failure
static java.lang.String	STATUS_MSG_EMPTY_SEGMENT_WARNING Status message - Warning, segment created but with no members
static java.lang.String	STATUS_MSG_INPUT_VALIDATION_ERROR Status message - Input parameters (logonId, encryptedPassword, XML) are missing or invalid
static java.lang.String	STATUS_MSG_LOGOFF_ERROR Status message - Logoff failure
static java.lang.String	STATUS_MSG_LOGON_ERROR Status message - Logon failure
static java.lang.String	STATUS_MSG_LOGON_HEX_WARNING Status message - Warning, possible use of Hex password instead of Ascii
static java.lang.String	STATUS_MSG_SEGMENT_CREATE_ERROR Status message - Error creating segment(s)
static java.lang.String	STATUS_MSG_SEGMENT_XML_ERROR Status message - Segment XML markup is invalid
static java.lang.String	STATUS_MSG_UNKNOWN_ERROR Status message - Unknown error occurred

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

LOCAL

Fields inherited from interface com.ibm.commerce.tools.segmentation.CreateSegmentFromXMLCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CreateSegmentFromXMLCmdImpl() Class constructor

Method Summary

Modifier and Type	Method and Description
boolean	isGeneric() Whether or not a generic user is permitted to execute this command
void	performExecute() Execute the command.
void	setRequestProperties(TypedProperty reqParms) Extracts and stores the relevant information from the web request.
void	validateParameters() Validates input parameters.

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, 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, isReadyToCallExecute, 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, 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, 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

isReadyToCallExecute, reset

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

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

STATUS_MSG_ALL_OK

public static final java.lang.String STATUS_MSG_ALL_OK

Status message - All actions completed successfully

See Also:

Constant Field Values

STATUS_MSG_UNKNOWN_ERROR

public static final java.lang.String STATUS_MSG_UNKNOWN_ERROR

Status message - Unknown error occurred

See Also:

Constant Field Values

STATUS_MSG_LOGON_ERROR

public static final java.lang.String STATUS_MSG_LOGON_ERROR

Status message - Logon failure

See Also:

Constant Field Values

STATUS_MSG_SEGMENT_CREATE_ERROR

public static final java.lang.String STATUS_MSG_SEGMENT_CREATE_ERROR

Status message - Error creating segment(s)

See Also:

Constant Field Values

STATUS_MSG_INPUT_VALIDATION_ERROR

public static final java.lang.String STATUS_MSG_INPUT_VALIDATION_ERROR

Status message - Input parameters (logonId, encryptedPassword, XML) are missing or invalid

See Also:

Constant Field Values

STATUS_MSG_SEGMENT_XML_ERROR

public static final java.lang.String STATUS_MSG_SEGMENT_XML_ERROR

Status message - Segment XML markup is invalid

See Also:

Constant Field Values

STATUS_MSG_EMPTY_SEGMENT_WARNING

public static final java.lang.String STATUS_MSG_EMPTY_SEGMENT_WARNING

Status message - Warning, segment created but with no members

See Also:

Constant Field Values

STATUS_MSG_LOGOFF_ERROR

public static final java.lang.String STATUS_MSG_LOGOFF_ERROR

Status message - Logoff failure

See Also:

Constant Field Values

STATUS_MSG_EMPTY_MEMBER_LIST_ERROR

public static final java.lang.String STATUS_MSG_EMPTY_MEMBER_LIST_ERROR

Status message - Empty member list failure

See Also:

Constant Field Values

STATUS_MSG_LOGON_HEX_WARNING

public static final java.lang.String STATUS_MSG_LOGON_HEX_WARNING

Status message - Warning, possible use of Hex password instead of Ascii

See Also:

Constant Field Values

STATUS_MSG_DUPLICATE_MEMBERS_WARNING

public static final java.lang.String STATUS_MSG_DUPLICATE_MEMBERS_WARNING

Status message - Duplicate members

See Also:

Constant Field Values

GUEST_USER_TYPE

public static final java.lang.String GUEST_USER_TYPE

The User Registration type

See Also:

Constant Field Values

GET_REG_USERS_QUERY

public static final java.lang.String GET_REG_USERS_QUERY

The Query executed to get the list of users present in the segment xml

See Also:

Constant Field Values

Constructor Detail

CreateSegmentFromXMLCmdImpl

public CreateSegmentFromXMLCmdImpl()

Class constructor

Method Detail

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)

Extracts and stores the relevant information from the web request. No validation is done here.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqParms - This is an object that represents the request properties.

See Also:

ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

validateParameters

public void validateParameters()

Validates input parameters. Mandatory values are logonId, encryptedPassword, and XML.

The XML must be in the following format:

 
  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <segmentation>
     <chart name="Chart Title" store_id="1234">
         <segment name="Segment 1" description="Description for Segment 1">
             <members>1000, 1001, 1002</members>
         </segment>
         <segment name="Segment 2" description="Description for Segment 2">
             <members>2000, 2001, 2002</members>
         </segment>
     </chart>
  </segmentation>
 

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

performExecute

public void performExecute()
                    throws ECException

Execute the command. First we authenticate the user credentials and log onto the Commerce system. If the user is valid and has the proper Marketing Manager roles, a new customer segment is created before the user is logged off.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

isGeneric

public boolean isGeneric()

Whether or not a generic user is permitted to execute this command

Specified by:

isGeneric in interface ControllerCommand

Overrides:

isGeneric in class ControllerCommandImpl

Returns:

boolean true if a generic user can execute this command; always true for this command