Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.1 / apidocs / org / apache / shiro / guice / ShiroModule.html
blob: 1527d6916e3da8bb4e5f805f2a688a197a510c9d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_21) on Thu May 30 14:51:28 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ShiroModule (Apache Shiro 1.2.1 API)</title>
<meta name="date" content="2013-05-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ShiroModule (Apache Shiro 1.2.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li>Prev Class</li>
<li><a href="../../../../org/apache/shiro/guice/ShiroSessionScope.html" title="class in org.apache.shiro.guice"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/guice/ShiroModule.html" target="_top">Frames</a></li>
<li><a href="ShiroModule.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></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>
</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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.shiro.guice</div>
<h2 title="Class ShiroModule" class="title">Class ShiroModule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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>com.google.inject.Module, <a href="../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/shiro/guice/web/ShiroWebModule.html" title="class in org.apache.shiro.guice.web">ShiroWebModule</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.49">ShiroModule</a>
extends com.google.inject.PrivateModule
implements <a href="../../../../org/apache/shiro/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="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt"><code>SecurityManager</code></a> and <a href="../../../../org/apache/shiro/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="../../../../org/apache/shiro/guice/ShiroModule.html#bindRealm()"><code>bindRealm</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#ShiroModule()">ShiroModule</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#add(org.apache.shiro.util.Destroyable)">add</a></strong>(<a href="../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a>&nbsp;destroyable)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected &lt;T&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#bindBeanType(com.google.inject.TypeLiteral, com.google.inject.Key)">bindBeanType</a></strong>(com.google.inject.TypeLiteral&lt;T&gt;&nbsp;typeLiteral,
com.google.inject.Key&lt;? extends T&gt;&nbsp;key)</code>
<div class="block">Binds a key to use for injecting setters in shiro classes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">bindEnvironment</a></strong>(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../../../../org/apache/shiro/env/Environment.html" title="interface in org.apache.shiro.env">Environment</a>&gt;&nbsp;bind)</code>
<div class="block">Binds the environment.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected com.google.inject.binder.LinkedBindingBuilder&lt;<a href="../../../../org/apache/shiro/realm/Realm.html" title="interface in org.apache.shiro.realm">Realm</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#bindRealm()">bindRealm</a></strong>()</code>
<div class="block">This is the preferred manner to bind a realm.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSecurityManager</a></strong>(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super <a href="../../../../org/apache/shiro/mgt/SecurityManager.html" title="interface in org.apache.shiro.mgt">SecurityManager</a>&gt;&nbsp;bind)</code>
<div class="block">Binds the security manager.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">bindSessionManager</a></strong>(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../../../../org/apache/shiro/session/mgt/SessionManager.html" title="interface in org.apache.shiro.session.mgt">SessionManager</a>&gt;&nbsp;bind)</code>
<div class="block">Binds the session manager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#configure()">configure</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#configureShiro()">configureShiro</a></strong>()</code>
<div class="block">Implement this method in order to configure your realms and any other Shiro customization you may need.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/guice/ShiroModule.html#destroy()">destroy</a></strong>()</code>
<div class="block">Destroys all beans created within this module that implement <a href="../../../../org/apache/shiro/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 name="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, 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 name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ShiroModule()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ShiroModule</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.49">ShiroModule</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="configure()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.53">configure</a>()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>configure</code>&nbsp;in class&nbsp;<code>com.google.inject.PrivateModule</code></dd>
</dl>
</li>
</ul>
<a name="configureShiro()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureShiro</h4>
<pre>protected abstract&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.94">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 name="bindRealm()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindRealm</h4>
<pre>protected final&nbsp;com.google.inject.binder.LinkedBindingBuilder&lt;<a href="../../../../org/apache/shiro/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.102">bindRealm</a>()</pre>
<div class="block">This is the preferred manner to bind a realm. The <a href="../../../../org/apache/shiro/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="strong">Returns:</span></dt><dd>a binding builder for a realm</dd></dl>
</li>
</ul>
<a name="bindSecurityManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindSecurityManager</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.114">bindSecurityManager</a>(com.google.inject.binder.AnnotatedBindingBuilder&lt;? super <a href="../../../../org/apache/shiro/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="../../../../org/apache/shiro/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="strong">Parameters:</span></dt><dd><code>bind</code> - </dd></dl>
</li>
</ul>
<a name="bindSessionManager(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindSessionManager</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.129">bindSessionManager</a>(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../../../../org/apache/shiro/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="../../../../org/apache/shiro/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="strong">Parameters:</span></dt><dd><code>bind</code> - </dd></dl>
</li>
</ul>
<a name="bindEnvironment(com.google.inject.binder.AnnotatedBindingBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindEnvironment</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.140">bindEnvironment</a>(com.google.inject.binder.AnnotatedBindingBuilder&lt;<a href="../../../../org/apache/shiro/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="strong">Parameters:</span></dt><dd><code>bind</code> - </dd></dl>
</li>
</ul>
<a name="bindBeanType(com.google.inject.TypeLiteral, com.google.inject.Key)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindBeanType</h4>
<pre>protected final&nbsp;&lt;T&gt;&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.150">bindBeanType</a>(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="strong">Type Parameters:</span></dt><dd><code>T</code> - </dd><dt><span class="strong">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 name="destroy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public final&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.160">destroy</a>()
throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Destroys all beans created within this module that implement <a href="../../../../org/apache/shiro/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><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/shiro/util/Destroyable.html#destroy()">destroy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="add(org.apache.shiro.util.Destroyable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>add</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/guice/ShiroModule.html#line.166">add</a>(<a href="../../../../org/apache/shiro/util/Destroyable.html" title="interface in org.apache.shiro.util">Destroyable</a>&nbsp;destroyable)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<li>Prev Class</li>
<li><a href="../../../../org/apache/shiro/guice/ShiroSessionScope.html" title="class in org.apache.shiro.guice"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/guice/ShiroModule.html" target="_top">Frames</a></li>
<li><a href="ShiroModule.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>
</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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>