atg.svc.email
Class EmailLandingPage

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.svc.email.EmailLandingPage

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 EmailLandingPage
extends atg.nucleus.GenericService

The EmailLandingPage is a simple nucleus component which holds the attribute pointing to the email landing page's URL. Both self-service (email to a friend) and the respond tab (email to a solution link) need to get this email landing page url from this component to construct the url to email the solution.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

EmailLandingPage()

Method Summary

java.lang.String	getEmailLandingPageScheme() URL scheme (http or https) for the email landing page.
java.lang.String	getEmailLandingPageUrl() Landing page relative to the context-root.
java.lang.String	getSelfServiceContextRoot() Self-Service Context Root.
java.util.Map<java.lang.String,java.lang.String>	getSiteIdToBrandMap() Maps siteConfig item ids to brand values.
void	setEmailLandingPageScheme(java.lang.String pEmailLandingPageScheme) URL scheme (http or https) for the email landing page.
void	setEmailLandingPageUrl(java.lang.String pLandingPageUrl) Landing page relative to the context-root.
void	setSelfServiceContextRoot(java.lang.String pSelfServiceContextRoot) Self-Service Context Root.
void	setSiteIdToBrandMap(java.util.Map<java.lang.String,java.lang.String> pSiteIdToBrandMap) Maps siteConfig item ids to brand values.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, 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

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

EmailLandingPage

public EmailLandingPage()

Method Detail

setEmailLandingPageUrl

public void setEmailLandingPageUrl(java.lang.String pLandingPageUrl)

Landing page relative to the context-root. Path should start with '/'. Default is /main.jsp

getEmailLandingPageUrl

public java.lang.String getEmailLandingPageUrl()

Landing page relative to the context-root. Path should start with '/'. Default is /main.jsp

setEmailLandingPageScheme

public void setEmailLandingPageScheme(java.lang.String pEmailLandingPageScheme)

URL scheme (http or https) for the email landing page. Default is http

getEmailLandingPageScheme

public java.lang.String getEmailLandingPageScheme()

URL scheme (http or https) for the email landing page. Default is http

setSelfServiceContextRoot

public void setSelfServiceContextRoot(java.lang.String pSelfServiceContextRoot)

Self-Service Context Root. Default is 'service'

getSelfServiceContextRoot

public java.lang.String getSelfServiceContextRoot()

Self-Service Context Root. Default is 'service'

getSiteIdToBrandMap

public java.util.Map<java.lang.String,java.lang.String> getSiteIdToBrandMap()

Maps siteConfig item ids to brand values. When sending an email from the respond tab, you can specify the Self Service site for a solution link. If the site is brand-based, then you need to add the site id and brand name to this map so we can pass a brand parameter in the Self Service launch URL.

setSiteIdToBrandMap

public void setSiteIdToBrandMap(java.util.Map<java.lang.String,java.lang.String> pSiteIdToBrandMap)

Maps siteConfig item ids to brand values. When sending an email from the respond tab, you can specify the Self Service site for a solution link. If the site is brand-based, then you need to add the site id and brand name to this map so we can pass a brand parameter in the Self Service launch URL.