Package com.devonfw.module.web.common.base

Class ToggleFilterWrapper

java.lang.Object

com.devonfw.module.web.common.base.ToggleFilterWrapper

All Implemented Interfaces:

javax.servlet.Filter

public class ToggleFilterWrapper
extends Object
implements javax.servlet.Filter

This class is responsible for wrapping a Filter and allows to be disabled e.g. for development tests (e.g. via an application property). In case the filter gets disabled a WARNING log message is produced and also written to System.err.
As an example you can use it to wrap the in order to allow disabling in local tests (to ease REST testing).

Field Summary

Fields

Modifier and Type	Field	Description
private javax.servlet.Filter	delegateFilter	The delegated Filter.
private Boolean	enabled	Is set if this filter is enabled.
private static org.slf4j.Logger	LOG	Logger instance.

Constructor Summary

Constructors

Constructor	Description
ToggleFilterWrapper()

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
void	initialize()	Initializes this object.
Boolean	isEnabled()
void	setDelegateFilter(javax.servlet.Filter delegateFilter)
void	setEnabled(Boolean enabled)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Logger instance.

delegateFilter

private javax.servlet.Filter delegateFilter

The delegated Filter.

enabled

private Boolean enabled

Is set if this filter is enabled.

Constructor Detail

ToggleFilterWrapper

public ToggleFilterWrapper()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

initialize

@PostConstruct
public void initialize()

Initializes this object.

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

setDelegateFilter

public void setDelegateFilter(javax.servlet.Filter delegateFilter)

Parameters:

delegateFilter - the filter to delegate to

setEnabled

public void setEnabled(Boolean enabled)

Parameters:

enabled - the enabled flag

isEnabled

public Boolean isEnabled()

Returns:

disabled