Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.9.1 / apidocs / org / apache / shiro / web / env / class-use / WebEnvironment.html
blob: a2063d0f88569bf5980f50a3cbefc33bbf600084 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.shiro.web.env.WebEnvironment (Apache Shiro 1.9.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Interface org.apache.shiro.web.env.WebEnvironment (Apache Shiro 1.9.1 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav"><!-- Matomo --> <script> var _paq = window._paq = window._paq || []; /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ /* We explicitly disable cookie tracking to avoid privacy issues */ _paq.push(['disableCookies']); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); })(); </script> <!-- End Matomo Code -->
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.apache.shiro.web.env.WebEnvironment" class="title">Uses of Interface<br>org.apache.shiro.web.env.WebEnvironment</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.guice.web">org.apache.shiro.guice.web</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.web.env">org.apache.shiro.web.env</a></th>
<td class="colLast">
<div class="block">Web-specific <a href="../../../env/Environment.html" title="interface in org.apache.shiro.env"><code>Environment</code></a> implementation and support.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.shiro.web.util">org.apache.shiro.web.util</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.shiro.guice.web">
<!-- -->
</a>
<h3>Uses of <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a> in <a href="../../../guice/web/package-summary.html">org.apache.shiro.guice.web</a></h3>
<table class="useSummary">
<caption><span>Method parameters in <a href="../../../guice/web/package-summary.html">org.apache.shiro.guice.web</a> with type arguments of type <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ShiroWebModule.</span><code><span class="memberNameLink"><a href="../../../guice/web/ShiroWebModule.html#bindWebEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindWebEnvironment</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a>&gt;&nbsp;bind)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.shiro.web.env">
<!-- -->
</a>
<h3>Uses of <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a> in <a href="../package-summary.html">org.apache.shiro.web.env</a></h3>
<table class="useSummary">
<caption><span>Subinterfaces of <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a> in <a href="../package-summary.html">org.apache.shiro.web.env</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../MutableWebEnvironment.html" title="interface in org.apache.shiro.web.env">MutableWebEnvironment</a></span></code></th>
<td class="colLast">
<div class="block">A <code>WebEnvironment</code> that supports 'write' operations operations.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Classes in <a href="../package-summary.html">org.apache.shiro.web.env</a> that implement <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../DefaultWebEnvironment.html" title="class in org.apache.shiro.web.env">DefaultWebEnvironment</a></span></code></th>
<td class="colLast">
<div class="block">Default <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> implementation based on a backing <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../IniWebEnvironment.html" title="class in org.apache.shiro.web.env">IniWebEnvironment</a></span></code></th>
<td class="colLast">
<div class="block"><a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> implementation configured by an <a href="../../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance or <code>Ini</code> resource locations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ResourceBasedWebEnvironment.html" title="class in org.apache.shiro.web.env">ResourceBasedWebEnvironment</a></span></code></th>
<td class="colLast">
<div class="block">Abstract implementation for <code>WebEnvironment</code>s that can be initialized via resource paths (config files).</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.shiro.web.env</a> that return <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#createEnvironment(javax.servlet.ServletContext)">createEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;sc)</code></th>
<td class="colLast">
<div class="block">Instantiates a <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> based on the specified ServletContext.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#determineWebEnvironment(javax.servlet.ServletContext)">determineWebEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;servletContext)</code></th>
<td class="colLast">
<div class="block">Return the WebEnvironment implementation class to use, based on the order of:
A custom WebEnvironment class - specified in the <code>servletContext</code> <a href="../EnvironmentLoader.html#ENVIRONMENT_ATTRIBUTE_KEY"><code>EnvironmentLoader.ENVIRONMENT_ATTRIBUTE_KEY</code></a> property
<code>ServiceLoader.load(WebEnvironment.class)</code> - (if more then one instance is found a <a href="../../../config/ConfigurationException.html" title="class in org.apache.shiro.config"><code>ConfigurationException</code></a> will be thrown
A call to <a href="../EnvironmentLoader.html#getDefaultWebEnvironmentClass()"><code>EnvironmentLoader.getDefaultWebEnvironmentClass()</code></a> (default: <a href="../IniWebEnvironment.html" title="class in org.apache.shiro.web.env"><code>IniWebEnvironment</code></a>)
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#initEnvironment(javax.servlet.ServletContext)">initEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;servletContext)</code></th>
<td class="colLast">
<div class="block">Initializes Shiro's <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> instance for the specified <code>ServletContext</code> based on the
<a href="../EnvironmentLoader.html#CONFIG_LOCATIONS_PARAM"><code>EnvironmentLoader.CONFIG_LOCATIONS_PARAM</code></a> value.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.shiro.web.env</a> that return types with arguments of type <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;? extends <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#getDefaultWebEnvironmentClass()">getDefaultWebEnvironmentClass</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the default WebEnvironment class, which is unless overridden: <a href="../IniWebEnvironment.html" title="class in org.apache.shiro.web.env"><code>IniWebEnvironment</code></a>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.shiro.web.env</a> with parameters of type <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#customizeEnvironment(org.apache.shiro.web.env.WebEnvironment)">customizeEnvironment</a></span>&#8203;(<a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a>&nbsp;environment)</code></th>
<td class="colLast">
<div class="block">Any additional customization of the Environment can be by overriding this method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">EnvironmentLoader.</span><code><span class="memberNameLink"><a href="../EnvironmentLoader.html#finalizeEnvironment(org.apache.shiro.web.env.WebEnvironment)">finalizeEnvironment</a></span>&#8203;(<a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a>&nbsp;environment)</code></th>
<td class="colLast">
<div class="block">Any additional cleanup of the Environment can be done by overriding this method.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.shiro.web.util">
<!-- -->
</a>
<h3>Uses of <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a> in <a href="../../util/package-summary.html">org.apache.shiro.web.util</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../../util/package-summary.html">org.apache.shiro.web.util</a> that return <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebUtils.</span><code><span class="memberNameLink"><a href="../../util/WebUtils.html#getRequiredWebEnvironment(javax.servlet.ServletContext)">getRequiredWebEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;sc)</code></th>
<td class="colLast">
<div class="block">Find the Shiro <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> for this web application, which is typically loaded via the
<a href="../EnvironmentLoaderListener.html" title="class in org.apache.shiro.web.env"><code>EnvironmentLoaderListener</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebUtils.</span><code><span class="memberNameLink"><a href="../../util/WebUtils.html#getWebEnvironment(javax.servlet.ServletContext)">getWebEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;sc)</code></th>
<td class="colLast">
<div class="block">Find the Shiro <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> for this web application, which is typically loaded via
<a href="../EnvironmentLoaderListener.html" title="class in org.apache.shiro.web.env"><code>EnvironmentLoaderListener</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebUtils.</span><code><span class="memberNameLink"><a href="../../util/WebUtils.html#getWebEnvironment(javax.servlet.ServletContext,java.lang.String)">getWebEnvironment</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;sc,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;attrName)</code></th>
<td class="colLast">
<div class="block">Find the Shiro <a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> for this web application.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../WebEnvironment.html" title="interface in org.apache.shiro.web.env">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>