| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>FilterRegistration</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="FilterRegistration"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../jakarta/servlet/FilterConfig.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/FilterRegistration.Dynamic.html" title="interface in jakarta.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/servlet/FilterRegistration.html" target="_top">Frames</a></li> |
| <li><a href="FilterRegistration.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">jakarta.servlet</div> |
| <h2 title="Interface FilterRegistration" class="title">Interface FilterRegistration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../jakarta/servlet/Registration.html" title="interface in jakarta.servlet">Registration</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../jakarta/servlet/FilterRegistration.Dynamic.html" title="interface in jakarta.servlet">FilterRegistration.Dynamic</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FilterRegistration</span> |
| extends <a href="../../jakarta/servlet/Registration.html" title="interface in jakarta.servlet">Registration</a></pre> |
| <div class="block">Interface through which a <a href="../../jakarta/servlet/Filter.html" title="interface in jakarta.servlet"><code>Filter</code></a> may be further configured.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Servlet 3.0</dd> |
| </dl> |
| </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">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/FilterRegistration.Dynamic.html" title="interface in jakarta.servlet">FilterRegistration.Dynamic</a></span></code> |
| <div class="block">Interface through which a <a href="../../jakarta/servlet/Filter.html" title="interface in jakarta.servlet"><code>Filter</code></a> registered via one of the <tt>addFilter</tt> methods on |
| <a href="../../jakarta/servlet/ServletContext.html" title="interface in jakarta.servlet"><code>ServletContext</code></a> may be further configured.</div> |
| </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../jakarta/servlet/FilterRegistration.html#addMappingForServletNames-java.util.EnumSet-boolean-java.lang.String...-">addMappingForServletNames</a></span>(java.util.EnumSet<<a href="../../jakarta/servlet/DispatcherType.html" title="enum in jakarta.servlet">DispatcherType</a>> dispatcherTypes, |
| boolean isMatchAfter, |
| java.lang.String... servletNames)</code> |
| <div class="block">Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this |
| FilterRegistration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/FilterRegistration.html#addMappingForUrlPatterns-java.util.EnumSet-boolean-java.lang.String...-">addMappingForUrlPatterns</a></span>(java.util.EnumSet<<a href="../../jakarta/servlet/DispatcherType.html" title="enum in jakarta.servlet">DispatcherType</a>> dispatcherTypes, |
| boolean isMatchAfter, |
| java.lang.String... urlPatterns)</code> |
| <div class="block">Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this |
| FilterRegistration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/FilterRegistration.html#getServletNameMappings--">getServletNameMappings</a></span>()</code> |
| <div class="block">Gets the currently available servlet name mappings of the Filter represented by this <code>FilterRegistration</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Collection<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/FilterRegistration.html#getUrlPatternMappings--">getUrlPatternMappings</a></span>()</code> |
| <div class="block">Gets the currently available URL pattern mappings of the Filter represented by this <code>FilterRegistration</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.servlet.Registration"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.servlet.<a href="../../jakarta/servlet/Registration.html" title="interface in jakarta.servlet">Registration</a></h3> |
| <code><a href="../../jakarta/servlet/Registration.html#getClassName--">getClassName</a>, <a href="../../jakarta/servlet/Registration.html#getInitParameter-java.lang.String-">getInitParameter</a>, <a href="../../jakarta/servlet/Registration.html#getInitParameters--">getInitParameters</a>, <a href="../../jakarta/servlet/Registration.html#getName--">getName</a>, <a href="../../jakarta/servlet/Registration.html#setInitParameter-java.lang.String-java.lang.String-">setInitParameter</a>, <a href="../../jakarta/servlet/Registration.html#setInitParameters-java.util.Map-">setInitParameters</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addMappingForServletNames-java.util.EnumSet-boolean-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMappingForServletNames</h4> |
| <pre>void addMappingForServletNames(java.util.EnumSet<<a href="../../jakarta/servlet/DispatcherType.html" title="enum in jakarta.servlet">DispatcherType</a>> dispatcherTypes, |
| boolean isMatchAfter, |
| java.lang.String... servletNames)</pre> |
| <div class="block">Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this |
| FilterRegistration. |
| |
| <p> |
| Filter mappings are matched in the order in which they were added. |
| |
| <p> |
| Depending on the value of the <tt>isMatchAfter</tt> parameter, the given filter mapping will be considered after or |
| before any <i>declared</i> filter mappings of the ServletContext from which this FilterRegistration was obtained. |
| |
| <p> |
| If this method is called multiple times, each successive call adds to the effects of the former.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatcherTypes</code> - the dispatcher types of the filter mapping, or null if the default |
| <tt>DispatcherType.REQUEST</tt> is to be used</dd> |
| <dd><code>isMatchAfter</code> - true if the given filter mapping should be matched after any declared filter mappings, and false |
| if it is supposed to be matched before any declared filter mappings of the ServletContext from which this |
| FilterRegistration was obtained</dd> |
| <dd><code>servletNames</code> - the servlet names of the filter mapping</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <tt>servletNames</tt> is null or empty</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the ServletContext from which this FilterRegistration was obtained has already been |
| initialized</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getServletNameMappings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletNameMappings</h4> |
| <pre>java.util.Collection<java.lang.String> getServletNameMappings()</pre> |
| <div class="block">Gets the currently available servlet name mappings of the Filter represented by this <code>FilterRegistration</code>. |
| |
| <p> |
| If permitted, any changes to the returned <code>Collection</code> must not affect this |
| <code>FilterRegistration</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a (possibly empty) <code>Collection</code> of the currently available servlet name mappings of the Filter |
| represented by this <code>FilterRegistration</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMappingForUrlPatterns-java.util.EnumSet-boolean-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMappingForUrlPatterns</h4> |
| <pre>void addMappingForUrlPatterns(java.util.EnumSet<<a href="../../jakarta/servlet/DispatcherType.html" title="enum in jakarta.servlet">DispatcherType</a>> dispatcherTypes, |
| boolean isMatchAfter, |
| java.lang.String... urlPatterns)</pre> |
| <div class="block">Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this |
| FilterRegistration. |
| |
| <p> |
| Filter mappings are matched in the order in which they were added. |
| |
| <p> |
| Depending on the value of the <tt>isMatchAfter</tt> parameter, the given filter mapping will be considered after or |
| before any <i>declared</i> filter mappings of the ServletContext from which this FilterRegistration was obtained. |
| |
| <p> |
| If this method is called multiple times, each successive call adds to the effects of the former.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dispatcherTypes</code> - the dispatcher types of the filter mapping, or null if the default |
| <tt>DispatcherType.REQUEST</tt> is to be used</dd> |
| <dd><code>isMatchAfter</code> - true if the given filter mapping should be matched after any declared filter mappings, and false |
| if it is supposed to be matched before any declared filter mappings of the ServletContext from which this |
| FilterRegistration was obtained</dd> |
| <dd><code>urlPatterns</code> - the url patterns of the filter mapping</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if <tt>urlPatterns</tt> is null or empty</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the ServletContext from which this FilterRegistration was obtained has already been |
| initialized</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUrlPatternMappings--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getUrlPatternMappings</h4> |
| <pre>java.util.Collection<java.lang.String> getUrlPatternMappings()</pre> |
| <div class="block">Gets the currently available URL pattern mappings of the Filter represented by this <code>FilterRegistration</code>. |
| |
| <p> |
| If permitted, any changes to the returned <code>Collection</code> must not affect this |
| <code>FilterRegistration</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a (possibly empty) <code>Collection</code> of the currently available URL pattern mappings of the Filter |
| represented by this <code>FilterRegistration</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="../../jakarta/servlet/FilterConfig.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/FilterRegistration.Dynamic.html" title="interface in jakarta.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/servlet/FilterRegistration.html" target="_top">Frames</a></li> |
| <li><a href="FilterRegistration.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
