Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.9.1 / apidocs / org / apache / shiro / guice / ShiroModule.html
blob: 0d7614916a74dff83636adfa95ba19f0b1b243e3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ShiroModule (Apache Shiro 1.9.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ShiroModule (Apache Shiro 1.9.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":6,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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"><!-- 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/ShiroModule.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>Field&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>Field&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</a></div>
<h2 title="Class ShiroModule" class="title">Class ShiroModule</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>org.apache.shiro.guice.ShiroModule</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><a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../../../QuickstartShiroModule.html" title="class in &lt;Unnamed&gt;">QuickstartShiroModule</a></code>, <code><a href="web/ShiroWebModule.html" title="class in org.apache.shiro.guice.web">ShiroWebModule</a></code></dd>
</dl>
<hr>
<pre>public abstract class <a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.65">ShiroModule</a>
extends com.google.inject.PrivateModule
implements <a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></pre>
<div class="block">Sets up Shiro lifecycles within Guice, enables the injecting of Shiro objects, and binds a default
<a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and <a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt"><code>SessionManager</code></a>. At least one realm must be added by using
<a href="#bindRealm()"><code>bindRealm</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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()">ShiroModule</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="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></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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(org.apache.shiro.util.Destroyable)">add</a></span>&#8203;(<a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a>&nbsp;destroyable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected &lt;T&gt;&nbsp;void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindBeanType(com.google.inject.TypeLiteral,com.google.inject.Key)">bindBeanType</a></span>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
com.google.inject.Key&lt;? extends T&gt;&nbsp;key)</code></th>
<td class="colLast">
<div class="block">Binds a key to use for injecting setters in shiro classes.</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="#bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindEnvironment</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../env/Environment.html" title="interface in org.apache.shiro.env">Environment</a>&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the environment.</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="#bindEventBus(com.google.inject.binder.AnnotatedBindingBuilder)">bindEventBus</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../event/EventBus.html" title="interface in org.apache.shiro.event">EventBus</a>&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the EventBus.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected com.google.inject.binder.LinkedBindingBuilder&lt;<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindRealm()">bindRealm</a></span>()</code></th>
<td class="colLast">
<div class="block">This is the preferred manner to bind a realm.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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 <a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the security manager.</div>
</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="#bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSessionManager</a></span>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&gt;&nbsp;bind)</code></th>
<td class="colLast">
<div class="block">Binds the session manager.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>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="i8" class="altColor">
<td class="colFirst"><code>protected abstract 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="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#destroy()">destroy</a></span>()</code></th>
<td class="colLast">
<div class="block">Destroys all beans created within this module that implement <a href="../util/Destroyable.html" title="interface in org.apache.shiro.util"><code>Destroyable</code></a>.</div>
</td>
</tr>
</table>
<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">
<!-- ========= 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>ShiroModule</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.65">ShiroModule</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="configure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.70">configure</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>configure</code>&nbsp;in class&nbsp;<code>com.google.inject.PrivateModule</code></dd>
</dl>
</li>
</ul>
<a id="configureShiro()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureShiro</h4>
<pre class="methodSignature">protected abstract&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.115">configureShiro</a>()</pre>
<div class="block">Implement this method in order to configure your realms and any other Shiro customization you may need.</div>
</li>
</ul>
<a id="bindRealm()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindRealm</h4>
<pre class="methodSignature">protected final&nbsp;com.google.inject.binder.LinkedBindingBuilder&lt;<a href="../realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.123">bindRealm</a>()</pre>
<div class="block">This is the preferred manner to bind a realm. The <a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> will be injected with any Realm bound
with this method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a binding builder for a realm</dd>
</dl>
</li>
</ul>
<a id="bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindSecurityManager</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.135">bindSecurityManager</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super <a href="../mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&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 <a href="../mgt/DefaultSecurityManager.html" title="class in org.apache.shiro.mgt"><code>DefaultSecurityManager</code></a> 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/ShiroModule.html#line.150">bindSessionManager</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&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 <a href="../session/mgt/DefaultSessionManager.html" title="class in org.apache.shiro.session.mgt"><code>DefaultSessionManager</code></a> 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="bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindEnvironment</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.161">bindEnvironment</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../env/Environment.html" title="interface in org.apache.shiro.env">Environment</a>&gt;&nbsp;bind)</pre>
<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="paramLabel">Parameters:</span></dt>
<dd><code>bind</code> - </dd>
</dl>
</li>
</ul>
<a id="bindBeanType(com.google.inject.TypeLiteral,com.google.inject.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindBeanType</h4>
<pre class="methodSignature">protected final&nbsp;&lt;T&gt;&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.171">bindBeanType</a>&#8203;(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
com.google.inject.Key&lt;? extends T&gt;&nbsp;key)</pre>
<div class="block">Binds a key to use for injecting setters in shiro classes.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - </dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeLiteral</code> - the bean property type</dd>
<dd><code>key</code> - the key to use to satisfy the bean property dependency</dd>
</dl>
</li>
</ul>
<a id="bindEventBus(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindEventBus</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.180">bindEventBus</a>&#8203;(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../event/EventBus.html" title="interface in org.apache.shiro.event">EventBus</a>&gt;&nbsp;bind)</pre>
<div class="block">Binds the EventBus. Override this method in order to provide your own <a href="../event/EventBus.html" title="interface in org.apache.shiro.event"><code>EventBus</code></a> binding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bind</code> - </dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.4</dd>
</dl>
</li>
</ul>
<a id="destroy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.190">destroy</a>()</pre>
<div class="block">Destroys all beans created within this module that implement <a href="../util/Destroyable.html" title="interface in org.apache.shiro.util"><code>Destroyable</code></a>. Should be called when this
module will no longer be used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../util/Destroyable.html#destroy()">destroy</a></code>&nbsp;in interface&nbsp;<code><a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="add(org.apache.shiro.util.Destroyable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.201">add</a>&#8203;(<a href="../util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a>&nbsp;destroyable)</pre>
</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/ShiroModule.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>Field&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>Field&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;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>