atg.commerce.util

Class ContextValueRetriever

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.util.ContextValueRetriever

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class ContextValueRetriever
extends GenericService

Determines the appropriate value for a profile property based on a site, and possibly what is already in the profile. Example uses of this class include determining the catalog or price list to use for a storefront page request or a call center agent helping the shopper associated with the profile.

For a multisite application that gets profile settings from the current site, configure useProfile to false. For an application that sets profile values at registration time, for example, configure useProfile to true.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected boolean	mUseProfile

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Constructors

Constructor and Description
ContextValueRetriever()

Method Summary

Modifier and Type	Method and Description
void	doStartService() In this case, also set the contextValueRetriever value of our sources to this instance.
ContextValueSource[]	getSources() Returns property sources.
boolean	isUseProfile() Indicates if profile properties have already been set to their correct values or should be assumed to be unreliable.
RepositoryItem	retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments) Determine the appropriate value for one profile property based on information provided in an arguments object.
protected RepositoryItem	retrieveValueFromProfile(atg.commerce.util.ContextValueRetrieverArguments pArguments) Retrieves the value from the Profile, if shouldUseProfile is set to true.
protected RepositoryItem	retrieveValueFromSite(atg.commerce.util.ContextValueRetrieverArguments pArguments) Retrieves the value from the Site.
void	setSources(ContextValueSource[] pSources) Sets property sources.
void	setUseProfile(boolean pUseProfile) Sets property useProfile
boolean	shouldUseProfile(RepositoryItem pProfile) Indicates if profile properties have already been set to their correct values or should be ignored.

Methods inherited from class atg.nucleus.GenericService

addLogListener, clearAbsoluteNameAndContext, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mUseProfile

protected boolean mUseProfile

Constructor Detail

ContextValueRetriever

public ContextValueRetriever()

Method Detail

isUseProfile

public boolean isUseProfile()

Indicates if profile properties have already been set to their correct values or should be assumed to be unreliable.

Returns:

true if profile properties are unreliable, false if profile properties are already set

setUseProfile

public void setUseProfile(boolean pUseProfile)

Sets property useProfile

setSources

public void setSources(ContextValueSource[] pSources)

Sets property sources. An array of sources that can potential fetch a context value.

getSources

public ContextValueSource[] getSources()

Returns property sources. An array of sources that can potential fetch a context value.

Returns:

an array of override sources, or null.

retrieveValue

public RepositoryItem retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments)
                             throws RepositoryException

Determine the appropriate value for one profile property based on information provided in an arguments object. This implementation uses a profile and site as possible sources for the returned value, following these steps:

• If there are sources defined, consult each source to see if it is providing an override value to return.
• Otherwise, if shouldUseProfile returns true and there is a profile in the input arguments, return the existing value of the profile property.
• Or if the profile property does not return a value and there is a site, return the value from a corresponding property of the site.

This implementation treats all profiles the same. If you want to use the existing profile value for special profiles and use the site value for other profiles, you can override shouldUseProfile(RepositoryItem) to examine the profile to see if it is special. Customers who have more complex business rules should override this method.

Customers who need different logic for different profile properties (e.g., catalogs vs. price lists) should configure additional instances of the ContextValueRetriever component and reconfigure references to the original component.

Parameters:

pArguments - an object containing properties that define possible sources for the value to be retrieved

Returns:

a RepositoryItem (e.g., a catalog or price list)

Throws:

RepositoryException

retrieveValueFromSite

protected RepositoryItem retrieveValueFromSite(atg.commerce.util.ContextValueRetrieverArguments pArguments)
                                        throws RepositoryException

Retrieves the value from the Site.

This method now remains for backwards compatibility reasons. See SiteContextValueSource for the new approach for determining Site values. pArguments an object containing properties that define possible sources for the value to be retrieved

Returns:

a RepositoryItem (e.g., a catalog or price list)

Throws:

RepositoryException

retrieveValueFromProfile

protected RepositoryItem retrieveValueFromProfile(atg.commerce.util.ContextValueRetrieverArguments pArguments)
                                           throws RepositoryException

Retrieves the value from the Profile, if shouldUseProfile is set to true. This method now remains for backwards compatibility reasons. See ProfileContextValueSource for the new approach for determining Profile values. pArguments an object containing properties that define possible sources for the value to be retrieved

Returns:

a RepositoryItem (e.g., a catalog or price list)

Throws:

RepositoryException

shouldUseProfile

public boolean shouldUseProfile(RepositoryItem pProfile)

Indicates if profile properties have already been set to their correct values or should be ignored. This implementation returns the configured value of the useProfile property. Override this method to make a determination based on information stored in the profile.

Returns:

true if profile properties are already set, false if profile properties should be ignored

doStartService

public void doStartService()
                    throws ServiceException

In this case, also set the contextValueRetriever value of our sources to this instance.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up