| Package | Description |
|---|---|
| org.apache.shiro.web.env |
Web-specific
Environment implementation and support. |
| org.apache.shiro.web.util |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MutableWebEnvironment
A
WebEnvironment that supports 'write' operations operations. |
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultWebEnvironment
Default
WebEnvironment implementation based on a backing Map instance. |
class |
IniWebEnvironment
|
class |
ResourceBasedWebEnvironment
Abstract implementation for
WebEnvironments that can be initialized via resource paths (config files). |
| Modifier and Type | Method and Description |
|---|---|
protected WebEnvironment |
EnvironmentLoader.createEnvironment(javax.servlet.ServletContext sc)
Instantiates a
WebEnvironment based on the specified ServletContext. |
protected WebEnvironment |
EnvironmentLoader.determineWebEnvironment(javax.servlet.ServletContext servletContext)
Return the WebEnvironment implementation class to use, based on the order of:
A custom WebEnvironment class - specified in the
servletContext EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY property
ServiceLoader.load(WebEnvironment.class) - (if more then one instance is found a ConfigurationException will be thrown
A call to EnvironmentLoader.getDefaultWebEnvironmentClass() (default: IniWebEnvironment)
|
WebEnvironment |
EnvironmentLoader.initEnvironment(javax.servlet.ServletContext servletContext)
Initializes Shiro's
WebEnvironment instance for the specified ServletContext based on the
EnvironmentLoader.CONFIG_LOCATIONS_PARAM value. |
| Modifier and Type | Method and Description |
|---|---|
protected Class<? extends WebEnvironment> |
EnvironmentLoader.getDefaultWebEnvironmentClass()
Returns the default WebEnvironment class, which is unless overridden:
IniWebEnvironment. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
EnvironmentLoader.customizeEnvironment(WebEnvironment environment)
Any additional customization of the Environment can be by overriding this method.
|
protected void |
EnvironmentLoader.finalizeEnvironment(WebEnvironment environment)
Any additional cleanup of the Environment can be done by overriding this method.
|
| Modifier and Type | Method and Description |
|---|---|
static WebEnvironment |
WebUtils.getRequiredWebEnvironment(javax.servlet.ServletContext sc)
Find the Shiro
WebEnvironment for this web application, which is typically loaded via the
EnvironmentLoaderListener. |
static WebEnvironment |
WebUtils.getWebEnvironment(javax.servlet.ServletContext sc)
Find the Shiro
WebEnvironment for this web application, which is typically loaded via
EnvironmentLoaderListener. |
static WebEnvironment |
WebUtils.getWebEnvironment(javax.servlet.ServletContext sc,
String attrName)
Find the Shiro
WebEnvironment for this web application. |
Copyright © 2004–2020 The Apache Software Foundation. All rights reserved.