atg.multisite
Class PushedSiteParamFilter

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.multisite.PushedSiteParamFilter

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 PushedSiteParamFilter
extends GenericService
implements SiteContextRuleFilter

This filter checks the request for a specific param that indicates that the entire request should take place in the context of the given site.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	SET_STICKY_SITE
static java.lang.String	UNSET_STICKY_SITE

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

PushedSiteParamFilter()
Constructs an instanceof PushedSiteParamFilter

Method Summary

java.lang.String	filter(DynamoHttpServletRequest pRequest, SiteSessionManager pSiteSessionManager) determine the site to use for this request by looking for a param in the request with the key equal to the value set in the property pushSiteParamName.
java.lang.String	getPushSiteParamName() get PushSiteParamName
java.lang.String	getStickySiteParamName() get StickySiteParamName
boolean	isEnabled() get Enabled
boolean	isEnableStickySite() get EnableStickySite
void	setEnabled(boolean pEnabled) set Enabled
void	setEnableStickySite(boolean pEnableStickySite) set EnableStickySite
void	setPushSiteParamName(java.lang.String pPushSiteParamName) set PushSiteParamName
void	setStickySiteParamName(java.lang.String pStickySiteParamName) set StickySiteParamName

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

SET_STICKY_SITE

public static final java.lang.String SET_STICKY_SITE

See Also:

Constant Field Values

UNSET_STICKY_SITE

public static final java.lang.String UNSET_STICKY_SITE

See Also:

Constant Field Values

Constructor Detail

PushedSiteParamFilter

public PushedSiteParamFilter()

Constructs an instanceof PushedSiteParamFilter

Method Detail

setEnabled

public void setEnabled(boolean pEnabled)

set Enabled

Parameters:

pEnabled - the Enabled

isEnabled

public boolean isEnabled()

get Enabled

Returns:

the Enabled

setEnableStickySite

public void setEnableStickySite(boolean pEnableStickySite)

set EnableStickySite

Parameters:

pEnableStickySite - the EnableStickySite

isEnableStickySite

public boolean isEnableStickySite()

get EnableStickySite

Returns:

the EnableStickySite

setPushSiteParamName

public void setPushSiteParamName(java.lang.String pPushSiteParamName)

set PushSiteParamName

Parameters:

pPushSiteParamName - the PushSiteParamName

getPushSiteParamName

public java.lang.String getPushSiteParamName()

get PushSiteParamName

Returns:

the PushSiteParamName

setStickySiteParamName

public void setStickySiteParamName(java.lang.String pStickySiteParamName)

set StickySiteParamName

Parameters:

pStickySiteParamName - the StickySiteParamName

getStickySiteParamName

public java.lang.String getStickySiteParamName()

get StickySiteParamName

Returns:

the StickySiteParamName

filter

public java.lang.String filter(DynamoHttpServletRequest pRequest,
                               SiteSessionManager pSiteSessionManager)

determine the site to use for this request by looking for a param in the request with the key equal to the value set in the property pushSiteParamName. The value should correspond to the Id of the site to use for this request.

Specified by:

filter in interface SiteContextRuleFilter

Parameters:

pRequest - the request object

pSiteSessionManager - the site session manager for the current session

Returns:

the name of the SiteContext to use for this request