blob: da64899ad37f7b624b643c6c0354757539f8ac19 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9) on Sun Jan 31 20:49:53 CET 2021 -->
<title>IniWebEnvironment (Apache Shiro 1.7.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-01-31">
<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="IniWebEnvironment (Apache Shiro 1.7.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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">
<!-- ========= 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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/IniWebEnvironment.html">Use</a></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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.shiro.web.env</a></div>
<h2 title="Class IniWebEnvironment" class="title">Class IniWebEnvironment</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../env/DefaultEnvironment.html" title="class in org.apache.shiro.env">org.apache.shiro.env.DefaultEnvironment</a></li>
<li>
<ul class="inheritance">
<li><a href="DefaultWebEnvironment.html" title="class in org.apache.shiro.web.env">org.apache.shiro.web.env.DefaultWebEnvironment</a></li>
<li>
<ul class="inheritance">
<li><a href="ResourceBasedWebEnvironment.html" title="class in org.apache.shiro.web.env">org.apache.shiro.web.env.ResourceBasedWebEnvironment</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.web.env.IniWebEnvironment</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../config/ResourceConfigurable.html" title="interface in org.apache.shiro.config">ResourceConfigurable</a></code>, <code><a href="../../env/Environment.html" title="interface in org.apache.shiro.env">Environment</a></code>, <code><a href="../../env/NamedObjectEnvironment.html" title="interface in org.apache.shiro.env">NamedObjectEnvironment</a></code>, <code><a href="../../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code>, <code><a href="../../util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a></code>, <code><a href="MutableWebEnvironment.html" title="interface in org.apache.shiro.web.env">MutableWebEnvironment</a></code>, <code><a href="WebEnvironment.html" title="interface in org.apache.shiro.web.env">WebEnvironment</a></code></dd>
</dl>
<hr>
<pre>public class <a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.45">IniWebEnvironment</a>
extends <a href="ResourceBasedWebEnvironment.html" title="class in org.apache.shiro.web.env">ResourceBasedWebEnvironment</a>
implements <a href="../../util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a>, <a href="../../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></pre>
<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>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_WEB_INI_RESOURCE_PATH">DEFAULT_WEB_INI_RESOURCE_PATH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FILTER_CHAIN_RESOLVER_NAME">FILTER_CHAIN_RESOLVER_NAME</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.shiro.env.DefaultEnvironment">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.shiro.env.<a href="../../env/DefaultEnvironment.html" title="class in org.apache.shiro.env">DefaultEnvironment</a></h3>
<code><a href="../../env/DefaultEnvironment.html#DEFAULT_SECURITY_MANAGER_KEY">DEFAULT_SECURITY_MANAGER_KEY</a>, <a href="../../env/DefaultEnvironment.html#objects">objects</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">IniWebEnvironment</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure()">configure</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createFilterChainResolver()">createFilterChainResolver</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIni(java.lang.String,boolean)">createIni</a></span>&#8203;(<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;configLocation,
boolean&nbsp;required)</code></th>
<td class="colLast">
<div class="block">Creates an <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance reflecting the specified path, or <code>null</code> if the path does not exist and
is not required.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="../mgt/WebSecurityManager.html" title="interface in org.apache.shiro.web.mgt">WebSecurityManager</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createWebSecurityManager()">createWebSecurityManager</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected <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>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultConfigLocations()">getDefaultConfigLocations</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array with two elements, <code>/WEB-INF/shiro.ini</code> and <code>classpath:shiro.ini</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaultIni()">getDefaultIni</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <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">Map</a>&lt;<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>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDefaults()">getDefaults</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFrameworkIni()">getFrameworkIni</a></span>()</code></th>
<td class="colLast">
<div class="block">Extension point to allow subclasses to provide an <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> configuration that will be merged into the
users configuration.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIni()">getIni</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the <code>Ini</code> instance reflecting this WebEnvironment's configuration.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="../config/WebIniSecurityManagerFactory.html" title="class in org.apache.shiro.web.config">WebIniSecurityManagerFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecurityManagerFactory()">getSecurityManagerFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the SecurityManager factory used by this WebEnvironment.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSpecifiedIni(java.lang.String%5B%5D)">getSpecifiedIni</a></span>&#8203;(<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;configLocations)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init()">init</a></span>()</code></th>
<td class="colLast">
<div class="block">Initializes this instance by resolving any potential (explicit or resource-configured) <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a>
configuration and calling <a href="#configure()"><code>configure</code></a> for actual instance configuration.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mergeIni(org.apache.shiro.config.Ini,org.apache.shiro.config.Ini)">mergeIni</a></span>&#8203;(<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini1,
<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini2)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected <a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseConfig()">parseConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">Loads configuration <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> from <a href="ResourceBasedWebEnvironment.html#getConfigLocations()"><code>ResourceBasedWebEnvironment.getConfigLocations()</code></a> if set, otherwise falling back
to the <a href="#getDefaultConfigLocations()"><code>getDefaultConfigLocations()</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIni(org.apache.shiro.config.Ini)">setIni</a></span>&#8203;(<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini)</code></th>
<td class="colLast">
<div class="block">Allows for configuration via a direct <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance instead of via
<a href="ResourceBasedWebEnvironment.html#getConfigLocations()"><code>config locations</code></a>.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecurityManagerFactory(org.apache.shiro.web.config.WebIniSecurityManagerFactory)">setSecurityManagerFactory</a></span>&#8203;(<a href="../config/WebIniSecurityManagerFactory.html" title="class in org.apache.shiro.web.config">WebIniSecurityManagerFactory</a>&nbsp;factory)</code></th>
<td class="colLast">
<div class="block">Allows for setting the SecurityManager factory which will be used to create the SecurityManager.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.web.env.ResourceBasedWebEnvironment">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.env.<a href="ResourceBasedWebEnvironment.html" title="class in org.apache.shiro.web.env">ResourceBasedWebEnvironment</a></h3>
<code><a href="ResourceBasedWebEnvironment.html#getConfigLocations()">getConfigLocations</a>, <a href="ResourceBasedWebEnvironment.html#setConfigLocations(java.lang.String)">setConfigLocations</a>, <a href="ResourceBasedWebEnvironment.html#setConfigLocations(java.lang.String%5B%5D)">setConfigLocations</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.web.env.DefaultWebEnvironment">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.web.env.<a href="DefaultWebEnvironment.html" title="class in org.apache.shiro.web.env">DefaultWebEnvironment</a></h3>
<code><a href="DefaultWebEnvironment.html#getFilterChainResolver()">getFilterChainResolver</a>, <a href="DefaultWebEnvironment.html#getSecurityManager()">getSecurityManager</a>, <a href="DefaultWebEnvironment.html#getServletContext()">getServletContext</a>, <a href="DefaultWebEnvironment.html#getWebSecurityManager()">getWebSecurityManager</a>, <a href="DefaultWebEnvironment.html#setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver)">setFilterChainResolver</a>, <a href="DefaultWebEnvironment.html#setSecurityManager(org.apache.shiro.mgt.SecurityManager)">setSecurityManager</a>, <a href="DefaultWebEnvironment.html#setServletContext(javax.servlet.ServletContext)">setServletContext</a>, <a href="DefaultWebEnvironment.html#setWebSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager)">setWebSecurityManager</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.env.DefaultEnvironment">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.env.<a href="../../env/DefaultEnvironment.html" title="class in org.apache.shiro.env">DefaultEnvironment</a></h3>
<code><a href="../../env/DefaultEnvironment.html#destroy()">destroy</a>, <a href="../../env/DefaultEnvironment.html#getObject(java.lang.String,java.lang.Class)">getObject</a>, <a href="../../env/DefaultEnvironment.html#getObjects()">getObjects</a>, <a href="../../env/DefaultEnvironment.html#getSecurityManagerName()">getSecurityManagerName</a>, <a href="../../env/DefaultEnvironment.html#lookupSecurityManager()">lookupSecurityManager</a>, <a href="../../env/DefaultEnvironment.html#setObject(java.lang.String,java.lang.Object)">setObject</a>, <a href="../../env/DefaultEnvironment.html#setSecurityManagerName(java.lang.String)">setSecurityManagerName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.util.Destroyable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.shiro.util.<a href="../../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></h3>
<code><a href="../../util/Destroyable.html#destroy()">destroy</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_WEB_INI_RESOURCE_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_WEB_INI_RESOURCE_PATH</h4>
<pre>public static final&nbsp;<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> <a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.47">DEFAULT_WEB_INI_RESOURCE_PATH</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.shiro.web.env.IniWebEnvironment.DEFAULT_WEB_INI_RESOURCE_PATH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="FILTER_CHAIN_RESOLVER_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FILTER_CHAIN_RESOLVER_NAME</h4>
<pre>public static final&nbsp;<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> <a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.48">FILTER_CHAIN_RESOLVER_NAME</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.shiro.web.env.IniWebEnvironment.FILTER_CHAIN_RESOLVER_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IniWebEnvironment</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.59">IniWebEnvironment</a>()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.67">init</a>()</pre>
<div class="block">Initializes this instance by resolving any potential (explicit or resource-configured) <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a>
configuration and calling <a href="#configure()"><code>configure</code></a> for actual instance configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/Initializable.html#init()">init</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/Initializable.html" title="interface in org.apache.shiro.util">Initializable</a></code></dd>
</dl>
</li>
</ul>
<a id="parseConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseConfig</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.81">parseConfig</a>()</pre>
<div class="block">Loads configuration <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> from <a href="ResourceBasedWebEnvironment.html#getConfigLocations()"><code>ResourceBasedWebEnvironment.getConfigLocations()</code></a> if set, otherwise falling back
to the <a href="#getDefaultConfigLocations()"><code>getDefaultConfigLocations()</code></a>. Finally any Ini objects will be merged with the value returned
from <a href="#getFrameworkIni()"><code>getFrameworkIni()</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ini configuration to be used by this Environment.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="configure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.115">configure</a>()</pre>
</li>
</ul>
<a id="getFrameworkIni()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameworkIni</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.168">getFrameworkIni</a>()</pre>
<div class="block">Extension point to allow subclasses to provide an <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> configuration that will be merged into the
users configuration. The users configuration will override anything set here.
<p>
<strong>NOTE:</strong> Framework developers should use with caution. It is possible a user could provide
configuration that would conflict with the frameworks configuration. For example: if this method returns an
Ini object with the following configuration:
<pre><code>
[main]
realm = com.myco.FoobarRealm
realm.foobarSpecificField = A string
</code></pre>
And the user provides a similar configuration:
<pre><code>
[main]
realm = net.differentco.MyCustomRealm
</code></pre>
This would merge into:
<pre><code>
[main]
realm = net.differentco.MyCustomRealm
realm.foobarSpecificField = A string
</code></pre>
This may cause a configuration error if <code>MyCustomRealm</code> does not contain the field <code>foobarSpecificField</code>.
This can be avoided if the Framework Ini uses more unique names, such as <code>foobarRealm</code>. which would result
in a merged configuration that looks like:
<pre><code>
[main]
foobarRealm = com.myco.FoobarRealm
foobarRealm.foobarSpecificField = A string
realm = net.differentco.MyCustomRealm
</code></pre>
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ini configuration used by the framework integrations.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="getSpecifiedIni(java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpecifiedIni</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.172">getSpecifiedIni</a>&#8203;(<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;configLocations)
throws <a href="../../config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></code></dd>
</dl>
</li>
</ul>
<a id="mergeIni(org.apache.shiro.config.Ini,org.apache.shiro.config.Ini)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mergeIni</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.191">mergeIni</a>&#8203;(<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini1,
<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini2)</pre>
</li>
</ul>
<a id="getDefaultIni()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultIni</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.208">getDefaultIni</a>()</pre>
</li>
</ul>
<a id="createIni(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createIni</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.239">createIni</a>&#8203;(<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;configLocation,
boolean&nbsp;required)
throws <a href="../../config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></pre>
<div class="block">Creates an <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance reflecting the specified path, or <code>null</code> if the path does not exist and
is not required.
<p/>
If the path is required and does not exist or is empty, a <a href="../../config/ConfigurationException.html" title="class in org.apache.shiro.config"><code>ConfigurationException</code></a> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configLocation</code> - the resource path to load into an <code>Ini</code> instance.</dd>
<dd><code>required</code> - if the path must exist and be converted to a non-empty <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance reflecting the specified path, or <code>null</code> if the path does not exist and
is not required.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../config/ConfigurationException.html" title="class in org.apache.shiro.config">ConfigurationException</a></code> - if the path is required but results in a null or empty Ini instance.</dd>
</dl>
</li>
</ul>
<a id="createFilterChainResolver()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFilterChainResolver</h4>
<pre class="methodSignature">protected&nbsp;<a href="../filter/mgt/FilterChainResolver.html" title="interface in org.apache.shiro.web.filter.mgt">FilterChainResolver</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.255">createFilterChainResolver</a>()</pre>
</li>
</ul>
<a id="createWebSecurityManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWebSecurityManager</h4>
<pre class="methodSignature">protected&nbsp;<a href="../mgt/WebSecurityManager.html" title="interface in org.apache.shiro.web.mgt">WebSecurityManager</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.274">createWebSecurityManager</a>()</pre>
</li>
</ul>
<a id="getDefaultConfigLocations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultConfigLocations</h4>
<pre class="methodSignature">protected&nbsp;<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;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.303">getDefaultConfigLocations</a>()</pre>
<div class="block">Returns an array with two elements, <code>/WEB-INF/shiro.ini</code> and <code>classpath:shiro.ini</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array with two elements, <code>/WEB-INF/shiro.ini</code> and <code>classpath:shiro.ini</code>.</dd>
</dl>
</li>
</ul>
<a id="getIni()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIni</h4>
<pre class="methodSignature">public&nbsp;<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.377">getIni</a>()</pre>
<div class="block">Returns the <code>Ini</code> instance reflecting this WebEnvironment's configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Ini</code> instance reflecting this WebEnvironment's configuration.</dd>
</dl>
</li>
</ul>
<a id="setIni(org.apache.shiro.config.Ini)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIni</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.389">setIni</a>&#8203;(<a href="../../config/Ini.html" title="class in org.apache.shiro.config">Ini</a>&nbsp;ini)</pre>
<div class="block">Allows for configuration via a direct <a href="../../config/Ini.html" title="class in org.apache.shiro.config"><code>Ini</code></a> instance instead of via
<a href="ResourceBasedWebEnvironment.html#getConfigLocations()"><code>config locations</code></a>.
<p/>
If the specified instance is null or empty, the fallback/default resource-based configuration will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ini</code> - the ini instance to use for creation.</dd>
</dl>
</li>
</ul>
<a id="getDefaults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaults</h4>
<pre class="methodSignature">protected&nbsp;<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">Map</a>&lt;<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>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.393">getDefaults</a>()</pre>
</li>
</ul>
<a id="getSecurityManagerFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecurityManagerFactory</h4>
<pre class="methodSignature">protected&nbsp;<a href="../config/WebIniSecurityManagerFactory.html" title="class in org.apache.shiro.web.config">WebIniSecurityManagerFactory</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.405">getSecurityManagerFactory</a>()</pre>
<div class="block">Returns the SecurityManager factory used by this WebEnvironment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SecurityManager factory used by this WebEnvironment.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="setSecurityManagerFactory(org.apache.shiro.web.config.WebIniSecurityManagerFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setSecurityManagerFactory</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/env/IniWebEnvironment.html#line.416">setSecurityManagerFactory</a>&#8203;(<a href="../config/WebIniSecurityManagerFactory.html" title="class in org.apache.shiro.web.config">WebIniSecurityManagerFactory</a>&nbsp;factory)</pre>
<div class="block">Allows for setting the SecurityManager factory which will be used to create the SecurityManager.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - the SecurityManager factory to used.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/IniWebEnvironment.html">Use</a></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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>