|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.logging.ApplicationLoggingImpl atg.commerce.order.processor.ProcVerifyOrderAddresses
public class ProcVerifyOrderAddresses
This class verifies addresses for ShippingGroups and PaymentGroups. Specifically HardgoodShippingGroup and CreditCard. For each HardgoodShippingGroup and CreditCard class the address is verified against the configured address verification processor. Note that the AddressVerificationProcessor in no way is related to the PipelineProcessor interface which this class implements. The AddressVerificationProcessor is a class which implements the atg.payment.avs.AddressVerificationProcessor interface. By default the configured AddressVerificationProcessor is atg.commerce.payment.DummyAddressVerificationProcessor whose implementation is a noop. To extend this class to verify addresses in other class types, override the runProcess() method to call verifyAddress() for each address object in the desired classes then call this class' runProcess() method to verify the addresses in the HardgoodShippingGroup and CreditCard classes. To change the way addresses are verified override the verifyAddress() method. By default, verifyAddress() method calls verifyAddress() in the addressVerificationProcessor passing it a GenericAddressVerificationInfo object which it constructs using the parameter data passed into the method.
AddressVerificationProcessor
,
DummyAddressVerificationProcessor
,
HardgoodShippingGroup
,
CreditCard
,
PipelineProcessor
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from interface atg.service.pipeline.PipelineProcessor |
---|
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
ProcVerifyOrderAddresses()
|
Method Summary | |
---|---|
protected void |
addHashedError(PipelineResult pResult,
java.lang.String pKey,
java.lang.String pId,
java.lang.Object pError)
This method adds an error to the PipelineResult object. |
protected void |
cacheAddress(Address pAddress,
AddressVerificationStatus pVerificationStatus)
Cache the given address' verification status |
Cache |
getAddressVerificationCache()
Returns the addressVerificationCache |
AddressVerificationProcessor |
getAddressVerificationProcessor()
Returns the addressVerificationProcessor |
protected AddressVerificationStatus |
getCachedAddress(Address pAddress)
Attempts to get the verification status of an address from the cache |
java.lang.String |
getLoggingIdentifier()
Returns property LoggingIdentifier |
int[] |
getRetCodes()
Returns the valid return codes 1 - The processor completed |
protected boolean |
hasBeenVerified(Address pAddress,
java.lang.String pAddrId,
PipelineResult pResult)
Determines whether or not an address has already been verified. |
boolean |
isUseCache()
Returns whether or not address verification results are being cached |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method executes the address verification. |
void |
setAddressVerificationCache(Cache pAddressVerificationCache)
Sets the addressVerificationCache to be used to cache the results of verifying an address |
void |
setAddressVerificationProcessor(AddressVerificationProcessor pAddressVerificationProcessor)
Sets the addressVerificationProcessor |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
void |
setUseCache(boolean pUseCache)
Sets whether or not the results from verifying an address should be cached |
protected boolean |
verifyAddress(java.lang.String pAddressId,
Address pAddress1,
Address pAddress2,
PipelineResult pResult,
OrderManager orderManager)
This method verifies the addresses by going against the address verification system. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ProcVerifyOrderAddresses()
Method Detail |
---|
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
public AddressVerificationProcessor getAddressVerificationProcessor()
public void setAddressVerificationProcessor(AddressVerificationProcessor pAddressVerificationProcessor)
public void setUseCache(boolean pUseCache)
pUseCache
- true if results should be cachedpublic boolean isUseCache()
public void setAddressVerificationCache(Cache pAddressVerificationCache)
pAddressVerificationCache
- cache to usepublic Cache getAddressVerificationCache()
public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- a HashMap which must contain an Order and OrderManager objectpResult
- a PipelineResult object which stores any information which must
be returned from this method invokation
java.lang.Exception
- throws any exception back to the callerPipelineProcessor.runProcess(Object, PipelineResult)
protected boolean verifyAddress(java.lang.String pAddressId, Address pAddress1, Address pAddress2, PipelineResult pResult, OrderManager orderManager) throws CommerceException
pAddressId
- the id to reference this address verification withpAddress1
- the first address to verify. Cannot be null.pAddress2
- the second address to verify. Can be null.pResult
- a PipelineResult object which stores any information which must
be returned from this method invokationorderManager
- an instance of the OrderManager
InvalidParameterException
- if pAddressId or pBillingAddress is null
CommerceException
AddressVerificationProcessor.verifyAddress(AddressVerificationInfo)
protected void addHashedError(PipelineResult pResult, java.lang.String pKey, java.lang.String pId, java.lang.Object pError)
pResult
- the PipelineResult object supplied in runProcess()pKey
- the key to use to store the HashMap in the PipelineResult objectpId
- the key to use to store the error message within the HashMap in the
PipelineResult objectpError
- the error object to store in the HashMapPipelineResult
,
runProcess(Object, PipelineResult)
protected void cacheAddress(Address pAddress, AddressVerificationStatus pVerificationStatus)
pAddress
- address whose verification status is being cachedpVerificationStatus
- verification status to cacheprotected AddressVerificationStatus getCachedAddress(Address pAddress) throws java.lang.Exception
pAddress
- Address to retrieve
java.lang.Exception
protected boolean hasBeenVerified(Address pAddress, java.lang.String pAddrId, PipelineResult pResult)
pAddress
- Address to verifypAddrId
- Id of the address to verifypResult
- pipeline result
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |