| <!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 Sat Feb 22 18:53:56 CET 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.shiro.web.servlet (Apache Shiro :: Web 1.5.1 API)</title> |
| <meta name="date" content="2020-02-22"> |
| <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="org.apache.shiro.web.servlet (Apache Shiro :: Web 1.5.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/mgt/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/shiro/web/session/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/servlet/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.shiro.web.servlet</h1> |
| <div class="docSummary"> |
| <div class="block">Shiro-specific implementations of the Servlet API (Servlet Filters, et al).</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet">Cookie</a></td> |
| <td class="colLast"> |
| <div class="block">Interface representing HTTP cookie operations, supporting pojo-style getters and setters for all |
| attributes which includes <a href="http://www.owasp.org/index.php/HttpOnly">HttpOnly</a> support.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html" title="class in org.apache.shiro.web.servlet">AbstractFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Base abstract Filter simplifying Filter initialization and <a href="../../../../../org/apache/shiro/web/servlet/AbstractFilter.html#getInitParam-java.lang.String-"><code>access</code></a> to init parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/AbstractShiroFilter.html" title="class in org.apache.shiro.web.servlet">AbstractShiroFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract base class that provides all standard Shiro request filtering behavior and expects |
| subclasses to implement configuration-specific logic (INI, XML, .properties, etc).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/AdviceFilter.html" title="class in org.apache.shiro.web.servlet">AdviceFilter</a></td> |
| <td class="colLast"> |
| <div class="block">A Servlet Filter that enables AOP-style "around" advice for a ServletRequest via |
| <a href="../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#preHandle-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>preHandle</code></a>, |
| <a href="../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#postHandle-javax.servlet.ServletRequest-javax.servlet.ServletResponse-"><code>postHandle</code></a>, |
| and <a href="../../../../../org/apache/shiro/web/servlet/AdviceFilter.html#afterCompletion-javax.servlet.ServletRequest-javax.servlet.ServletResponse-java.lang.Exception-"><code>afterCompletion</code></a> |
| hooks.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/IniShiroFilter.html" title="class in org.apache.shiro.web.servlet">IniShiroFilter</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">in 1.2 in favor of using the <a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet"><code>ShiroFilter</code></a></span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html" title="class in org.apache.shiro.web.servlet">NameableFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Allows a filter to be named via JavaBeans-compatible |
| <a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html#getName--"><code>NameableFilter.getName()</code></a>/<a href="../../../../../org/apache/shiro/web/servlet/NameableFilter.html#setName-java.lang.String-"><code>NameableFilter.setName(String)</code></a> methods.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/OncePerRequestFilter.html" title="class in org.apache.shiro.web.servlet">OncePerRequestFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Filter base class that guarantees to be just executed once per request, |
| on any servlet container.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ProxiedFilterChain.html" title="class in org.apache.shiro.web.servlet">ProxiedFilterChain</a></td> |
| <td class="colLast"> |
| <div class="block">A proxied filter chain is a <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet"><code>FilterChain</code></a> instance that proxies an original <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/FilterChain.html?is-external=true" title="class or interface in javax.servlet"><code>FilterChain</code></a> as well |
| as a <a href="https://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of other <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/Filter.html?is-external=true" title="class or interface in javax.servlet"><code>Filter</code></a>s that might need to execute prior to the final wrapped |
| original chain.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ServletContextSupport.html" title="class in org.apache.shiro.web.servlet">ServletContextSupport</a></td> |
| <td class="colLast"> |
| <div class="block">Base implementation for any components that need to access the web application's <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet"><code>ServletContext</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ShiroFilter.html" title="class in org.apache.shiro.web.servlet">ShiroFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Primary Shiro Filter for web applications configuring Shiro via Servlet <listener> in web.xml.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ShiroHttpServletRequest</code> wraps the Servlet container's original <code>ServletRequest</code> instance, but ensures |
| that all <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http"><code>HttpServletRequest</code></a> invocations that require Shiro's support (<a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#getRemoteUser--"><code>getRemoteUser</code></a>, |
| <a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletRequest.html#getSession-boolean-"><code>getSession</code></a>, etc) can be executed first by Shiro as necessary before allowing the underlying |
| Servlet container instance's method to be invoked.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpServletResponse.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletResponse</a></td> |
| <td class="colLast"> |
| <div class="block">HttpServletResponse implementation to support URL Encoding of Shiro Session IDs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/ShiroHttpSession.html" title="class in org.apache.shiro.web.servlet">ShiroHttpSession</a></td> |
| <td class="colLast"> |
| <div class="block">Wrapper class that uses a Shiro <code>Session</code> under the hood for all session operations instead of the |
| Servlet Container's session mechanism.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/SimpleCookie.html" title="class in org.apache.shiro.web.servlet">SimpleCookie</a></td> |
| <td class="colLast"> |
| <div class="block">Default <a href="../../../../../org/apache/shiro/web/servlet/Cookie.html" title="interface in org.apache.shiro.web.servlet"><code>Cookie</code></a> implementation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/shiro/web/servlet/Cookie.SameSiteOptions.html" title="enum in org.apache.shiro.web.servlet">Cookie.SameSiteOptions</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.shiro.web.servlet Description">Package org.apache.shiro.web.servlet Description</h2> |
| <div class="block">Shiro-specific implementations of the Servlet API (Servlet Filters, et al).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ShiroFilter</code></dd> |
| </dl> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/mgt/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/shiro/web/session/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/web/servlet/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
