de.hybris.platform.util

Class RootRequestFilter

java.lang.Object

de.hybris.platform.util.RootRequestFilter

Direct Known Subclasses:

HybrisInitFilter, VjdbcConnectionFilter

Deprecated.

since 5.0, please use the filter chain.

@Deprecated
public class RootRequestFilter
extends Object

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 and Description
class	RootRequestFilter.HybrisGZIPResponseWrapper Deprecated.
class	RootRequestFilter.HybrisRequestWrapper Deprecated.
class	RootRequestFilter.HybrisResponseWrapper Deprecated.
static class	RootRequestFilter.HybrisSessionWrapper Deprecated.
static interface	RootRequestFilter.Params Deprecated.
protected class	RootRequestFilter.TenantInformation Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MATCHER_PATTERN Deprecated.
static String	DEFAULT_TENANTID_COOKIE_NAME Deprecated.
static boolean	SERVLET_COMPATIBILITY Deprecated. 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 String	TENANT_ATTRIBUTE_MAP_PREFIX Deprecated.

Constructor Summary

Constructors

Constructor and Description
RootRequestFilter() Deprecated.

Method Summary

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

DEFAULT_TENANTID_COOKIE_NAME

public static final String DEFAULT_TENANTID_COOKIE_NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_MATCHER_PATTERN

public static final String DEFAULT_MATCHER_PATTERN

Deprecated.

See Also:

Constant Field Values

TENANT_ATTRIBUTE_MAP_PREFIX

public static final String TENANT_ATTRIBUTE_MAP_PREFIX

Deprecated.

See Also:

Constant Field Values

SERVLET_COMPATIBILITY

public static final boolean SERVLET_COMPATIBILITY

Deprecated.

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:

Constant Field Values

Constructor Detail

RootRequestFilter

public RootRequestFilter()

Deprecated.

Method Detail

getCurrentTenant

protected static Tenant getCurrentTenant()

Deprecated.

wrapRequest

protected HttpServletRequest wrapRequest(HttpServletRequest original,
                                         HttpServletResponse response,
                                         FilterChain chain)

Deprecated.

wrapResponse

protected HttpServletResponse wrapResponse(HttpServletResponse original,
                                           FilterChain chain,
                                           boolean compress,
                                           boolean mustEncode,
                                           boolean useRegExp)

Deprecated.

assureNeverCalledBefore

protected boolean assureNeverCalledBefore(ServletRequest _request)

Deprecated.

writeShutDownPage

protected void writeShutDownPage(HttpServletResponse resp)
                          throws IOException

Deprecated.

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(ServletRequest _request,
                           ServletResponse _response,
                           FilterChain chain)
                    throws IOException,
                           ServletException

Deprecated.

Throws:

IOException

ServletException

assignCurrentRequestToThread

protected void assignCurrentRequestToThread(HttpServletRequest request)

Deprecated.

clearCurrentRequestFromThread

protected void clearCurrentRequestFromThread()

Deprecated.

touchHttpSession

protected void touchHttpSession(HttpServletRequest request)

Deprecated.

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(HttpServletRequest _request,
                               HttpServletResponse _response)

Deprecated.

doForward

protected String doForward(HttpServletRequest request,
                           HttpServletResponse response)

Deprecated.

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(HttpServletRequest request,
                               HttpServletResponse response)
                        throws ServletException

Deprecated.

This method is called once before the chained request is called.

Returns:

true if the request should be processed

Throws:

ServletException

doPostRequest

protected void doPostRequest(HttpServletRequest request,
                             HttpServletResponse response)
                      throws ServletException

Deprecated.

This method is called once after the chained request is called.

Throws:

ServletException

getFilterConfig

protected FilterConfig getFilterConfig()

Deprecated.

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(HttpServletRequest _request,
                                   HttpServletResponse _response)

Deprecated.

setSlaveDataSourceID

protected void setSlaveDataSourceID(String id,
                                    HttpServletResponse response)

Deprecated.

getSlaveDataSourceID

protected String getSlaveDataSourceID(HttpServletRequest request)

Deprecated.

handleTenantID

protected boolean handleTenantID(HttpServletRequest _request,
                                 HttpServletResponse _response)

Deprecated.

Performs tenant ID handling.

Parameters:

_request -

_response -

getTenantInformationFrom

protected RootRequestFilter.TenantInformation getTenantInformationFrom(HttpServletRequest _request)

Deprecated.

getURI

protected String getURI(HttpServletRequest _request)

Deprecated.

Parameters:

_request - request what we get the uri from

Returns:

specific URI for request

setTenantID

protected void setTenantID(String tenantID,
                           HttpServletRequest request,
                           HttpServletResponse response)

Deprecated.

getTenantSystemID

protected String getTenantSystemID(HttpServletRequest request)

Deprecated.

assertValidTenantID

protected String assertValidTenantID(String id,
                                     boolean allowMaster)

Deprecated.

matchTenantSystemIDToken

protected String matchTenantSystemIDToken(String uri)

Deprecated.

matchTenantSystemIDHost

protected String matchTenantSystemIDHost(String uri)

Deprecated.

init

public void init(FilterConfig filterConfig)
          throws ServletException

Deprecated.

Throws:

ServletException

destroy

public void destroy()

Deprecated.

isSkippedInitSystemTest

public boolean isSkippedInitSystemTest()

Deprecated.

Returns:

the skippedInitSystemTest

setSkippedInitSystemTest

public void setSkippedInitSystemTest(boolean skippedInitSystemTest)

Deprecated.

Parameters:

skippedInitSystemTest - the skippedInitSystemTest to set