HeadPipelineServlet (ATG Java API)

java.lang.Object
- atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
- - atg.nucleus.GenericService
  - - atg.nucleus.TimedOperationService
    - - atg.servlet.pipeline.PipelineableServletImpl
      - atg.servlet.pipeline.HeadPipelineServlet

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, PipelineableServlet, java.util.EventListener, javax.servlet.Servlet
```
public class HeadPipelineServlet
extends PipelineableServletImpl
```
This servlet acts as the head of the servlet pipeline. This will take in a ServletRequest/Response pair, and wrap them in DynamoHttpServletRequest/Response objects. The request and response objects are then passed on.
One additional function of this servlet is to check to see if the pathInfo is null. If it is, then pathInfo is set to "".

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATG_VERSION_HEADER` The name of the version header
`static java.lang.String`	`ATG_VERSION_HEADER_VALUE_PREFIX` The Prefix for version header
`static java.lang.String`	`CLASS_VERSION` Class version string
`static java.lang.String`	`CONTENT_SECURITY_POLICY_HEADER` The name of the Content-Security-Policy header
`static java.lang.String`	`CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER` The name of the Content-Security-Policy-Report-Only header
`boolean`	`mManageThreadPriorities`
`static java.lang.String`	`PRE_SESSION_SERVLET_STOP_PROCESSING_ATTRIBUTE_NAME` Name of the request attribute a pre-session servlet can use to indicate no farther processing should be done on the request.
`static java.lang.String`	`VERSION_SERVICE_PATH`
`static java.lang.String`	`X_FRAME_OPTIONS_HEADER` The name of the X-Frame-Options header

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

Constructors
Constructor and Description

HeadPipelineServlet()
Constructs a HeadPipelineServlet

Constructors
Constructor and Description
`HeadPipelineServlet()` Constructs a HeadPipelineServlet

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected DynamoHttpServletRequest`	`createRequestObject()`
`protected DynamoHttpServletResponse`	`createResponseObject()`
`static java.lang.String`	`decodeAtgVersionHeader(java.lang.String pEncodedAtgVersionHeaderInfo)`
`void`	`doStartService()` This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
`static java.lang.String`	`encodeAtgVersionHeader(java.lang.String pAtgVersionHeaderInfo)`
`protected boolean`	`filterMetric(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Checks current request/response pair whether we should filter out them from usage metric calculation.
`java.lang.String`	`getAtgVersionHeader()` Get Atg version header string, the default value is 'X-ATG-Version'.
`int`	`getBufferSize()`
`java.lang.String`	`getContentSecurityPolicyHeader()` Get Content-Security-Policy header
`java.lang.String`	`getContentSecurityPolicyReportOnlyHeader()` Get Content-Security-Policy-Report-Only header
`boolean`	`getFixRequestURI()`
`boolean`	`getFixServletPath()`
`boolean`	`getFixTrailingSlashes()`
`boolean`	`getGenerateRequestLocales()` This value gets set by the HeadPipelineServlet when the request is initially created.
`atg.servlet.sessiontracking.GenericSessionManager`	`getGenericSessionManager()`
`java.lang.String[]`	`getInsertableServlets()` Get the string array of insertable pipeline servlets.
`java.lang.String[]`	`getLicenseChecklist()` Get the license checklist.
`MimeTyper`	`getMimeTyper()` Returns the MimeTyper property
`atg.nucleus.MultiRootNameResolverFactory`	`getMultiNucleusNameResolverFactory()` Returns property multiNucleusNameResolverFactory.
`atg.nucleus.MultiRootNameResolverFactory`	`getNameResolverFactory()` Returns property nameResolverFactory.
`atg.servlet.ParameterHandler`	`getParameterHandler()` Returns the ParameterHandler
`javax.servlet.Servlet`	`getPreSessionServlet()` Returns the servlet to be invoked just before we allocate a session.
`atg.servlet.pipeline.RedirectURLValidatorService`	`getRedirectURLValidator()` Returns property redirectURLValidator.
`DynamoHttpServletRequest`	`getRequest(java.lang.String pSessionId)` Returns a request that you can use to resolve names, create sessions etc.
`java.lang.Class`	`getRequestClass()`
`java.lang.String`	`getRequestLocalePath()` This value gets set by the HeadPipelineServlet when the request is initially created.
`RequestScopeManager`	`getRequestScopeManager()` Returns the RequestScopeManager
`boolean`	`getRequestURIHasQueryString()`
`java.lang.Class`	`getResponseClass()`
`boolean`	`getSetCurrentRequest()`
`java.util.regex.Pattern`	`getStaticPattern()` Returns readonly static pattern.
`java.lang.String[]`	`getStaticResourceExtensions()` Returns array of static resource extensions
`PipelineableServletImpl`	`getStaticServlet()` Returns the servlet to be invoked for processing static resources.
`atg.tracking.UsageMetricFilter[]`	`getUsageMetricFilters()` Returns array of UsageMetricFilter items
`atg.service.dynamo.VersionService`	`getVersionService()`
`atg.nucleus.WindowScopeManager`	`getWindowScopeManager()` Returns the WindowScopeManager
`java.lang.String`	`getXFrameOptionsHeader()` Get X-Frame-Options header
`void`	`handleUsageMetric(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Update current usage metric statistics.
`boolean`	`invokePreSessionServlet(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)` Invoke the preSessionServlet, if any.
`boolean`	`isAddingAtgVersionHeader()` Whether to add the X-ATG-Version header.
`boolean`	`isDynamoPipeline()`
`boolean`	`isManageThreadPriorities()`
`boolean`	`isMetricUsageEnabled()` Returns the flag indicating whether metric usage is enabled.
`boolean`	`isParsingCertificates()` This property controls whether or not this servlet will attempt to parse X509 certificates.
`boolean`	`isReuseRequestFromThread()` Returns property reuseRequestFromThread.
`boolean`	`isStaticRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Checks current request whether we are requesting for static resource.
`protected void`	`parseX509Certificates(DynamoHttpServletRequest pRequest)` parse the X509 certificates contained in the auth-cert header.
`void`	`passRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)` Checks whether we are requesting static resource and start special pipeline in this case.
`void`	`passRequest(javax.servlet.ServletRequest pRequest, javax.servlet.ServletResponse pResponse)` Passes the specified request on to the next servlet in the pipeline
`java.util.Map<java.lang.Long,java.lang.Integer>`	`resetUsageMetric(long pThreshold)` Resets current usage metric statistics and returns usage metric map.
`void`	`service(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse)` Services an HttpServletRequest/Response pair.
`void`	`setAddingAtgVersionHeader(boolean pAddingAtgVersionHeader)` Whether to add the X-ATG-Version header.
`void`	`setAtgVersionHeader(java.lang.String pAtgVersionHeader)` Set Atg version header string, the default value is 'X-ATG-Version'.
`void`	`setBufferSize(int pBufferSize)` Sets the property BufferSize.
`void`	`setContentSecurityPolicyHeader(java.lang.String pContentSecurityPolicyHeader)` Set Content-Security-Policy header.
`void`	`setContentSecurityPolicyReportOnlyHeader(java.lang.String pContentSecurityPolicyReportOnlyHeader)` Set Content-Security-Policy-Report-Only header.
`void`	`setDynamoPipeline(boolean pDynamoPipeline)` Sets the property dynamoPipeline.
`void`	`setFixRequestURI(boolean pFixRequestURI)` Sets the property FixRequestURI.
`void`	`setFixServletPath(boolean pFixServletPath)` Sets the property FixServletPath.
`void`	`setFixTrailingSlashes(boolean pFixTrailingSlashes)` Sets the property FixTrailingSlashes.
`void`	`setGenerateRequestLocales(boolean pValue)` This value gets set by the HeadPipelineServlet when the request is initially created.
`void`	`setGenericSessionManager(atg.servlet.sessiontracking.GenericSessionManager pGenericSessionManager)` Sets the property genericSessionManager.
`void`	`setInsertableServlets(java.lang.String[] pInsertableServlets)` Set the string array of insertable pipeline servlets.
`void`	`setLicenseChecklist(java.lang.String[] pLicenseChecklist)` Set the license checklist.
`void`	`setManageThreadPriorities(boolean pDoManage)` Enables thread priority management.
`void`	`setMetricUsageEnabled(boolean pMetricUsageEnabled)` Sets the flag indicating whether metric usage is enabled.
`void`	`setMimeTyper(MimeTyper pMimeTyper)` Sets the MimeTyper property
`void`	`setMultiNucleusNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pMultiNucleusNameResolverFactory)` Sets property multiNucleusNameResolverFactory.
`void`	`setNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pNameResolverFactory)` Sets property nameResolverFactory.
`void`	`setParameterHandler(atg.servlet.ParameterHandler pParameterHandler)` Sets the ParameterHandler property
`void`	`setParsingCertificates(boolean pParse)` This property controls whether or not this servlet will attempt to parse X509 certificates.
`void`	`setPreSessionServlet(javax.servlet.Servlet pPreSessionServlet)` A servlet to be invoked just before we allocate a session.
`void`	`setRedirectURLValidator(atg.servlet.pipeline.RedirectURLValidatorService pRedirectURLValidator)` Sets property redirectURLValidator.
`void`	`setRequestClass(java.lang.Class pRequestClass)` Sets the property RequestClass.
`void`	`setRequestLocalePath(java.lang.String pValue)` This value gets set by the HeadPipelineServlet when the request is initially created.
`void`	`setRequestScopeManager(RequestScopeManager pRequestScopeManager)` Sets the RequestScopeManager
`void`	`setRequestURIHasQueryString(boolean pRequestURIHasQueryString)` The servlet specification requires that the requestURI not contain query args.
`void`	`setResponseClass(java.lang.Class pResponseClass)` Sets the property ResponseClass.
`void`	`setReuseRequestFromThread(boolean pReuseRequestFromThread)` Sets property reuseRequestFromThread.
`void`	`setSetCurrentRequest(boolean pSetCurrentRequest)` Sets the property SetCurrentRequest.
`void`	`setStaticResourceExtensions(java.lang.String[] pStaticResourceExtensions)` Sets property `staticResourceExtensions`
`void`	`setStaticServlet(PipelineableServletImpl pStaticServlet)` A servlet to be invoked for processing static resources.
`void`	`setUsageMetricFilters(atg.tracking.UsageMetricFilter[] pUsageMetricFilters)` Sets property `usageMetricFilters`
`void`	`setVersionService(atg.service.dynamo.VersionService pVersionService)`
`void`	`setWindowScopeManager(atg.nucleus.WindowScopeManager pWindowScopeManager)` Sets the WindowScopeManager
`void`	`setXFrameOptionsHeader(java.lang.String pXFrameOptionsHeader)` Set X-Frame-Options header.

Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, 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.GenericService
addLogListener, doStopService, getAbsoluteName, 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, toString

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

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - ATG_VERSION_HEADER
```
public static final java.lang.String ATG_VERSION_HEADER
```
    The name of the version header
    
    See Also:
    
    Constant Field Values
  - ATG_VERSION_HEADER_VALUE_PREFIX
```
public static final java.lang.String ATG_VERSION_HEADER_VALUE_PREFIX
```
    The Prefix for version header
    
    See Also:
    
    Constant Field Values
  - X_FRAME_OPTIONS_HEADER
```
public static final java.lang.String X_FRAME_OPTIONS_HEADER
```
    The name of the X-Frame-Options header
    
    See Also:
    
    Constant Field Values
  - CONTENT_SECURITY_POLICY_HEADER
```
public static final java.lang.String CONTENT_SECURITY_POLICY_HEADER
```
    The name of the Content-Security-Policy header
    
    See Also:
    
    Constant Field Values
  - CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER
```
public static final java.lang.String CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER
```
    The name of the Content-Security-Policy-Report-Only header
    
    See Also:
    
    Constant Field Values
  - PRE_SESSION_SERVLET_STOP_PROCESSING_ATTRIBUTE_NAME
```
public static final java.lang.String PRE_SESSION_SERVLET_STOP_PROCESSING_ATTRIBUTE_NAME
```
    Name of the request attribute a pre-session servlet can use to indicate no farther processing should be done on the request. Should be set to Boolean.TRUE to stop processing.
    
    See Also:
    
    Constant Field Values
  - VERSION_SERVICE_PATH
```
public static final java.lang.String VERSION_SERVICE_PATH
```
    See Also:
    
    Constant Field Values
  - mManageThreadPriorities
```
public boolean mManageThreadPriorities
```
- Constructor Detail
  - HeadPipelineServlet
```
public HeadPipelineServlet()
```
    Constructs a HeadPipelineServlet
- Method Detail
  - decodeAtgVersionHeader
```
public static java.lang.String decodeAtgVersionHeader(java.lang.String pEncodedAtgVersionHeaderInfo)
```
  - encodeAtgVersionHeader
```
public static java.lang.String encodeAtgVersionHeader(java.lang.String pAtgVersionHeaderInfo)
```
  - getVersionService
```
public atg.service.dynamo.VersionService getVersionService()
```
  - setVersionService
```
public void setVersionService(atg.service.dynamo.VersionService pVersionService)
```
  - setParameterHandler
```
public void setParameterHandler(atg.servlet.ParameterHandler pParameterHandler)
```
    Sets the ParameterHandler property
  - getParameterHandler
```
public atg.servlet.ParameterHandler getParameterHandler()
```
    Returns the ParameterHandler
  - setMimeTyper
```
public void setMimeTyper(MimeTyper pMimeTyper)
```
    Sets the MimeTyper property
  - getMimeTyper
```
public MimeTyper getMimeTyper()
```
    Returns the MimeTyper property
  - setRequestScopeManager
```
public void setRequestScopeManager(RequestScopeManager pRequestScopeManager)
```
    Sets the RequestScopeManager
  - getRequestScopeManager
```
public RequestScopeManager getRequestScopeManager()
```
    Returns the RequestScopeManager
  - setWindowScopeManager
```
public void setWindowScopeManager(atg.nucleus.WindowScopeManager pWindowScopeManager)
```
    Sets the WindowScopeManager
  - getWindowScopeManager
```
public atg.nucleus.WindowScopeManager getWindowScopeManager()
```
    Returns the WindowScopeManager
  - setNameResolverFactory
```
public void setNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pNameResolverFactory)
```
    Sets property nameResolverFactory. The NameResolverFactory used to create name resolvers for requests.
  - getNameResolverFactory
```
public atg.nucleus.MultiRootNameResolverFactory getNameResolverFactory()
```
    Returns property nameResolverFactory. The NameResolverFactory used to create name resolvers for requests.
  - setMultiNucleusNameResolverFactory
```
public void setMultiNucleusNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pMultiNucleusNameResolverFactory)
```
    Sets property multiNucleusNameResolverFactory. The name resolver factory used to create name resolvers when we are running multiple Nucleii.
  - getMultiNucleusNameResolverFactory
```
public atg.nucleus.MultiRootNameResolverFactory getMultiNucleusNameResolverFactory()
```
    Returns property multiNucleusNameResolverFactory. The name resolver factory used to create name resolvers when we are running multiple Nucleii.
  - setRequestClass
```
public void setRequestClass(java.lang.Class pRequestClass)
```
    Sets the property RequestClass.
  - getRequestClass
```
public java.lang.Class getRequestClass()
```
    Returns:
    
    The value of the property RequestClass.
  - setResponseClass
```
public void setResponseClass(java.lang.Class pResponseClass)
```
    Sets the property ResponseClass.
  - getResponseClass
```
public java.lang.Class getResponseClass()
```
    Returns:
    
    The value of the property ResponseClass.
  - setPreSessionServlet
```
public void setPreSessionServlet(javax.servlet.Servlet pPreSessionServlet)
```
    A servlet to be invoked just before we allocate a session. Note that at the time of the pre session servlet's service method, we do not have a DynamoHttpServletRequest or DynamoHttpServletResponse, and there is no session or request scope. Also note that we may have a session from a previous request, but we have not yet required a session.
    
    Parameters:
    
    pPreSessionServlet - the servlet to be invoked just before a we allocate a session.
  - getPreSessionServlet
```
public javax.servlet.Servlet getPreSessionServlet()
```
    Returns the servlet to be invoked just before we allocate a session. Note that at the time of the pre session servlet's service method, we do not have a DynamoHttpServletRequest or DynamoHttpServletResponse, and there is no session or request scope. Also note that we may have a session from a previous request, but we have not yet required a session.
  - invokePreSessionServlet
```
public boolean invokePreSessionServlet(javax.servlet.http.HttpServletRequest pRequest,
                                       javax.servlet.http.HttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException
```
    Invoke the preSessionServlet, if any.
    
    Parameters:
    
    pRequest - the current request
    
    pResponse - the current response
    
    Returns:
    
    true if PRE_SESSION_SERVLET_STOP_PROCESSING_ATTRIBUTE_NAME has been set to Boolean.TRUE, and no farther processing should be done, false if we should continue processing.
    
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - getGenerateRequestLocales
```
public boolean getGenerateRequestLocales()
```
    This value gets set by the HeadPipelineServlet when the request is initially created.
    A value of false for this property will turn of the creation of RequestLocale objects. No RequestLocale objects will be created for any requests. Calling DynamoHttpServletRequest.getLocale() will return null if this property is set to false. You must set this value to true if you are serving content of a different language than the server runs in.
  - setGenerateRequestLocales
```
public void setGenerateRequestLocales(boolean pValue)
```
    This value gets set by the HeadPipelineServlet when the request is initially created.
    A value of false for this property will turn of the creation of RequestLocale objects. No RequestLocale objects will be created for any requests. Calling DynamoHttpServletRequest.getLocale() will return null if this property is set to false. You must set this value to true if you are serving content of a different language than the server runs in.
  - getRequestLocalePath
```
public java.lang.String getRequestLocalePath()
```
    This value gets set by the HeadPipelineServlet when the request is initially created.
    The path to the request locale component.
  - setRequestLocalePath
```
public void setRequestLocalePath(java.lang.String pValue)
```
    This value gets set by the HeadPipelineServlet when the request is initially created.
    The path to the request locale component.
  - setRequestURIHasQueryString
```
public void setRequestURIHasQueryString(boolean pRequestURIHasQueryString)
```
    The servlet specification requires that the requestURI not contain query args. However, this property is provided to allow compatibility with older versions of Dynamo that returned the requestURI with query arguments. The default is "false," which will result in the behavior required by the specification.
  - getRequestURIHasQueryString
```
public boolean getRequestURIHasQueryString()
```
    Returns:
    
    whether requestURI behaves to specification
  - setParsingCertificates
```
public void setParsingCertificates(boolean pParse)
```
    This property controls whether or not this servlet will attempt to parse X509 certificates. If true the servlet will check for the presence of the auth-cert header. If the header does exist it will be parsed as a BER encoded X509 certificate. The result will be to set an array of objects of type java.security.cert.X509Certificate into the javax.servlet.request.X509Certificate of the request.
  - isParsingCertificates
```
public boolean isParsingCertificates()
```
    This property controls whether or not this servlet will attempt to parse X509 certificates.
  - setSetCurrentRequest
```
public void setSetCurrentRequest(boolean pSetCurrentRequest)
```
    Sets the property SetCurrentRequest.
    
    Parameters:
    
    pSetCurrentRequest - new value to set
  - getSetCurrentRequest
```
public boolean getSetCurrentRequest()
```
    Returns:
    
    The value of the property SetCurrentRequest.
  - setBufferSize
```
public void setBufferSize(int pBufferSize)
```
    Sets the property BufferSize. If this property is set to a non-negative number, we ensure that the incoming request has a buffer size at least this large. This allows servlets in the pipeline to guarantee that they can buffer output.
    
    Parameters:
    
    pBufferSize - new value to set
  - getBufferSize
```
public int getBufferSize()
```
    Returns:
    
    The value of the property BufferSize.
  - setDynamoPipeline
```
public void setDynamoPipeline(boolean pDynamoPipeline)
```
    Sets the property dynamoPipeline. This is true if the request is proceeding through the Dynamo pipeline, false if the request is proceeding through another pipeline mechanism such as the Dynamo Application Framework pipeline.
    
    Parameters:
    
    pDynamoPipeline - new value to set
  - isDynamoPipeline
```
public boolean isDynamoPipeline()
```
    Returns:
    
    The value of the property dynamoPipeline.
  - setGenericSessionManager
```
public void setGenericSessionManager(atg.servlet.sessiontracking.GenericSessionManager pGenericSessionManager)
```
    Sets the property genericSessionManager. This property contains the GenericSessionManager, which only used by the Dynamo Application Framework. The HeadPipelineServlet uses this object to determine which MIME types need sessions created.
  - getGenericSessionManager
```
public atg.servlet.sessiontracking.GenericSessionManager getGenericSessionManager()
```
    Returns:
    
    The value of the property genericSessionManager.
  - isManageThreadPriorities
```
public boolean isManageThreadPriorities()
```
    Returns:
    
    true if we are attempting to drop priorities of threads not in the pipeline.
  - setManageThreadPriorities
```
public void setManageThreadPriorities(boolean pDoManage)
```
    Enables thread priority management. If set to try this servlet will attempt to drop thread priorities when they leave the pipeline and bump them back up when they enter the pipeline. This method does nothing on DAS.
    
    Parameters:
    
    pDoManage -
  - service
```
public void service(javax.servlet.http.HttpServletRequest pRequest,
                    javax.servlet.http.HttpServletResponse pResponse)
             throws java.io.IOException,
                    javax.servlet.ServletException
```
    Services an HttpServletRequest/Response pair. The request and response objects are wrapped by Dynamo request and response objects which are then passed on.
    
    Overrides:
    
    service in class PipelineableServletImpl
    
    Throws:
    
    javax.servlet.ServletException - if an error occurred while processing the servlet request
    
    java.io.IOException - if an error occurred while reading or writing the servlet request
  - setFixTrailingSlashes
```
public void setFixTrailingSlashes(boolean pFixTrailingSlashes)
```
    Sets the property FixTrailingSlashes. If this property is true, we attempt to fix the trailing "/" on the PathInfo. This is a problem one some app servers.
    
    Parameters:
    
    pFixTrailingSlashes - new value to set
  - getFixTrailingSlashes
```
public boolean getFixTrailingSlashes()
```
    Returns:
    
    The value of the property FixTrailingSlashes.
  - setFixRequestURI
```
public void setFixRequestURI(boolean pFixRequestURI)
```
    Sets the property FixRequestURI. If this property is true, we attempt to fix the RequestURI. This is a problem one some app servers (Iplanet).
    
    Parameters:
    
    pFixRequestURI - new value to set
  - getFixRequestURI
```
public boolean getFixRequestURI()
```
    Returns:
    
    The value of the property FixRequestURI.
  - setFixServletPath
```
public void setFixServletPath(boolean pFixServletPath)
```
    Sets the property FixServletPath. If this is true, and the servlet path comes in with just a "/" and the path info does not start with "/", we move the "/" from the ServletPath to the PathInfo. This is a problem on BEA when using the default web app with a servlet dispatches to "/*".
    
    Parameters:
    
    pFixServletPath - new value to set
  - getFixServletPath
```
public boolean getFixServletPath()
```
    Returns:
    
    The value of the property FixServletPath.
  - parseX509Certificates
```
protected void parseX509Certificates(DynamoHttpServletRequest pRequest)
                              throws java.io.IOException,
                                     javax.servlet.ServletException
```
    parse the X509 certificates contained in the auth-cert header.
    
    Throws:
    
    java.io.IOException
    
    javax.servlet.ServletException
  - createRequestObject
```
protected DynamoHttpServletRequest createRequestObject()
```
  - createResponseObject
```
protected DynamoHttpServletResponse createResponseObject()
```
  - getRequest
```
public DynamoHttpServletRequest getRequest(java.lang.String pSessionId)
```
    Returns a request that you can use to resolve names, create sessions etc. If you pass in a null session id, a new session is created. You can retrieve the id of the session with request.getSession(true).getId().
    
    Returns:
    
    the request that has been set up for resolving and session creation. If an error occurs processing the request, null is returned.
  - passRequest
```
public void passRequest(javax.servlet.ServletRequest pRequest,
                        javax.servlet.ServletResponse pResponse)
                 throws java.io.IOException,
                        javax.servlet.ServletException
```
    Passes the specified request on to the next servlet in the pipeline
    
    Specified by:
    
    passRequest in interface PipelineableServlet
    
    Overrides:
    
    passRequest in class PipelineableServletImpl
    
    Throws:
    
    javax.servlet.ServletException - if an error occurred while processing the servlet request
    
    java.io.IOException - if an error occurred while reading or writing the servlet request
  - passRequest
```
public void passRequest(DynamoHttpServletRequest pRequest,
                        DynamoHttpServletResponse pResponse)
                 throws java.io.IOException,
                        javax.servlet.ServletException
```
    Checks whether we are requesting static resource and start special pipeline in this case. Otherwise, do metric pricing and passes the specified request on to the next servlet in the pipeline.
    
    Overrides:
    
    passRequest in class PipelineableServletImpl
    
    Throws:
    
    javax.servlet.ServletException - if an error occurred while processing the servlet request
    
    java.io.IOException - if an error occurred while reading or writing the servlet request
  - doStartService
```
public void doStartService()
                    throws ServiceException
```
    This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.
    
    Overrides:
    
    doStartService in class GenericService
    
    Throws:
    
    ServiceException - if the Service had a problem starting up
  - setLicenseChecklist
```
public void setLicenseChecklist(java.lang.String[] pLicenseChecklist)
```
    Set the license checklist.
  - getLicenseChecklist
```
public java.lang.String[] getLicenseChecklist()
```
    Get the license checklist.
  - setInsertableServlets
```
public void setInsertableServlets(java.lang.String[] pInsertableServlets)
```
    Set the string array of insertable pipeline servlets. The values in this array should be the nucleus names of pipeline servlets to be resolved.
  - getInsertableServlets
```
public java.lang.String[] getInsertableServlets()
```
    Get the string array of insertable pipeline servlets. The values in this array should be the nucleus names of pipeline servlets to be resolved.
  - setRedirectURLValidator
```
public void setRedirectURLValidator(atg.servlet.pipeline.RedirectURLValidatorService pRedirectURLValidator)
```
    Sets property redirectURLValidator. A service to validate whether a redirect should be allowed in sendRedirect and sendLocalRedirect.
  - getRedirectURLValidator
```
public atg.servlet.pipeline.RedirectURLValidatorService getRedirectURLValidator()
```
    Returns property redirectURLValidator. A service to validate whether a redirect should be allowed in sendRedirect and sendLocalRedirect.
  - setAddingAtgVersionHeader
```
public void setAddingAtgVersionHeader(boolean pAddingAtgVersionHeader)
```
    Whether to add the X-ATG-Version header. Defaults to true.
  - isAddingAtgVersionHeader
```
public boolean isAddingAtgVersionHeader()
```
    Whether to add the X-ATG-Version header. Defaults to true.
  - setAtgVersionHeader
```
public void setAtgVersionHeader(java.lang.String pAtgVersionHeader)
```
    Set Atg version header string, the default value is 'X-ATG-Version'.
  - getAtgVersionHeader
```
public java.lang.String getAtgVersionHeader()
```
    Get Atg version header string, the default value is 'X-ATG-Version'.
  - setXFrameOptionsHeader
```
public void setXFrameOptionsHeader(java.lang.String pXFrameOptionsHeader)
```
    Set X-Frame-Options header. Should be set to one of the three X-Frame-Options values: DENY The page cannot be displayed in a frame, regardless of the site attempting to do so. SAMEORIGIN The page can only be displayed in a frame on the same origin as the page itself. ALLOW-FROM uri The page can only be displayed in a frame on the specified origin.
  - getXFrameOptionsHeader
```
public java.lang.String getXFrameOptionsHeader()
```
    Get X-Frame-Options header
  - setContentSecurityPolicyHeader
```
public void setContentSecurityPolicyHeader(java.lang.String pContentSecurityPolicyHeader)
```
    Set Content-Security-Policy header.
  - getContentSecurityPolicyHeader
```
public java.lang.String getContentSecurityPolicyHeader()
```
    Get Content-Security-Policy header
  - setContentSecurityPolicyReportOnlyHeader
```
public void setContentSecurityPolicyReportOnlyHeader(java.lang.String pContentSecurityPolicyReportOnlyHeader)
```
    Set Content-Security-Policy-Report-Only header.
  - getContentSecurityPolicyReportOnlyHeader
```
public java.lang.String getContentSecurityPolicyReportOnlyHeader()
```
    Get Content-Security-Policy-Report-Only header
  - setReuseRequestFromThread
```
public void setReuseRequestFromThread(boolean pReuseRequestFromThread)
```
    Sets property reuseRequestFromThread. Whether we should cache a request on each thread for re-use.
  - isReuseRequestFromThread
```
public boolean isReuseRequestFromThread()
```
    Returns property reuseRequestFromThread. Whether we should cache a request on each thread for re-use.
  - setMetricUsageEnabled
```
public void setMetricUsageEnabled(boolean pMetricUsageEnabled)
```
    Sets the flag indicating whether metric usage is enabled.
  - isMetricUsageEnabled
```
public boolean isMetricUsageEnabled()
```
    Returns the flag indicating whether metric usage is enabled.
  - getUsageMetricFilters
```
public atg.tracking.UsageMetricFilter[] getUsageMetricFilters()
```
    Returns array of UsageMetricFilter items
    
    Returns:
    
    the array of UsageMetricFilter items
  - setUsageMetricFilters
```
public void setUsageMetricFilters(atg.tracking.UsageMetricFilter[] pUsageMetricFilters)
```
    Sets property usageMetricFilters
    
    Parameters:
    
    pUsageMetricFilters - the array of UsageMetricFilter items
  - getStaticResourceExtensions
```
public java.lang.String[] getStaticResourceExtensions()
```
    Returns array of static resource extensions
    
    Returns:
    
    the array of static resource extensions
  - setStaticResourceExtensions
```
public void setStaticResourceExtensions(java.lang.String[] pStaticResourceExtensions)
```
    Sets property staticResourceExtensions
    
    Parameters:
    
    pStaticResourceExtensions - the array of static resource extensions
  - getStaticPattern
```
public java.util.regex.Pattern getStaticPattern()
```
    Returns readonly static pattern. It is constructed and compiled from property staticResourceExtensions
    
    Returns:
    
    the static pattern
  - setStaticServlet
```
public void setStaticServlet(PipelineableServletImpl pStaticServlet)
```
    A servlet to be invoked for processing static resources.
    
    Parameters:
    
    pStaticServlet - the servlet to be invoked for processing static resources
  - getStaticServlet
```
public PipelineableServletImpl getStaticServlet()
```
    Returns the servlet to be invoked for processing static resources.
  - handleUsageMetric
```
public void handleUsageMetric(DynamoHttpServletRequest pRequest,
                              DynamoHttpServletResponse pResponse)
```
    Update current usage metric statistics. This will do nothing if usage metric feature is not being enabled.
  - filterMetric
```
protected boolean filterMetric(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
```
    Checks current request/response pair whether we should filter out them from usage metric calculation.
    
    Returns:
    
    a boolean value indicating whether we should filter out current request/response
  - isStaticRequest
```
public boolean isStaticRequest(DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
```
    Checks current request whether we are requesting for static resource.
    
    Returns:
    
    a boolean value indicating whether we are requesting for static resource
  - resetUsageMetric
```
public java.util.Map<java.lang.Long,java.lang.Integer> resetUsageMetric(long pThreshold)
```
    Resets current usage metric statistics and returns usage metric map. Key represents time in milliseconds and value is a number of requests handled.
    
    Parameters:
    
    pThreshold - value in milliseconds which is used for resetting statistics before that time
    
    Returns:
    
    a map with usage metric statistics which were reset

Class HeadPipelineServlet

Field Summary

Fields inherited from class atg.nucleus.GenericService

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

Constructor Summary

Method Summary

Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl

Methods inherited from class atg.nucleus.TimedOperationService

Methods inherited from class atg.nucleus.GenericService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

ATG_VERSION_HEADER

ATG_VERSION_HEADER_VALUE_PREFIX

X_FRAME_OPTIONS_HEADER

CONTENT_SECURITY_POLICY_HEADER

CONTENT_SECURITY_POLICY_REPORT_ONLY_HEADER

PRE_SESSION_SERVLET_STOP_PROCESSING_ATTRIBUTE_NAME

VERSION_SERVICE_PATH

mManageThreadPriorities

Constructor Detail

HeadPipelineServlet

Method Detail

decodeAtgVersionHeader

encodeAtgVersionHeader

getVersionService

setVersionService

setParameterHandler

getParameterHandler

setMimeTyper

getMimeTyper

setRequestScopeManager

getRequestScopeManager

setWindowScopeManager

getWindowScopeManager

setNameResolverFactory

getNameResolverFactory

setMultiNucleusNameResolverFactory

getMultiNucleusNameResolverFactory

setRequestClass

getRequestClass

setResponseClass

getResponseClass

setPreSessionServlet

getPreSessionServlet

invokePreSessionServlet

getGenerateRequestLocales

setGenerateRequestLocales

getRequestLocalePath

setRequestLocalePath

setRequestURIHasQueryString

getRequestURIHasQueryString

setParsingCertificates

isParsingCertificates

setSetCurrentRequest

getSetCurrentRequest

setBufferSize

getBufferSize

setDynamoPipeline

isDynamoPipeline

setGenericSessionManager

getGenericSessionManager

isManageThreadPriorities

setManageThreadPriorities

service

setFixTrailingSlashes

getFixTrailingSlashes

setFixRequestURI

getFixRequestURI

setFixServletPath

getFixServletPath

parseX509Certificates

createRequestObject

createResponseObject

getRequest

passRequest

passRequest

doStartService