com.ibm.commerce.usermanagement.commands
Class AuditBaseCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl
All Implemented Interfaces:
AuditBaseCmd, ECCommand, ECTargetableCommand, TaskCommand
Direct Known Subclasses:
AuditAddressCmdImpl, AuditOrgEntityCmdImpl

public class AuditBaseCmdImpl
extends TaskCommandImpl
implements AuditBaseCmd

The base class for AuditAddressCmdImpl, AuditUserRegistrationCmdImpl and AuditOrgEntityCmdImpl.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASSNAME
          The full qualified class name.
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
protected  boolean ibResult
          A indicator indicates whether or not the audit is passed.
protected  java.util.Hashtable ihshProperties
          The Hashtable used to store the content of the property file.
protected  java.util.SortedMap ismpProperties
          The SortedMap used to store the content of the property file.
protected  java.lang.String istrErrorViewName
          The name of the error view.
protected  java.lang.String istrPathSeparator
          The separator used to separate file path.
protected  java.lang.String istrPropertyFileName
          The name of the property file which is used for auditing.
protected  java.lang.String istrStoreDirectory
          The store directory where to find the property file.
protected  TypedProperty requestProperties
          The request properties.
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.usermanagement.commands. AuditBaseCmd
NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
AuditBaseCmdImpl()
           
 
Method Summary
 boolean getAuditResult()
          Return the audit result.
 java.lang.String getPathSeparator()
          Gets the path separator.
 java.lang.String getPropertyFileName()
          Gets the name of property file
  TypedProperty getRequestProperties()
          Get the request properties.
 java.lang.String getStoreDirectory()
          Gets the name of the store directory, which is used for finding property files belong to this store.
 void performExecute()
          Execute the task command.
 void setErrorViewName(java.lang.String astrErrorViewName)
          Sets the name of the error view.
 void setPathSeparator(java.lang.String astrPathSeparator)
          Sets the path separator.
 void setPropertyFileName(java.lang.String astrPropertyFileName)
          Sets the name of the property file.
 void setRequestProperties( TypedProperty aRequestProperties)
          Sets the request properties
 void setStoreDirectory(java.lang.String astrStoreDirectory)
          Sets the name of store directory, which is used as the path to the find the property file.
 
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, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME
The full qualified class name.
See Also:
Constant Field Values

ibResult

protected boolean ibResult
A indicator indicates whether or not the audit is passed. true means audit is passed; false means not passed

requestProperties

protected TypedProperty requestProperties
The request properties.

istrPropertyFileName

protected java.lang.String istrPropertyFileName
The name of the property file which is used for auditing.

istrStoreDirectory

protected java.lang.String istrStoreDirectory
The store directory where to find the property file.

istrErrorViewName

protected java.lang.String istrErrorViewName
The name of the error view.

ihshProperties

protected java.util.Hashtable ihshProperties
The Hashtable used to store the content of the property file.

ismpProperties

protected java.util.SortedMap ismpProperties
The SortedMap used to store the content of the property file.

istrPathSeparator

protected java.lang.String istrPathSeparator
The separator used to separate file path. Default is "/".
Constructor Detail

AuditBaseCmdImpl

public AuditBaseCmdImpl()
Method Detail

getAuditResult

public boolean getAuditResult()
Return the audit result.
Returns:
true if passes the audit; false otherwise.

getPathSeparator

public java.lang.String getPathSeparator()
Gets the path separator. path separator is used to separate the store directory and the property file name. For example:
 "store1/UserRegistration"
"/" is the path separator.
Returns:
The path separator.

getPropertyFileName

public java.lang.String getPropertyFileName()
Gets the name of property file
Returns:
The name of the property file.

getStoreDirectory

public java.lang.String getStoreDirectory()
Gets the name of the store directory, which is used for finding property files belong to this store.
Returns:
The name of the store directory.

performExecute

public void performExecute()
                    throws ECException
Execute the task command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - Any ECException throws.

setErrorViewName

public void setErrorViewName(java.lang.String astrErrorViewName)
Sets the name of the error view.
Specified by:
setErrorViewName in interface AuditBaseCmd
Parameters:
astrErrorViewName - The name of the error view.

setPathSeparator

public void setPathSeparator(java.lang.String astrPathSeparator)
Sets the path separator. path separator is used to separate the store directory and the property file name. For example:
 "store1/UserRegistration"
"/" is the path separator. If path separator is not set, the databean will use the default one: "/" (working under Windows platform).
Parameters:
astrPathSeparator - The path separator.

setPropertyFileName

public void setPropertyFileName(java.lang.String astrPropertyFileName)
Sets the name of the property file.
Specified by:
setPropertyFileName in interface AuditBaseCmd

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets the request properties
Specified by:
setRequestProperties in interface AuditBaseCmd
Parameters:
aRequestProperties - the parameters passed to the command.
Throws:
ECApplicationException - If any exception happens.

getRequestProperties

public TypedProperty getRequestProperties()
Get the request properties.
Specified by:
getRequestProperties in interface AuditBaseCmd
Returns:
The request properties.

setStoreDirectory

public void setStoreDirectory(java.lang.String astrStoreDirectory)
Sets the name of store directory, which is used as the path to the find the property file. For example, if property files of a store is under the directory "store31" and the parent directory of "store31" directory is included in the class path, then this method should be called to set StoreDirectory to "store31". If the store directory is not set, ResourceBundleDataBean will try to get it from commandContext.
Parameters:
astrStoreDirectory - The name of store directory.