atg.commerce.util

Class ContextValueSourceImpl

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.util.ContextValueSourceImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

ProfileContextValueSource, SiteContextValueSource

public abstract class ContextValueSourceImpl
extends GenericService
implements ContextValueSource

An abstract ContextValueSource that gets its value from a property name of separate source repository item. Created: August 18 2016

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string from source code control system.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.commerce.util.ContextValueSource

DEFAULT_VALUE

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

Method Summary

Modifier and Type	Method and Description
protected RepositoryItem	adjustForCandidateId(RepositoryItem pSourceItem, RepositoryItem pDefaultResult, atg.commerce.util.ContextValueRetrieverArguments pArguments) Adjust our result taking candidate ID into account.
ContextValueRetriever	getContextValueRetriever() Returns property contextValueRetriever.
protected java.lang.String	getPropertyNameForSourceItem(atg.commerce.util.ContextValueRetrieverArguments pArguments) Return the property name appropriate for the source RepositoryItem.
protected abstract RepositoryItem	getSourceItem(atg.commerce.util.ContextValueRetrieverArguments pArguments) Return the source RepositoryItem item.
RepositoryItem	retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments) Determine the appropriate value for one profile property based on information provided in an arguments object.
void	setContextValueRetriever(ContextValueRetriever pContextValueRetriever) Sets property contextValueRetriever.

Methods inherited from class atg.nucleus.GenericService

addLogListener, clearAbsoluteNameAndContext, createAdminServlet, doStartService, 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 final java.lang.String CLASS_VERSION

Class version string from source code control system.

See Also:

Constant Field Values

Constructor Detail

ContextValueSourceImpl

public ContextValueSourceImpl()

Method Detail

setContextValueRetriever

public void setContextValueRetriever(ContextValueRetriever pContextValueRetriever)

Sets property contextValueRetriever. Our owning ContextValueRetriever, set during ContextValueRetriever's doStartService.

Specified by:

setContextValueRetriever in interface ContextValueSource

Parameters:

pContextValueRetriever - our owning context value retriever.

getContextValueRetriever

public ContextValueRetriever getContextValueRetriever()

Returns property contextValueRetriever. Our owning ContextValueRetriever.

Returns:

the owning ContextValueRetriever

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.

Specified by:

retrieveValue in interface ContextValueSource

Parameters:

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

Returns:

a RepositoryItem (or null). The DEFAULT_VALUE constant can be returned, indicating that following ContextValueSources should not be consulted, and the default (non-override) value should be retrieved.

Throws:

RepositoryException

getSourceItem

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

Return the source RepositoryItem item.

Parameters:

pArguments - the context value retriever arguments.

Returns:

the source RepositoryItem, if any.

Throws:

RepositoryException

getPropertyNameForSourceItem

protected java.lang.String getPropertyNameForSourceItem(atg.commerce.util.ContextValueRetrieverArguments pArguments)

Return the property name appropriate for the source RepositoryItem.

The default implementation returns sitePropertyName from pArguments.

Parameters:

pArguments - the arguments

Returns:

the name of the property of the source item to retrieve.

adjustForCandidateId

protected RepositoryItem adjustForCandidateId(RepositoryItem pSourceItem,
                                              RepositoryItem pDefaultResult,
                                              atg.commerce.util.ContextValueRetrieverArguments pArguments)
                                       throws RepositoryException

Adjust our result taking candidate ID into account.

The additionalValidValuesPropertyName is used to read additional valid values from pSourceItem. If the candidate ID matches one of those items, it is returned. Otherwise pDefaultResult is returned. The candidate ID may come from an external source, such as a request header or query param.

Parameters:

pSourceItem - the source item

pDefaultResult - the result from the primary property of pSourceItem. May be null.

pArguments - the arguments

Returns:

pDefaultResult, a different item that matched the candidate ID, or null.

Throws:

RepositoryException