| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="fr"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_201) on Wed May 01 07:16:45 RET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>EnvironmentLoaderListener (Apache Shiro 1.4.1 API)</title> |
| <meta name="date" content="2019-05-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="EnvironmentLoaderListener (Apache Shiro 1.4.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/EnvironmentLoaderListener.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><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/env/IniWebEnvironment.html" title="class in org.apache.shiro.web.env"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/env/EnvironmentLoaderListener.html" target="_top">Frames</a></li> |
| <li><a href="EnvironmentLoaderListener.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.shiro.web.env.EnvironmentLoader">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.web.env</div> |
| <h2 title="Class EnvironmentLoaderListener" class="title">Class EnvironmentLoaderListener</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.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><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env">org.apache.shiro.web.env.EnvironmentLoader</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.shiro.web.env.EnvironmentLoaderListener</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a>, javax.servlet.ServletContextListener</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/shiro/web/env/EnvironmentLoaderListener.html#line.49">EnvironmentLoaderListener</a> |
| extends <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env">EnvironmentLoader</a> |
| implements javax.servlet.ServletContextListener</pre> |
| <div class="block">Bootstrap listener to startup and shutdown the web application's Shiro |
| <a href="../../../../../org/apache/shiro/web/env/WebEnvironment.html" title="interface in org.apache.shiro.web.env"><code>WebEnvironment</code></a> at ServletContext startup and shutdown respectively. This class exists only to |
| implement the <code>ServletContextListener</code> interface. All 'real' logic is done in the parent |
| <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env"><code>EnvironmentLoader</code></a> class. |
| <h2>Usage</h2> |
| Define the following in <code>web.xml</code>: |
| <pre> |
| <listener> |
| <listener-class><code>org.apache.shiro.web.env.EnvironmentLoaderListener</code></listener-class> |
| </listener> |
| </pre> |
| Configuration options, such as the <code>WebEnvironment</code> class to instantiate as well as Shiro configuration |
| resource locations are specified as <code>ServletContext</code> <code>context-param</code>s and are documented in the |
| <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env"><code>EnvironmentLoader</code></a> JavaDoc. |
| <h2>Shiro Filter</h2> |
| This listener is almost always defined in conjunction with the |
| <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a> to ensure security operations for web requests. Please |
| see the <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a> JavaDoc for more.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env"><code>EnvironmentLoader</code></a>, |
| <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.shiro.web.env.EnvironmentLoader"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.shiro.web.env.<a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env">EnvironmentLoader</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#CONFIG_LOCATIONS_PARAM">CONFIG_LOCATIONS_PARAM</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#ENVIRONMENT_ATTRIBUTE_KEY">ENVIRONMENT_ATTRIBUTE_KEY</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#ENVIRONMENT_CLASS_PARAM">ENVIRONMENT_CLASS_PARAM</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoaderListener.html#EnvironmentLoaderListener--">EnvironmentLoaderListener</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoaderListener.html#contextDestroyed-javax.servlet.ServletContextEvent-">contextDestroyed</a></span>(javax.servlet.ServletContextEvent sce)</code> |
| <div class="block">Destroys any previously created/bound <code>WebEnvironment</code> instance created by |
| the <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoaderListener.html#contextInitialized-javax.servlet.ServletContextEvent-"><code>contextInitialized(javax.servlet.ServletContextEvent)</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoaderListener.html#contextInitialized-javax.servlet.ServletContextEvent-">contextInitialized</a></span>(javax.servlet.ServletContextEvent sce)</code> |
| <div class="block">Initializes the Shiro <code>WebEnvironment</code> and binds it to the <code>ServletContext</code> at application |
| startup for future reference.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.shiro.web.env.EnvironmentLoader"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.shiro.web.env.<a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env">EnvironmentLoader</a></h3> |
| <code><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#createEnvironment-javax.servlet.ServletContext-">createEnvironment</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#customizeEnvironment-org.apache.shiro.web.env.WebEnvironment-">customizeEnvironment</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#destroyEnvironment-javax.servlet.ServletContext-">destroyEnvironment</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#determineWebEnvironment-javax.servlet.ServletContext-">determineWebEnvironment</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#determineWebEnvironmentClass-javax.servlet.ServletContext-">determineWebEnvironmentClass</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#finalizeEnvironment-org.apache.shiro.web.env.WebEnvironment-">finalizeEnvironment</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#getDefaultWebEnvironmentClass--">getDefaultWebEnvironmentClass</a>, <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html#initEnvironment-javax.servlet.ServletContext-">initEnvironment</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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://docs.oracle.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="EnvironmentLoaderListener--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EnvironmentLoaderListener</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/web/env/EnvironmentLoaderListener.html#line.49">EnvironmentLoaderListener</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="contextInitialized-javax.servlet.ServletContextEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contextInitialized</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/env/EnvironmentLoaderListener.html#line.57">contextInitialized</a>(javax.servlet.ServletContextEvent sce)</pre> |
| <div class="block">Initializes the Shiro <code>WebEnvironment</code> and binds it to the <code>ServletContext</code> at application |
| startup for future reference.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>contextInitialized</code> in interface <code>javax.servlet.ServletContextListener</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sce</code> - the ServletContextEvent triggered upon application startup</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="contextDestroyed-javax.servlet.ServletContextEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>contextDestroyed</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/shiro/web/env/EnvironmentLoaderListener.html#line.67">contextDestroyed</a>(javax.servlet.ServletContextEvent sce)</pre> |
| <div class="block">Destroys any previously created/bound <code>WebEnvironment</code> instance created by |
| the <a href="../../../../../org/apache/shiro/web/env/EnvironmentLoaderListener.html#contextInitialized-javax.servlet.ServletContextEvent-"><code>contextInitialized(javax.servlet.ServletContextEvent)</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>contextDestroyed</code> in interface <code>javax.servlet.ServletContextListener</code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sce</code> - the ServletContextEvent triggered upon application shutdown</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/EnvironmentLoaderListener.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><a href="../../../../../org/apache/shiro/web/env/EnvironmentLoader.html" title="class in org.apache.shiro.web.env"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/web/env/IniWebEnvironment.html" title="class in org.apache.shiro.web.env"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/env/EnvironmentLoaderListener.html" target="_top">Frames</a></li> |
| <li><a href="EnvironmentLoaderListener.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.shiro.web.env.EnvironmentLoader">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2004–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
