public class ProcVerifyOrderAddresses extends ApplicationLoggingImpl implements PipelineProcessor
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ProcVerifyOrderAddresses() |
Modifier and Type | Method and Description |
---|---|
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.
|
addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
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 invokationjava.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 OrderManagerInvalidParameterException
- if pAddressId or pBillingAddress is nullCommerceException
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 retrievejava.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