Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.11.0 / shiro-support / apidocs / org / apache / shiro / guice / web / ShiroWebModule.html
blob: 96f112c68d46b33c6e493882cff4c59653d4f039 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ShiroWebModule (Apache Shiro :: Support 1.11.0 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="ShiroWebModule (Apache Shiro :: Support 1.11.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":41,"i12":41,"i13":41,"i14":10,"i15":6,"i16":9,"i17":9,"i18":9,"i19":9,"i20":10,"i21":9,"i22":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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"><!-- 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 class="navBarCell1Rev">Class</li>
<li><a href="class-use/ShiroWebModule.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><a href="#nested.class.summary">Nested</a>&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.guice.web</a></div>
<h2 title="Class ShiroWebModule" class="title">Class ShiroWebModule</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>com.google.inject.PrivateModule</li>
<li>
<ul class="inheritance">
<li><a href="../ShiroModule.html" title="class in org.apache.shiro.guice">org.apache.shiro.guice.ShiroModule</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.guice.web.ShiroWebModule</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>com.google.inject.Module</code>, <code>org.apache.shiro.util.Destroyable</code></dd>
</dl>
<hr>
<pre>public abstract class <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.67">ShiroWebModule</a>
extends <a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></pre>
<div class="block">Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default
<code>WebSecurityManager</code>, <code>SecurityManager</code> and <code>SessionManager</code>. At least one realm must be added by
using <a href="../ShiroModule.html#bindRealm()"><code>bindRealm</code></a>.
<p/>
Also provides for the configuring of filter chains and binds a <code>FilterChainResolver</code> with that information.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</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>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;<a href="ShiroWebModule.FilterConfig.html" title="type parameter in ShiroWebModule.FilterConfig">T</a> extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;</span></code></th>
<td class="colLast">
<div class="block">Filter configuration which pairs a Filter class with its configuration used on a path.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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 com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.AnonymousFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANON">ANON</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.FormAuthenticationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AUTHC">AUTHC</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AUTHC_BASIC">AUTHC_BASIC</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.BearerHttpAuthenticationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AUTHC_BEARER">AUTHC_BEARER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.InvalidRequestFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INVALID_REQUEST">INVALID_REQUEST</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.LogoutFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOGOUT">LOGOUT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.session.NoSessionCreationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NO_SESSION_CREATION">NO_SESSION_CREATION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PERMS">PERMS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.PortFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PORT">PORT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#REST">REST</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.RolesAuthorizationFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ROLES">ROLES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.SslFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SSL">SSL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.UserFilter&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#USER">USER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</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(javax.servlet.ServletContext)">ShiroWebModule</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">&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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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="#addFilterChain(java.lang.String,com.google.inject.Key)">addFilterChain</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;pattern,
com.google.inject.Key&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;key)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFilterChain(java.lang.String,com.google.inject.Key...)">addFilterChain</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;pattern,
com.google.inject.Key&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;...&nbsp;keys)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addFilterChain(java.lang.String,org.apache.shiro.guice.web.ShiroWebModule.FilterConfig...)">addFilterChain</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;pattern,
<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;...&nbsp;filterConfigs)</code></th>
<td class="colLast">
<div class="block">Maps 'n' number of <code>filterConfig</code>s to a specific path pattern.<BR/>
For example, a path of '/my_private_resource/**' to 'filterConfig(AUTHC)' would require
any resource under the path '/my_private_resource' would be processed through the <code>FormAuthenticationFilter</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindEnvironment</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;org.apache.shiro.env.Environment&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the environment.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindGuiceFilter(com.google.inject.Binder)">bindGuiceFilter</a></span>&#8203;(com.google.inject.Binder&nbsp;binder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindGuiceFilter(java.lang.String,com.google.inject.Binder)">bindGuiceFilter</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;pattern,
com.google.inject.Binder&nbsp;binder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSecurityManager</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.mgt.SecurityManager&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the security manager.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSessionManager</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;org.apache.shiro.session.mgt.SessionManager&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the session manager.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindShiroFilterConfiguration(com.google.inject.binder.AnnotatedBindingBuilder)">bindShiroFilterConfiguration</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.config.ShiroFilterConfiguration&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the Shiro Filter Configuration.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindWebEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindWebEnvironment</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.env.WebEnvironment&gt;&nbsp;bind)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindWebSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindWebSecurityManager</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.mgt.WebSecurityManager&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the security manager.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected static &lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;<br>com.google.inject.Key&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#config(com.google.inject.Key,java.lang.String)">config</a></span>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey,
<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;configValue)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected static &lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;<br>com.google.inject.Key&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#config(com.google.inject.TypeLiteral,java.lang.String)">config</a></span>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
<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;configValue)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected static &lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;<br>com.google.inject.Key&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#config(java.lang.Class,java.lang.String)">config</a></span>&#8203;(<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;T&gt;&nbsp;type,
<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;configValue)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureShiro()">configureShiro</a></span>()</code></th>
<td class="colLast">
<div class="block">Implement this method in order to configure your realms and any other Shiro customization you may need.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureShiroWeb()">configureShiroWeb</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>protected static &lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;<br><a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterConfig(com.google.inject.Key)">filterConfig</a></span>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey)</code></th>
<td class="colLast">
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected static &lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;<br><a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterConfig(com.google.inject.Key,java.lang.String)">filterConfig</a></span>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey,
<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;configValue)</code></th>
<td class="colLast">
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected static &lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;<br><a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterConfig(com.google.inject.TypeLiteral,java.lang.String)">filterConfig</a></span>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
<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;configValue)</code></th>
<td class="colLast">
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected static &lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;<br><a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filterConfig(java.lang.Class,java.lang.String)">filterConfig</a></span>&#8203;(<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;T&gt;&nbsp;type,
<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;configValue)</code></th>
<td class="colLast">
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#globalFilters()">globalFilters</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static com.google.inject.servlet.ServletModule</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#guiceFilterModule()">guiceFilterModule</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static com.google.inject.servlet.ServletModule</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#guiceFilterModule(java.lang.String)">guiceFilterModule</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;pattern)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.shiro.guice.ShiroModule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.shiro.guice.<a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></h3>
<code><a href="../ShiroModule.html#add(org.apache.shiro.util.Destroyable)">add</a>, <a href="../ShiroModule.html#bindBeanType(com.google.inject.TypeLiteral,com.google.inject.Key)">bindBeanType</a>, <a href="../ShiroModule.html#bindEventBus(com.google.inject.binder.AnnotatedBindingBuilder)">bindEventBus</a>, <a href="../ShiroModule.html#bindRealm()">bindRealm</a>, <a href="../ShiroModule.html#configure()">configure</a>, <a href="../ShiroModule.html#destroy()">destroy</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.google.inject.PrivateModule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.google.inject.PrivateModule</h3>
<code>addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, expose, expose, expose, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding</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>
</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="ANON">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANON</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.AnonymousFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.68">ANON</a></pre>
</li>
</ul>
<a id="AUTHC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AUTHC</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.FormAuthenticationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.70">AUTHC</a></pre>
</li>
</ul>
<a id="AUTHC_BASIC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AUTHC_BASIC</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.BasicHttpAuthenticationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.72">AUTHC_BASIC</a></pre>
</li>
</ul>
<a id="AUTHC_BEARER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AUTHC_BEARER</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.BearerHttpAuthenticationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.74">AUTHC_BEARER</a></pre>
</li>
</ul>
<a id="NO_SESSION_CREATION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NO_SESSION_CREATION</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.session.NoSessionCreationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.76">NO_SESSION_CREATION</a></pre>
</li>
</ul>
<a id="LOGOUT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOGOUT</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.LogoutFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.78">LOGOUT</a></pre>
</li>
</ul>
<a id="PERMS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERMS</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.PermissionsAuthorizationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.80">PERMS</a></pre>
</li>
</ul>
<a id="PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PORT</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.PortFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.82">PORT</a></pre>
</li>
</ul>
<a id="REST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>REST</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.HttpMethodPermissionFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.84">REST</a></pre>
</li>
</ul>
<a id="ROLES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROLES</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.RolesAuthorizationFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.86">ROLES</a></pre>
</li>
</ul>
<a id="SSL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SSL</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authz.SslFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.88">SSL</a></pre>
</li>
</ul>
<a id="USER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USER</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.authc.UserFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.90">USER</a></pre>
</li>
</ul>
<a id="INVALID_REQUEST">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INVALID_REQUEST</h4>
<pre>public static final&nbsp;com.google.inject.Key&lt;org.apache.shiro.web.filter.InvalidRequestFilter&gt; <a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.92">INVALID_REQUEST</a></pre>
</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;(javax.servlet.ServletContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ShiroWebModule</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.104">ShiroWebModule</a>&#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)</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="bindGuiceFilter(com.google.inject.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindGuiceFilter</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.108">bindGuiceFilter</a>&#8203;(com.google.inject.Binder&nbsp;binder)</pre>
</li>
</ul>
<a id="bindGuiceFilter(java.lang.String,com.google.inject.Binder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindGuiceFilter</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.112">bindGuiceFilter</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;pattern,
com.google.inject.Binder&nbsp;binder)</pre>
</li>
</ul>
<a id="guiceFilterModule()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>guiceFilterModule</h4>
<pre class="methodSignature">public static&nbsp;com.google.inject.servlet.ServletModule&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.117">guiceFilterModule</a>()</pre>
</li>
</ul>
<a id="guiceFilterModule(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>guiceFilterModule</h4>
<pre class="methodSignature">public static&nbsp;com.google.inject.servlet.ServletModule&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.121">guiceFilterModule</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;pattern)</pre>
</li>
</ul>
<a id="globalFilters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>globalFilters</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.130">globalFilters</a>()</pre>
</li>
</ul>
<a id="configureShiro()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureShiro</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.134">configureShiro</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../ShiroModule.html#configureShiro()">ShiroModule</a></code></span></div>
<div class="block">Implement this method in order to configure your realms and any other Shiro customization you may need.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../ShiroModule.html#configureShiro()">configureShiro</a></code>&nbsp;in class&nbsp;<code><a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></code></dd>
</dl>
</li>
</ul>
<a id="configureShiroWeb()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureShiroWeb</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.228">configureShiroWeb</a>()</pre>
</li>
</ul>
<a id="bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindSecurityManager</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.230">bindSecurityManager</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.mgt.SecurityManager&gt;&nbsp;bind)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../ShiroModule.html#bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">ShiroModule</a></code></span></div>
<div class="block">Binds the security manager. Override this method in order to provide your own security manager binding.
<p/>
By default, a <code>DefaultSecurityManager</code> is bound as an eager singleton.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../ShiroModule.html#bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSecurityManager</a></code>&nbsp;in class&nbsp;<code><a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></code></dd>
</dl>
</li>
</ul>
<a id="bindWebSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindWebSecurityManager</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.243">bindWebSecurityManager</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.mgt.WebSecurityManager&gt;&nbsp;bind)</pre>
<div class="block">Binds the security manager. Override this method in order to provide your own security manager binding.
<p/>
By default, a <code>DefaultWebSecurityManager</code> is bound as an eager singleton.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bind</code> - </dd>
</dl>
</li>
</ul>
<a id="bindShiroFilterConfiguration(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindShiroFilterConfiguration</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.258">bindShiroFilterConfiguration</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.config.ShiroFilterConfiguration&gt;&nbsp;bind)</pre>
<div class="block">Binds the Shiro Filter Configuration. Override this method in order to provide your own Shiro Filter Configuration binding.
<p/>
By default, a <code>ShiroFilterConfiguration</code> is bound as an eager singleton.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bind</code> - </dd>
</dl>
</li>
</ul>
<a id="bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindSessionManager</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.269">bindSessionManager</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;org.apache.shiro.session.mgt.SessionManager&gt;&nbsp;bind)</pre>
<div class="block">Binds the session manager. Override this method in order to provide your own session manager binding.
<p/>
By default, a <code>DefaultWebSessionManager</code> is bound as an eager singleton.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../ShiroModule.html#bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSessionManager</a></code>&nbsp;in class&nbsp;<code><a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bind</code> - </dd>
</dl>
</li>
</ul>
<a id="bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindEnvironment</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.274">bindEnvironment</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;org.apache.shiro.env.Environment&gt;&nbsp;bind)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../ShiroModule.html#bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">ShiroModule</a></code></span></div>
<div class="block">Binds the environment. Override this method in order to provide your own environment binding.
<p/>
By default, a <code>GuiceEnvironment</code> is bound as an eager singleton.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../ShiroModule.html#bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindEnvironment</a></code>&nbsp;in class&nbsp;<code><a href="../ShiroModule.html" title="class in org.apache.shiro.guice">ShiroModule</a></code></dd>
</dl>
</li>
</ul>
<a id="bindWebEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindWebEnvironment</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.279">bindWebEnvironment</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super org.apache.shiro.web.env.WebEnvironment&gt;&nbsp;bind)</pre>
</li>
</ul>
<a id="addFilterChain(java.lang.String,com.google.inject.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilterChain</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.283">addFilterChain</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;pattern,
com.google.inject.Key&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;key)</pre>
</li>
</ul>
<a id="addFilterChain(java.lang.String,org.apache.shiro.guice.web.ShiroWebModule.FilterConfig...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilterChain</h4>
<pre class="methodSignature">protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.302">addFilterChain</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;pattern,
<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;...&nbsp;filterConfigs)</pre>
<div class="block">Maps 'n' number of <code>filterConfig</code>s to a specific path pattern.<BR/>
For example, a path of '/my_private_resource/**' to 'filterConfig(AUTHC)' would require
any resource under the path '/my_private_resource' would be processed through the <code>FormAuthenticationFilter</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - URL patter to be mapped to a FilterConfig, e.g. '/my_private-path/**'</dd>
<dd><code>filterConfigs</code> - FilterConfiguration representing the Filter and config to be used when processing resources on <code>pattern</code>.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="filterConfig(com.google.inject.Key,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterConfig</h4>
<pre class="methodSignature">protected static&nbsp;&lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.313">filterConfig</a>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey,
<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;configValue)</pre>
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - A Servlet Filter class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseKey</code> - The Key of the Filter class to be used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A FilterConfig used to map a String path to this configuration.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="filterConfig(com.google.inject.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterConfig</h4>
<pre class="methodSignature">protected static&nbsp;&lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.324">filterConfig</a>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey)</pre>
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - A Servlet Filter class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>baseKey</code> - The Key of the Filter class to be used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A FilterConfig used to map a String path to this configuration.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="filterConfig(com.google.inject.TypeLiteral,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterConfig</h4>
<pre class="methodSignature">protected static&nbsp;&lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.336">filterConfig</a>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
<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;configValue)</pre>
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - A Servlet Filter class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeLiteral</code> - The TyleLiteral of the filter key to be used.</dd>
<dd><code>configValue</code> - the configuration used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A FilterConfig used to map a String path to this configuration.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="filterConfig(java.lang.Class,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filterConfig</h4>
<pre class="methodSignature">protected static&nbsp;&lt;T extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;&nbsp;<a href="ShiroWebModule.FilterConfig.html" title="class in org.apache.shiro.guice.web">ShiroWebModule.FilterConfig</a>&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.349">filterConfig</a>&#8203;(<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;T&gt;&nbsp;type,
<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;configValue)</pre>
<div class="block">Builds a FilterConfig from a Filer and configuration String</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - A Servlet Filter class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The filter to be used.</dd>
<dd><code>configValue</code> - the configuration used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A FilterConfig used to map a String path to this configuration.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="addFilterChain(java.lang.String,com.google.inject.Key...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilterChain</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
protected final&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.412">addFilterChain</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;pattern,
com.google.inject.Key&lt;? extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">Filter</a>&gt;...&nbsp;keys)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Adds a filter chain to the shiro configuration.
<p/>
NOTE: If the provided key is for a subclass of <code>PathMatchingFilter</code>, it will be registered with a proper
provider.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pattern</code> - </dd>
<dd><code>keys</code> - </dd>
</dl>
</li>
</ul>
<a id="config(com.google.inject.Key,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>config</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
protected static&nbsp;&lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;&nbsp;com.google.inject.Key&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.436">config</a>&#8203;(com.google.inject.Key&lt;T&gt;&nbsp;baseKey,
<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;configValue)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="config(com.google.inject.TypeLiteral,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>config</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
protected static&nbsp;&lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;&nbsp;com.google.inject.Key&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.446">config</a>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
<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;configValue)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="config(java.lang.Class,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>config</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
protected static&nbsp;&lt;T extends org.apache.shiro.web.filter.PathMatchingFilter&gt;&nbsp;com.google.inject.Key&lt;T&gt;&nbsp;<a href="../../../../../src-html/org/apache/shiro/guice/web/ShiroWebModule.html#line.452">config</a>&#8203;(<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;T&gt;&nbsp;type,
<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;configValue)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</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/ShiroWebModule.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><a href="#nested.class.summary">Nested</a>&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;2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>