Class DefaultWebEnvironment

java.lang.Object

org.apache.shiro.env.DefaultEnvironment

org.apache.shiro.web.env.DefaultWebEnvironment

All Implemented Interfaces:

org.apache.shiro.env.Environment, org.apache.shiro.env.NamedObjectEnvironment, org.apache.shiro.lang.util.Destroyable, MutableWebEnvironment, WebEnvironment

Direct Known Subclasses:

ResourceBasedWebEnvironment

public class DefaultWebEnvironment
extends org.apache.shiro.env.DefaultEnvironment
implements MutableWebEnvironment

Default WebEnvironment implementation based on a backing Map instance.

Since:

1.2

Field Summary

Fields inherited from class org.apache.shiro.env.DefaultEnvironment

DEFAULT_SECURITY_MANAGER_KEY, objects

Constructor Summary

Constructors

Constructor	Description
DefaultWebEnvironment()

Method Summary

Modifier and Type	Method	Description
FilterChainResolver	getFilterChainResolver()	Returns the web application's FilterChainResolver if one has been configured or null if one is not available.
org.apache.shiro.mgt.SecurityManager	getSecurityManager()
javax.servlet.ServletContext	getServletContext()	Returns the ServletContext associated with this WebEnvironment instance.
ShiroFilterConfiguration	getShiroFilterConfiguration()	Returns the configuration object used to configure the ShiroFilter.
WebSecurityManager	getWebSecurityManager()	Returns the web application's security manager instance.
void	setFilterChainResolver(FilterChainResolver filterChainResolver)	Sets the WebEnvironment's FilterChainResolver.
void	setSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager)
void	setServletContext(javax.servlet.ServletContext servletContext)	Sets the WebEnvironment's associated ServletContext instance.
void	setShiroFilterConfiguration(ShiroFilterConfiguration filterConfiguration)	Sets the WebEnvironment's ShiroFilterConfiguration.
void	setWebSecurityManager(WebSecurityManager wsm)	Sets the WebEnvironment's WebSecurityManager.

Methods inherited from class org.apache.shiro.env.DefaultEnvironment

destroy, getObject, getObjects, getSecurityManagerName, lookupSecurityManager, setObject, setSecurityManagerName

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultWebEnvironment

public DefaultWebEnvironment()

Method Details

getFilterChainResolver

public FilterChainResolver getFilterChainResolver()

Description copied from interface: WebEnvironment

Returns the web application's FilterChainResolver if one has been configured or null if one is not available.

Specified by:

getFilterChainResolver in interface WebEnvironment

Returns:

the web application's FilterChainResolver if one has been configured or null if one is not available.

setFilterChainResolver

public void setFilterChainResolver(FilterChainResolver filterChainResolver)

Description copied from interface: MutableWebEnvironment

Sets the WebEnvironment's FilterChainResolver.

Specified by:

setFilterChainResolver in interface MutableWebEnvironment

Parameters:

filterChainResolver - the WebEnvironment's FilterChainResolver.

getSecurityManager

public org.apache.shiro.mgt.SecurityManager getSecurityManager()
                                                        throws IllegalStateException

Specified by:

getSecurityManager in interface org.apache.shiro.env.Environment

Overrides:

getSecurityManager in class org.apache.shiro.env.DefaultEnvironment

Throws:

IllegalStateException

setSecurityManager

public void setSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager)

Overrides:

setSecurityManager in class org.apache.shiro.env.DefaultEnvironment

getWebSecurityManager

public WebSecurityManager getWebSecurityManager()

Description copied from interface: WebEnvironment

Returns the web application's security manager instance.

Specified by:

getWebSecurityManager in interface WebEnvironment

Returns:

the web application's security manager instance.

setWebSecurityManager

public void setWebSecurityManager(WebSecurityManager wsm)

Description copied from interface: MutableWebEnvironment

Sets the WebEnvironment's WebSecurityManager.

Specified by:

setWebSecurityManager in interface MutableWebEnvironment

Parameters:

wsm - the WebEnvironment's WebSecurityManager.

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: WebEnvironment

Returns the ServletContext associated with this WebEnvironment instance. A web application typically only has a single WebEnvironment associated with its ServletContext.

Specified by:

getServletContext in interface WebEnvironment

Returns:

the ServletContext associated with this WebEnvironment instance.

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Description copied from interface: MutableWebEnvironment

Sets the WebEnvironment's associated ServletContext instance. Invoking this method merely makes the ServletContext available to the underlying instance - it does not trigger initialization behavior.

Specified by:

setServletContext in interface MutableWebEnvironment

Parameters:

servletContext - the WebEnvironment's associated ServletContext instance.

setShiroFilterConfiguration

public void setShiroFilterConfiguration(ShiroFilterConfiguration filterConfiguration)

Description copied from interface: MutableWebEnvironment

Sets the WebEnvironment's ShiroFilterConfiguration.

Specified by:

setShiroFilterConfiguration in interface MutableWebEnvironment

Parameters:

filterConfiguration - the WebEnvironment's ShiroFilterConfiguration.

getShiroFilterConfiguration

public ShiroFilterConfiguration getShiroFilterConfiguration()

Description copied from interface: WebEnvironment

Returns the configuration object used to configure the ShiroFilter.

Specified by:

getShiroFilterConfiguration in interface WebEnvironment

Returns:

the configuration object used to configure the ShiroFilter.