Package de.hybris.platform.util

Class RootRequestFilter

java.lang.Object
de.hybris.platform.util.RootRequestFilter
All Implemented Interfaces:
javax.servlet.Filter
Direct Known Subclasses:
HybrisInitFilter
@Deprecated(since="5.0", forRemoval=true) public class RootRequestFilter extends Object implements javax.servlet.Filter
Deprecated, for removal: This API element is subject to removal in a future version.
since 5.0, please use the filter chain.
The RootRequestFilter can be used if a Filter should only be called once per request and not for chained calls of RequestDispatcher.include(..) Only the top level request is intercepted and the abstract doPreRequest(..) and doPostRequest(..) methods are called.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    RootRequestFilter.HybrisGZIPResponseWrapper
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    class 
    RootRequestFilter.HybrisRequestWrapper
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    class 
    RootRequestFilter.HybrisResponseWrapper
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static class 
    RootRequestFilter.HybrisSessionWrapper
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static interface 
    RootRequestFilter.Params
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected class 
    RootRequestFilter.TenantInformation
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_MATCHER_PATTERN
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    DEFAULT_TENANTID_COOKIE_NAME
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final boolean
    SERVLET_COMPATIBILITY
    Deprecated, for removal: This API element is subject to removal in a future version.
    servlet compatibility has to be disabled if running with weblogic! if not we get errors like java.lang.IllegalStateException: getWriter() has already been called! at de.hybris.platform.util.RootRequestFilter$HybrisGZIPResponseWrapper.
    static final String
    TENANT_ATTRIBUTE_MAP_PREFIX
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RootRequestFilter()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    adjustEncodings(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    assertValidTenantID(String id, boolean allowMaster)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    assignCurrentRequestToThread(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected boolean
    assureNeverCalledBefore(javax.servlet.ServletRequest _request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    clearCurrentRequestFromThread()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    destroy()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    final void
    doFilter(javax.servlet.ServletRequest _request, javax.servlet.ServletResponse _response, javax.servlet.FilterChain chain)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    doForward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Hook method to allow filter instances to forward to a different page.
    protected void
    doPostRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method is called once after the chained request is called.
    protected boolean
    doPreRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method is called once before the chained request is called.
    protected static Tenant
    getCurrentTenant()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected javax.servlet.FilterConfig
    getFilterConfig()
    Deprecated, for removal: This API element is subject to removal in a future version.
    protected method which can be used to obtain the FilterConfig instance which is bound to this Filter instance.
    protected String
    getSlaveDataSourceID(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected RootRequestFilter.TenantInformation
    getTenantInformationFrom(javax.servlet.http.HttpServletRequest _request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    getTenantSystemID(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    getURI(javax.servlet.http.HttpServletRequest _request)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    handleSlaveSettings(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected boolean
    handleTenantID(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Performs tenant ID handling.
    void
    init(javax.servlet.FilterConfig filterConfig)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isSkippedInitSystemTest()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    matchTenantSystemIDHost(String uri)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    matchTenantSystemIDToken(String uri)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSkippedInitSystemTest(boolean skippedInitSystemTest)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    setSlaveDataSourceID(String id, javax.servlet.http.HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    setTenantID(String tenantID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    touchHttpSession(javax.servlet.http.HttpServletRequest request)
    Deprecated, for removal: This API element is subject to removal in a future version.
    removes jalosession attribute from httpSession and inserts it again to force copying of jaloSession among tomcat's cluster nodes
    protected javax.servlet.http.HttpServletRequest
    wrapRequest(javax.servlet.http.HttpServletRequest original, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected javax.servlet.http.HttpServletResponse
    wrapResponse(javax.servlet.http.HttpServletResponse original, javax.servlet.FilterChain chain, boolean compress, boolean mustEncode, boolean useRegExp)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    writeShutDownPage(javax.servlet.http.HttpServletResponse resp)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Writes a maintenance message to the response.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_MATCHER_PATTERN

      public static final String DEFAULT_MATCHER_PATTERN
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • TENANT_ATTRIBUTE_MAP_PREFIX

      public static final String TENANT_ATTRIBUTE_MAP_PREFIX
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • SERVLET_COMPATIBILITY

      public static final boolean SERVLET_COMPATIBILITY
      Deprecated, for removal: This API element is subject to removal in a future version.
      servlet compatibility has to be disabled if running with weblogic! if not we get errors like java.lang.IllegalStateException: getWriter() has already been called! at de.hybris.platform.util.RootRequestFilter$HybrisGZIPResponseWrapper. getOutputStream(RootRequestFilter.java:357) We have not yet analyzed the root cause of this problem. See also PLA-5702.
      See Also:

  • Constructor Details

    • RootRequestFilter

      public RootRequestFilter()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getCurrentTenant

      protected static Tenant getCurrentTenant()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • wrapRequest

      protected javax.servlet.http.HttpServletRequest wrapRequest(javax.servlet.http.HttpServletRequest original, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • wrapResponse

      protected javax.servlet.http.HttpServletResponse wrapResponse(javax.servlet.http.HttpServletResponse original, javax.servlet.FilterChain chain, boolean compress, boolean mustEncode, boolean useRegExp)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • assureNeverCalledBefore

      protected boolean assureNeverCalledBefore(javax.servlet.ServletRequest _request)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • writeShutDownPage

      protected void writeShutDownPage(javax.servlet.http.HttpServletResponse resp) throws IOException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Writes a maintenance message to the response. Called when a shutdown is in progress. Overwrite if you want to customize the response in case of a shutdown.
      Parameters:
      resp - response to use
      Throws:
      IOException - error at writing to output stream
      Since:
      3.1-u6

    • doFilter

      public final void doFilter(javax.servlet.ServletRequest _request, javax.servlet.ServletResponse _response, javax.servlet.FilterChain chain) throws IOException, javax.servlet.ServletException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      doFilter in interface javax.servlet.Filter
      Throws:
      IOException
      javax.servlet.ServletException

    • assignCurrentRequestToThread

      protected void assignCurrentRequestToThread(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • clearCurrentRequestFromThread

      protected void clearCurrentRequestFromThread()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • touchHttpSession

      protected void touchHttpSession(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.
      removes jalosession attribute from httpSession and inserts it again to force copying of jaloSession among tomcat's cluster nodes
      Parameters:
      request -

    • adjustEncodings

      protected void adjustEncodings(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • doForward

      protected String doForward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Hook method to allow filter instances to forward to a different page. As default this method returns null which means no forwarding.
      Parameters:
      request -
      response -
      Returns:
      the forward page uri or null if forwarding is not required

    • doPreRequest

      protected boolean doPreRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is called once before the chained request is called.
      Returns:
      true if the request should be processed
      Throws:
      javax.servlet.ServletException

    • doPostRequest

      protected void doPostRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method is called once after the chained request is called.
      Throws:
      javax.servlet.ServletException

    • getFilterConfig

      protected javax.servlet.FilterConfig getFilterConfig()
      Deprecated, for removal: This API element is subject to removal in a future version.
      protected method which can be used to obtain the FilterConfig instance which is bound to this Filter instance.
      Returns:
      the FilterConfig instance.

    • handleSlaveSettings

      protected void handleSlaveSettings(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSlaveDataSourceID

      protected void setSlaveDataSourceID(String id, javax.servlet.http.HttpServletResponse response)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSlaveDataSourceID

      protected String getSlaveDataSourceID(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • handleTenantID

      protected boolean handleTenantID(javax.servlet.http.HttpServletRequest _request, javax.servlet.http.HttpServletResponse _response)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Performs tenant ID handling.
      Parameters:
      _request -
      _response -

    • getTenantInformationFrom

      protected RootRequestFilter.TenantInformation getTenantInformationFrom(javax.servlet.http.HttpServletRequest _request)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getURI

      protected String getURI(javax.servlet.http.HttpServletRequest _request)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parameters:
      _request - request what we get the uri from
      Returns:
      specific URI for request

    • setTenantID

      protected void setTenantID(String tenantID, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTenantSystemID

      protected String getTenantSystemID(javax.servlet.http.HttpServletRequest request)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • assertValidTenantID

      protected String assertValidTenantID(String id, boolean allowMaster)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • matchTenantSystemIDToken

      protected String matchTenantSystemIDToken(String uri)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • matchTenantSystemIDHost

      protected String matchTenantSystemIDHost(String uri)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • init

      public void init(javax.servlet.FilterConfig filterConfig) throws javax.servlet.ServletException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      init in interface javax.servlet.Filter
      Throws:
      javax.servlet.ServletException

    • destroy

      public void destroy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      destroy in interface javax.servlet.Filter

    • isSkippedInitSystemTest

      public boolean isSkippedInitSystemTest()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      the skippedInitSystemTest

    • setSkippedInitSystemTest

      public void setSkippedInitSystemTest(boolean skippedInitSystemTest)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Parameters:
      skippedInitSystemTest - the skippedInitSystemTest to set