Package org.apache.shiro.web.config

Class ShiroFilterConfiguration

java.lang.Object

org.apache.shiro.web.config.ShiroFilterConfiguration

public class ShiroFilterConfiguration
extends Object

Configuration for Shiro's root level servlet filter.

Since:

1.10.0

Constructor Summary

Constructors

Constructor	Description
ShiroFilterConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	isFilterOncePerRequest()	Returns true if the filter should only execute once per request.
boolean	isStaticSecurityManagerEnabled()	Returns true if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager), false otherwise.
void	setFilterOncePerRequest(boolean filterOncePerRequest)	Sets whether the filter executes once per request or for every invocation of the filter.
ShiroFilterConfiguration	setStaticSecurityManagerEnabled(boolean staticSecurityManagerEnabled)	Sets if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager).

Methods inherited from class java.lang.Object

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

Constructor Detail

ShiroFilterConfiguration

public ShiroFilterConfiguration()

Method Detail

isFilterOncePerRequest

public boolean isFilterOncePerRequest()

Returns true if the filter should only execute once per request. If set to false the filter will execute each time it is invoked.

Returns:

true if this filter should only execute once per request.

setFilterOncePerRequest

public void setFilterOncePerRequest(boolean filterOncePerRequest)

Sets whether the filter executes once per request or for every invocation of the filter. It is recommended to leave this disabled if you are using a RequestDispatcher to forward or include request (JSP tags, programmatically, or via a framework).

Parameters:

filterOncePerRequest - Whether this filter executes once per request.

isStaticSecurityManagerEnabled

public boolean isStaticSecurityManagerEnabled()

Returns true if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager), false otherwise.

The default value is false.

Returns:

true if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager), false otherwise.

See Also:

SHIRO-287

setStaticSecurityManagerEnabled

public ShiroFilterConfiguration setStaticSecurityManagerEnabled(boolean staticSecurityManagerEnabled)

Sets if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager).

The default value is false.

Parameters:

staticSecurityManagerEnabled - if the constructed SecurityManager associated with the filter should be bound to static memory (via SecurityUtils.setSecurityManager).

See Also:

SHIRO-287