atg.multisite
Class DefaultSiteContextRuleFilter

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.multisite.DefaultSiteContextRuleFilter
All Implemented Interfaces:
SiteContextRuleFilter, 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 DefaultSiteContextRuleFilter
extends GenericService
implements SiteContextRuleFilter

This class provides a basic implementation of the SiteContextRuleFilter interface. Its filter method simply returns a default SiteContext name. This filter should be used as the last in the filter chain so that it only executes if all other methods of determining the site context name fail.


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
DefaultSiteContextRuleFilter()
          Constructs an instanceof DefaultSiteContextRuleFilter
 
Method Summary
 java.lang.String filter(DynamoHttpServletRequest pRequest, SiteSessionManager pSiteSessionManager)
          return a default SiteContext name
 java.lang.String getDefaultSiteId()
          get DefaultSiteId
 boolean isEnabled()
          get Enabled
 void setDefaultSiteId(java.lang.String pDefaultSiteId)
          set DefaultSiteId
 void setEnabled(boolean pEnabled)
          set Enabled
 
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

DefaultSiteContextRuleFilter

public DefaultSiteContextRuleFilter()
Constructs an instanceof DefaultSiteContextRuleFilter

Method Detail

setDefaultSiteId

public void setDefaultSiteId(java.lang.String pDefaultSiteId)
set DefaultSiteId

Parameters:
pDefaultSiteId - the DefaultSiteId

getDefaultSiteId

public java.lang.String getDefaultSiteId()
get DefaultSiteId

Returns:
the DefaultSiteId

setEnabled

public void setEnabled(boolean pEnabled)
set Enabled

Parameters:
pEnabled - the Enabled

isEnabled

public boolean isEnabled()
get Enabled

Returns:
the Enabled

filter

public java.lang.String filter(DynamoHttpServletRequest pRequest,
                               SiteSessionManager pSiteSessionManager)
return a default SiteContext name

Specified by:
filter in interface SiteContextRuleFilter
Parameters:
pRequest - the request object
pSiteSessionManager - the site session manager for the current session
Returns:
the SiteContext name