atg.svc.clicktoconnect
Class LandingPageHandler

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.svc.clicktoconnect.LandingPageHandler
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
Direct Known Subclasses:
URIMatchLandingPageHandler

public abstract class LandingPageHandler
extends atg.nucleus.GenericService

Abstract class used to create a LandingPageHandler that can be configured on the LandingPageManager.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
protected  EnvironmentTools mEnvironmentTools
           
protected  LandingPage mLandingPage
           
 
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
LandingPageHandler()
           
 
Method Summary
abstract  LandingPage generateLandingPage(C2CRequestData pC2CRequestData)
          Abstract method that generates the LandingPage returned by the LandingPageHandler
 EnvironmentTools getEnvironmentTools()
           
 LandingPage getLandingPage()
          Returns the configured LandingPage object for this LandingPageHandler
protected  java.lang.String getReferrerParameter(java.lang.String pParameterName, C2CRequestData pC2CRequestData)
          Returns a parameter value from the Referrer url for the given parameter name.
 void setEnvironmentTools(EnvironmentTools pEnvironmentTools)
           
 void setLandingPage(LandingPage pLandingPage)
           
 
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

mLandingPage

protected LandingPage mLandingPage

mEnvironmentTools

protected EnvironmentTools mEnvironmentTools
Constructor Detail

LandingPageHandler

public LandingPageHandler()
Method Detail

getLandingPage

public LandingPage getLandingPage()
Returns the configured LandingPage object for this LandingPageHandler

Returns:
LandingPage

setLandingPage

public void setLandingPage(LandingPage pLandingPage)

getEnvironmentTools

public EnvironmentTools getEnvironmentTools()
Returns:
the environment tools component

setEnvironmentTools

public void setEnvironmentTools(EnvironmentTools pEnvironmentTools)

getReferrerParameter

protected java.lang.String getReferrerParameter(java.lang.String pParameterName,
                                                C2CRequestData pC2CRequestData)
Returns a parameter value from the Referrer url for the given parameter name.

Parameters:
pParameterName -
pC2CRequestData -
Returns:
value of parameter

generateLandingPage

public abstract LandingPage generateLandingPage(C2CRequestData pC2CRequestData)
Abstract method that generates the LandingPage returned by the LandingPageHandler

Parameters:
pC2CRequestData -
Returns:
LandingPage