|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.servlet.pipeline.PipelineableServletImpl atg.servlet.pipeline.InsertableServletImpl atg.multisite.SiteContextPipelineServlet
public class SiteContextPipelineServlet
This pipeline servlet is responsible for assigning a SiteContext object to the current thread.
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 | |
---|---|
SiteContextPipelineServlet()
Constructs an instanceof SiteContextPipelineServlet |
Method Summary | |
---|---|
protected boolean |
disabledViaWebapp(DynamoHttpServletRequest pRequest)
check to see if the associated web app for this request is configured to disable the use of SiteContext |
void |
doStartService()
start the service. |
java.lang.String |
getContextParamEnableFlagName()
get ContextParamEnableFlagName |
int |
getDefaultErrorCode()
get DefaultErrorCode |
SiteContextRuleFilter |
getDefaultRuleFilter()
get DefaultRuleFilter - this rule filter gets executed if no other rule filters sucessfully return a site ID |
InactiveSiteHandler |
getInactiveSiteHandler()
get InactiveSiteHandler |
atg.service.preview.PreviewServletContextParams |
getPreviewServletContextParams()
get PreviewServletContextParams |
SiteContextRuleFilter[] |
getRuleFilters()
get RuleFilters - the array of components used to determine the site to use for this request |
SiteContextManager |
getSiteContextManager()
get SiteContextManager |
SiteManager |
getSiteManager()
get SiteManager |
java.lang.String |
getSiteSessionManagerPath()
get SiteSessionManagerPath |
protected boolean |
handleSiteEnablement(SiteContext pSiteContext,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
deal with the site enablement logic |
boolean |
isEnabled()
get Enabled |
boolean |
isOnPreviewServer()
get OnPreviewServer |
boolean |
isUsePreviewContextParamForEnableFlag()
get UsePreviewContextParamForEnableFlag |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
service method. |
void |
setContextParamEnableFlagName(java.lang.String pContextParamEnableFlagName)
set ContextParamEnableFlagName |
void |
setDefaultErrorCode(int pDefaultErrorCode)
set DefaultErrorCode |
void |
setDefaultRuleFilter(SiteContextRuleFilter pDefaultRuleFilter)
set DefaultRuleFilter - this rule filter gets executed if no other rule filters sucessfully return a site ID |
void |
setEnabled(boolean pEnabled)
set Enabled |
void |
setInactiveSiteHandler(InactiveSiteHandler pInactiveSiteHandler)
set InactiveSiteHandler |
void |
setOnPreviewServer(boolean pOnPreviewServer)
set OnPreviewServer |
void |
setPreviewServletContextParams(atg.service.preview.PreviewServletContextParams pPreviewServletContextParams)
set PreviewServletContextParams |
void |
setRuleFilters(SiteContextRuleFilter[] pRuleFilters)
set RuleFilters - the array of components used to determine the site to use for this request |
void |
setSiteContextManager(SiteContextManager pSiteContextManager)
set SiteContextManager - the component that manages SiteContext objects |
void |
setSiteManager(SiteManager pSiteManager)
set SiteManager |
void |
setSiteSessionManagerPath(java.lang.String pSiteSessionManagerPath)
set SiteSessionManagerPath |
void |
setUsePreviewContextParamForEnableFlag(boolean pUsePreviewContextParamForEnableFlag)
set UsePreviewContextParamForEnableFlag - if this is set to true then we will use the preview enable flag to determine if site context is enabled for the current web app. |
Methods inherited from class atg.servlet.pipeline.InsertableServletImpl |
---|
getInsertAfterServlet, setInsertAfterServlet |
Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl |
---|
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
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 |
Methods inherited from interface atg.servlet.pipeline.PipelineableServlet |
---|
getNextServlet, passRequest, setNextServlet |
Methods inherited from interface javax.servlet.Servlet |
---|
destroy, getServletConfig, getServletInfo, init, service |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public SiteContextPipelineServlet()
Method Detail |
---|
public void setSiteContextManager(SiteContextManager pSiteContextManager)
pSiteContextManager
- the SiteContextManagerpublic SiteContextManager getSiteContextManager()
public void setRuleFilters(SiteContextRuleFilter[] pRuleFilters)
pRuleFilters
- the RuleFilterspublic SiteContextRuleFilter[] getRuleFilters()
public void setDefaultRuleFilter(SiteContextRuleFilter pDefaultRuleFilter)
pDefaultRuleFilter
- the DefaultRuleFilterpublic SiteContextRuleFilter getDefaultRuleFilter()
public void setOnPreviewServer(boolean pOnPreviewServer)
pOnPreviewServer
- the OnPreviewServerpublic boolean isOnPreviewServer()
public void setSiteSessionManagerPath(java.lang.String pSiteSessionManagerPath)
pSiteSessionManagerPath
- the SiteSessionManagerPathpublic java.lang.String getSiteSessionManagerPath()
public void setInactiveSiteHandler(InactiveSiteHandler pInactiveSiteHandler)
pInactiveSiteHandler
- the InactiveSiteHandlerpublic InactiveSiteHandler getInactiveSiteHandler()
public void setSiteManager(SiteManager pSiteManager)
pSiteManager
- the SiteManagerpublic SiteManager getSiteManager()
public void setDefaultErrorCode(int pDefaultErrorCode)
pDefaultErrorCode
- the DefaultErrorCodepublic int getDefaultErrorCode()
public void setUsePreviewContextParamForEnableFlag(boolean pUsePreviewContextParamForEnableFlag)
pUsePreviewContextParamForEnableFlag
- the UsePreviewContextParamForEnableFlagpublic boolean isUsePreviewContextParamForEnableFlag()
public void setContextParamEnableFlagName(java.lang.String pContextParamEnableFlagName)
pContextParamEnableFlagName
- the ContextParamEnableFlagNamepublic java.lang.String getContextParamEnableFlagName()
public void setEnabled(boolean pEnabled)
pEnabled
- the Enabledpublic boolean isEnabled()
public void setPreviewServletContextParams(atg.service.preview.PreviewServletContextParams pPreviewServletContextParams)
pPreviewServletContextParams
- the PreviewServletContextParamspublic atg.service.preview.PreviewServletContextParams getPreviewServletContextParams()
public void doStartService() throws ServiceException
doStartService
in class InsertableServletImpl
ServiceException
- if the Service had a problem starting uppublic void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
service
in class PipelineableServletImpl
pRequest
- the request objectpResponse
- the response object
java.io.IOException
- if an error occurred while reading or writing
the servlet request
javax.servlet.ServletException
- if an error occurred while processing
the servlet requestprotected boolean handleSiteEnablement(SiteContext pSiteContext, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pSiteContext
- the site context for the requestpRequest
- the Dynamo request objectpResponse
- the Dynamo response object
protected boolean disabledViaWebapp(DynamoHttpServletRequest pRequest)
pRequest
- the dynamo HttpServletRequest
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |