atg.svc.clicktoconnect
Class LandingPageManager

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.clicktoconnect.LandingPageManager

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class LandingPageManager
extends atg.nucleus.GenericService

This component executes the configured LandingPageHandlers to generate a LandingPage. The first handler to return a LandingPage wins.

The Framework object properties are modified based the values specified by the LandingPage.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected LandingPageHandler	mDefaultLandingPageHandler
protected LandingPageHandler[]	mLandingPageHandlers

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

LandingPageManager()

Method Summary

void	applyLandingPage(C2CRequestData pC2CRequestData) Calls each configured LandingPageHandler is succession until a LandingPage object is returned.
protected void	applyLandingPageToFramework(LandingPage pLandingPage) Applies the landing page to the framework environment.
LandingPageHandler	getDefaultLandingPageHandler() Returns the default landing page handler.
LandingPageHandler[]	getLandingPageHandlers() Returns the array of LandingPageHandlers that are called in succession to generate a LandingPage.
void	setDefaultLandingPageHandler(LandingPageHandler pDefaultLandingPageHandler)
void	setLandingPageHandlers(LandingPageHandler[] pLandingPageHandlers)

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

mDefaultLandingPageHandler

protected LandingPageHandler mDefaultLandingPageHandler

mLandingPageHandlers

protected LandingPageHandler[] mLandingPageHandlers

Constructor Detail

LandingPageManager

public LandingPageManager()

Method Detail

getDefaultLandingPageHandler

public LandingPageHandler getDefaultLandingPageHandler()

Returns the default landing page handler. This handler is called when none of the configured LandingPageHandlers return a LandingPage

Returns:

LandingPageHandler

setDefaultLandingPageHandler

public void setDefaultLandingPageHandler(LandingPageHandler pDefaultLandingPageHandler)

getLandingPageHandlers

public LandingPageHandler[] getLandingPageHandlers()

Returns the array of LandingPageHandlers that are called in succession to generate a LandingPage.

Returns:

LandingPageHandler[]

setLandingPageHandlers

public void setLandingPageHandlers(LandingPageHandler[] pLandingPageHandlers)

applyLandingPage

public void applyLandingPage(C2CRequestData pC2CRequestData)

Calls each configured LandingPageHandler is succession until a LandingPage object is returned. The first one returned is used.

Modifies the Framework object based on the values in the LandingPage object

Parameters:

pC2CRequestData -

applyLandingPageToFramework

protected void applyLandingPageToFramework(LandingPage pLandingPage)

Applies the landing page to the framework environment.

Parameters:

pLandingPage -