com.ibm.commerce.usermanagement.commands

Class AuditBaseCmdImpl

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.TaskCommandImpl

com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AuditBaseCmd, 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

Direct Known Subclasses:

AuditAddressCmdImpl, AuditOrgEntityCmdImpl

public class AuditBaseCmdImpl
extends TaskCommandImpl
implements AuditBaseCmd

Provides the base methods for AuditAddressCmd, AuditUserRegistrationCmd and AuditOrgEntityCmd.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The full qualified class name.
static java.lang.String	COPYRIGHT IBM Copyright notice field.

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

LOCAL

Fields inherited from interface com.ibm.commerce.usermanagement.commands.AuditBaseCmd

NAME

Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AuditBaseCmdImpl()

Method Summary

Modifier and Type	Method and Description
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() Getz the request properties.
java.lang.String	getStoreDirectory() Gets the name of the store directory, which is used for finding property files that belong to this store.
void	performExecute() Executes 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 find the property files.

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, 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.CacheableECCommand

execute

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.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

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

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 that belong to this store.

Returns:

The name of the store directory.

performExecute

public void performExecute()
                    throws ECException

Executes the task command.

Specified by:

performExecute in interface ECCommand

Specified by:

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

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

Parameters:

The - name of the property file.

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()

Getz 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 find the property files. For example, if the property files of a store are under the directory "store31" and the parent directory of "store31" directory is included in the class path, then call this method to set StoreDirectory to "store31". If the store directory is not set, ResourceBundleDataBean will try to get it from the commandContext.

Parameters:

astrStoreDirectory - The name of store directory.