| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MPJWTFilter</title> |
| <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="MPJWTFilter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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="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/tomee/microprofile/jwt/JWTLogCategories.html" title="class in org.apache.tomee.microprofile.jwt"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.MPJWTExceptionMapper.html" title="class in org.apache.tomee.microprofile.jwt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/tomee/microprofile/jwt/MPJWTFilter.html" target="_top">Frames</a></li> |
| <li><a href="MPJWTFilter.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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.tomee.microprofile.jwt</div> |
| <h2 title="Class MPJWTFilter" class="title">Class MPJWTFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.tomee.microprofile.jwt.MPJWTFilter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../javax/servlet/Filter.html" title="interface in javax.servlet">Filter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MPJWTFilter</span> |
| extends java.lang.Object |
| implements <a href="../../../../../javax/servlet/Filter.html" title="interface in javax.servlet">Filter</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.MPJWTExceptionMapper.html" title="class in org.apache.tomee.microprofile.jwt">MPJWTFilter.MPJWTExceptionMapper</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.MPJWTServletRequestWrapper.html" title="class in org.apache.tomee.microprofile.jwt">MPJWTFilter.MPJWTServletRequestWrapper</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.ValidateJSonWebToken.html" title="class in org.apache.tomee.microprofile.jwt">MPJWTFilter.ValidateJSonWebToken</a></span></code> </td> |
| </tr> |
| </table> |
| </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/tomee/microprofile/jwt/MPJWTFilter.html#MPJWTFilter--">MPJWTFilter</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/tomee/microprofile/jwt/MPJWTFilter.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Called by the web container |
| to indicate to a filter that it is being |
| taken out of service.</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/tomee/microprofile/jwt/MPJWTFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter</a></span>(<a href="../../../../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request, |
| <a href="../../../../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response, |
| <a href="../../../../../javax/servlet/FilterChain.html" title="interface in javax.servlet">FilterChain</a> chain)</code> |
| <div class="block">The <code>doFilter</code> method of the Filter is called by the |
| container each time a request/response pair is passed through the |
| chain due to a client request for a resource at the end of the chain.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.html#init-javax.servlet.FilterConfig-">init</a></span>(<a href="../../../../../javax/servlet/FilterConfig.html" title="interface in javax.servlet">FilterConfig</a> filterConfig)</code> |
| <div class="block">Called by the web container |
| to indicate to a filter that it is being placed into service.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="MPJWTFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MPJWTFilter</h4> |
| <pre>public MPJWTFilter()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="init-javax.servlet.FilterConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void init(<a href="../../../../../javax/servlet/FilterConfig.html" title="interface in javax.servlet">FilterConfig</a> filterConfig) |
| throws <a href="../../../../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/servlet/Filter.html#init-javax.servlet.FilterConfig-">Filter</a></code></span></div> |
| <div class="block"><p>Called by the web container |
| to indicate to a filter that it is being placed into service.</p> |
| |
| <p>The servlet container calls the init |
| method exactly once after instantiating the filter. The init |
| method must complete successfully before the filter is asked to do any |
| filtering work.</p> |
| |
| <p>The web container cannot place the filter into service if the init |
| method either</p> |
| <ol> |
| <li>Throws a ServletException |
| <li>Does not return within a time period defined by the web container |
| </ol></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/servlet/Filter.html#init-javax.servlet.FilterConfig-">init</a></code> in interface <code><a href="../../../../../javax/servlet/Filter.html" title="interface in javax.servlet">Filter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filterConfig</code> - a <code>FilterConfig</code> object containing the |
| filter's configuration and initialization parameters</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code> - if an exception has occurred that interferes with |
| the filter's normal operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doFilter</h4> |
| <pre>public void doFilter(<a href="../../../../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request, |
| <a href="../../../../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response, |
| <a href="../../../../../javax/servlet/FilterChain.html" title="interface in javax.servlet">FilterChain</a> chain) |
| throws java.io.IOException, |
| <a href="../../../../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/servlet/Filter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">Filter</a></code></span></div> |
| <div class="block">The <code>doFilter</code> method of the Filter is called by the |
| container each time a request/response pair is passed through the |
| chain due to a client request for a resource at the end of the chain. |
| The FilterChain passed in to this method allows the Filter to pass |
| on the request and response to the next entity in the chain. |
| |
| <p>A typical implementation of this method would follow the following |
| pattern: |
| <ol> |
| <li>Examine the request |
| <li>Optionally wrap the request object with a custom implementation to |
| filter content or headers for input filtering |
| <li>Optionally wrap the response object with a custom implementation to |
| filter content or headers for output filtering |
| <li> |
| <ul> |
| <li><strong>Either</strong> invoke the next entity in the chain |
| using the FilterChain object |
| (<code>chain.doFilter()</code>), |
| <li><strong>or</strong> not pass on the request/response pair to |
| the next entity in the filter chain to |
| block the request processing |
| </ul> |
| <li>Directly set headers on the response after invocation of the |
| next entity in the filter chain. |
| </ol></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/servlet/Filter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter</a></code> in interface <code><a href="../../../../../javax/servlet/Filter.html" title="interface in javax.servlet">Filter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - the <code>ServletRequest</code> object contains the client's request</dd> |
| <dd><code>response</code> - the <code>ServletResponse</code> object contains the filter's response</dd> |
| <dd><code>chain</code> - the <code>FilterChain</code> for invoking the next filter or the resource</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if an I/O related error has occurred during the processing</dd> |
| <dd><code><a href="../../../../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></code> - if an exception occurs that interferes with the |
| filter's normal operation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../javax/servlet/UnavailableException.html" title="class in javax.servlet"><code>UnavailableException</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>public void destroy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../javax/servlet/Filter.html#destroy--">Filter</a></code></span></div> |
| <div class="block"><p>Called by the web container |
| to indicate to a filter that it is being |
| taken out of service.</p> |
| |
| <p>This method is only called once all threads within the filter's |
| doFilter method have exited or after a timeout period has passed. |
| After the web container calls this method, it will not call the |
| doFilter method again on this instance of the filter.</p> |
| |
| <p>This method gives the filter an opportunity to clean up any |
| resources that are being held (for example, memory, file handles, |
| threads) and make sure that any persistent state is synchronized |
| with the filter's current state in memory.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../javax/servlet/Filter.html#destroy--">destroy</a></code> in interface <code><a href="../../../../../javax/servlet/Filter.html" title="interface in javax.servlet">Filter</a></code></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="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/tomee/microprofile/jwt/JWTLogCategories.html" title="class in org.apache.tomee.microprofile.jwt"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/tomee/microprofile/jwt/MPJWTFilter.MPJWTExceptionMapper.html" title="class in org.apache.tomee.microprofile.jwt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/tomee/microprofile/jwt/MPJWTFilter.html" target="_top">Frames</a></li> |
| <li><a href="MPJWTFilter.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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 ======= --> |
| </body> |
| </html> |