| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Registration</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="Registration"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/ReadListener.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/Registration.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/Registration.html" target="_top">Frames</a></li> |
| <li><a href="Registration.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 Registration" class="title">Interface Registration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../jakarta/servlet/FilterRegistration.html" title="interface in jakarta.servlet">FilterRegistration</a>, <a href="../../jakarta/servlet/FilterRegistration.Dynamic.html" title="interface in jakarta.servlet">FilterRegistration.Dynamic</a>, <a href="../../jakarta/servlet/Registration.Dynamic.html" title="interface in jakarta.servlet">Registration.Dynamic</a>, <a href="../../jakarta/servlet/ServletRegistration.html" title="interface in jakarta.servlet">ServletRegistration</a>, <a href="../../jakarta/servlet/ServletRegistration.Dynamic.html" title="interface in jakarta.servlet">ServletRegistration.Dynamic</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Registration</span></pre> |
| <div class="block">Interface through which a <a href="../../jakarta/servlet/Servlet.html" title="interface in jakarta.servlet"><code>Servlet</code></a> or <a href="../../jakarta/servlet/Filter.html" title="interface in jakarta.servlet"><code>Filter</code></a> may be further configured. |
| |
| <p> |
| A Registration object whose <a href="../../jakarta/servlet/Registration.html#getClassName--"><code>getClassName()</code></a> method returns null is considered <i>preliminary</i>. Servlets and |
| Filters whose implementation class is container implementation specific may be declared without any |
| <tt>servlet-class</tt> or <tt>filter-class</tt> elements, respectively, and will be represented as preliminary |
| Registration objects. Preliminary registrations must be completed by calling one of the <tt>addServlet</tt> or |
| <tt>addFilter</tt> methods on <a href="../../jakarta/servlet/ServletContext.html" title="interface in jakarta.servlet"><code>ServletContext</code></a>, and passing in the Servlet or Filter name (obtained via |
| <a href="../../jakarta/servlet/Registration.html#getName--"><code>getName()</code></a>) along with the supporting Servlet or Filter implementation class name, Class object, or instance, |
| respectively. In most cases, preliminary registrations will be completed by an appropriate, container-provided |
| <a href="../../jakarta/servlet/ServletContainerInitializer.html" title="interface in jakarta.servlet"><code>ServletContainerInitializer</code></a>.</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/Registration.Dynamic.html" title="interface in jakarta.servlet">Registration.Dynamic</a></span></code> |
| <div class="block">Interface through which a <a href="../../jakarta/servlet/Servlet.html" title="interface in jakarta.servlet"><code>Servlet</code></a> or <a href="../../jakarta/servlet/Filter.html" title="interface in jakarta.servlet"><code>Filter</code></a> registered via one of the <tt>addServlet</tt> or |
| <tt>addFilter</tt> methods, respectively, 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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#getClassName--">getClassName</a></span>()</code> |
| <div class="block">Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#getInitParameter-java.lang.String-">getInitParameter</a></span>(java.lang.String name)</code> |
| <div class="block">Gets the value of the initialization parameter with the given name that will be used to initialize the Servlet or |
| Filter represented by this Registration object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#getInitParameters--">getInitParameters</a></span>()</code> |
| <div class="block">Gets an immutable (and possibly empty) Map containing the currently available initialization parameters that will be |
| used to initialize the Servlet or Filter represented by this Registration object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#getName--">getName</a></span>()</code> |
| <div class="block">Gets the name of the Servlet or Filter that is represented by this Registration.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#setInitParameter-java.lang.String-java.lang.String-">setInitParameter</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this |
| Registration.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/servlet/Registration.html#setInitParameters-java.util.Map-">setInitParameters</a></span>(java.util.Map<java.lang.String,java.lang.String> initParameters)</code> |
| <div class="block">Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.</div> |
| </td> |
| </tr> |
| </table> |
| </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="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block">Gets the name of the Servlet or Filter that is represented by this Registration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the Servlet or Filter that is represented by this Registration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClassName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClassName</h4> |
| <pre>java.lang.String getClassName()</pre> |
| <div class="block">Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the fully qualified class name of the Servlet or Filter that is represented by this Registration, or null if |
| this Registration is preliminary</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitParameter-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitParameter</h4> |
| <pre>boolean setInitParameter(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this |
| Registration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the initialization parameter name</dd> |
| <dd><code>value</code> - the initialization parameter value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the update was successful, i.e., an initialization parameter with the given name did not already |
| exist for the Servlet or Filter represented by this Registration, and false otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if the ServletContext from which this Registration was obtained has already been |
| initialized</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given name or value is <tt>null</tt></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitParameter-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitParameter</h4> |
| <pre>java.lang.String getInitParameter(java.lang.String name)</pre> |
| <div class="block">Gets the value of the initialization parameter with the given name that will be used to initialize the Servlet or |
| Filter represented by this Registration object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the initialization parameter whose value is requested</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the initialization parameter with the given name, or <tt>null</tt> if no initialization |
| parameter with the given name exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitParameters-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitParameters</h4> |
| <pre>java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)</pre> |
| <div class="block">Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration. |
| |
| <p> |
| The given map of initialization parameters is processed <i>by-value</i>, i.e., for each initialization parameter |
| contained in the map, this method calls <a href="../../jakarta/servlet/Registration.html#setInitParameter-java.lang.String-java.lang.String-"><code>setInitParameter(String,String)</code></a>. If that method would return false |
| for any of the initialization parameters in the given map, no updates will be performed, and false will be returned. |
| Likewise, if the map contains an initialization parameter with a <tt>null</tt> name or value, no updates will be |
| performed, and an IllegalArgumentException will be thrown. |
| |
| <p> |
| The returned set is not backed by the <code>Registration</code> object, so changes in the returned set are not reflected |
| in the <code>Registration</code> object, and vice-versa. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initParameters</code> - the initialization parameters</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the (possibly empty) Set of initialization parameter names that are in conflict</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalStateException</code> - if the ServletContext from which this Registration was obtained has already been |
| initialized</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given map contains an initialization parameter with a <tt>null</tt> name or |
| value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitParameters--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInitParameters</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.String> getInitParameters()</pre> |
| <div class="block">Gets an immutable (and possibly empty) Map containing the currently available initialization parameters that will be |
| used to initialize the Servlet or Filter represented by this Registration object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Map containing the currently available initialization parameters that will be used to initialize the Servlet |
| or Filter represented by this Registration object</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/ReadListener.html" title="interface in jakarta.servlet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/servlet/Registration.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/Registration.html" target="_top">Frames</a></li> |
| <li><a href="Registration.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> |
