atg.commerce.util

Class ProfileContextValueSource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.util.ContextValueSourceImpl

atg.commerce.util.ProfileContextValueSource

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

public class ProfileContextValueSource
extends ContextValueSourceImpl

Implements getting a context value from a profile. The profile is obtained from the profile property of the ContextValueRetrieverArguments object.

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getPropertyNameForSourceItem(atg.commerce.util.ContextValueRetrieverArguments pArguments) Returns profilePropertyName from pArguments.
protected RepositoryItem	getSourceItem(atg.commerce.util.ContextValueRetrieverArguments pArguments) Get the source item.
RepositoryItem	retrieveValue(atg.commerce.util.ContextValueRetrieverArguments pArguments) Determine the appropriate value for one profile property based on information provided in an arguments object.

Methods inherited from class atg.commerce.util.ContextValueSourceImpl

adjustForCandidateId, getContextValueRetriever, setContextValueRetriever

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

ProfileContextValueSource

public ProfileContextValueSource()

Method Detail

getSourceItem

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

Get the source item. In our case, the profile from pArguments if our retriever returns true for shouldUseProfile().

Return the source RepositoryItem item.

Specified by:

getSourceItem in class ContextValueSourceImpl

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)

Returns profilePropertyName from pArguments.

Return the property name appropriate for the source RepositoryItem.

The default implementation returns sitePropertyName from pArguments.

Overrides:

getPropertyNameForSourceItem in class ContextValueSourceImpl

Parameters:

pArguments - the arguments

Returns:

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

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

Overrides:

retrieveValue in class ContextValueSourceImpl

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