| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JspFactory</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JspFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":6,"i2":6,"i3":6,"i4":6,"i5":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../jakarta/servlet/jsp/JspException.html" title="class in jakarta.servlet.jsp"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/servlet/jsp/JspPage.html" title="interface in jakarta.servlet.jsp"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/servlet/jsp/JspFactory.html" target="_top">Frames</a></li> |
| <li><a href="JspFactory.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>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">jakarta.servlet.jsp</div> |
| <h2 title="Class JspFactory" class="title">Class JspFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.servlet.jsp.JspFactory</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">JspFactory</span> |
| extends java.lang.Object</pre> |
| <div class="block"><p> |
| The JspFactory is an abstract class that defines a number of factory methods available to a JSP page at runtime for |
| the purposes of creating instances of various interfaces and classes used to support the JSP implementation. |
| <p> |
| A conformant JSP Engine implementation will, during it's initialization instantiate an implementation dependent |
| subclass of this class, and make it globally available for use by JSP implementation classes by registering the |
| instance created with this class via the static <code> setDefaultFactory() </code> method. |
| <p> |
| The only implementation-dependent classes that can be created from the factory are: PageContext, JspEngineInfo, and |
| JspApplicationContext. |
| <p> |
| With the exception of JspApplicationContext, JspFactory objects should not be used by JSP application developers.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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="../../../jakarta/servlet/jsp/JspFactory.html#JspFactory--">JspFactory</a></span>()</code> |
| <div class="block">Sole constructor.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><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>static <a href="../../../jakarta/servlet/jsp/JspFactory.html" title="class in jakarta.servlet.jsp">JspFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#getDefaultFactory--">getDefaultFactory</a></span>()</code> |
| <div class="block">Returns the default factory for this implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../jakarta/servlet/jsp/JspEngineInfo.html" title="class in jakarta.servlet.jsp">JspEngineInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#getEngineInfo--">getEngineInfo</a></span>()</code> |
| <div class="block"> |
| called to get implementation-specific information on the current JSP engine.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../jakarta/servlet/jsp/JspApplicationContext.html" title="interface in jakarta.servlet.jsp">JspApplicationContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#getJspApplicationContext-jakarta.servlet.ServletContext-">getJspApplicationContext</a></span>(<a href="../../../jakarta/servlet/ServletContext.html" title="interface in jakarta.servlet">ServletContext</a> context)</code> |
| <div class="block">Obtains the <code>JspApplicationContext</code> instance associated with the web application for the given |
| <code>ServletContext</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#getPageContext-jakarta.servlet.Servlet-jakarta.servlet.ServletRequest-jakarta.servlet.ServletResponse-java.lang.String-boolean-int-boolean-">getPageContext</a></span>(<a href="../../../jakarta/servlet/Servlet.html" title="interface in jakarta.servlet">Servlet</a> servlet, |
| <a href="../../../jakarta/servlet/ServletRequest.html" title="interface in jakarta.servlet">ServletRequest</a> request, |
| <a href="../../../jakarta/servlet/ServletResponse.html" title="interface in jakarta.servlet">ServletResponse</a> response, |
| java.lang.String errorPageURL, |
| boolean needsSession, |
| int buffer, |
| boolean autoflush)</code> |
| <div class="block"> |
| obtains an instance of an implementation dependent jakarta.servlet.jsp.PageContext abstract class for the calling |
| Servlet and currently pending request and response.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#releasePageContext-jakarta.servlet.jsp.PageContext-">releasePageContext</a></span>(<a href="../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a> pc)</code> |
| <div class="block"> |
| called to release a previously allocated PageContext object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/servlet/jsp/JspFactory.html#setDefaultFactory-jakarta.servlet.jsp.JspFactory-">setDefaultFactory</a></span>(<a href="../../../jakarta/servlet/jsp/JspFactory.html" title="class in jakarta.servlet.jsp">JspFactory</a> deflt)</code> |
| <div class="block"> |
| set the default factory for this implementation.</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="JspFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JspFactory</h4> |
| <pre>public JspFactory()</pre> |
| <div class="block">Sole constructor. (For invocation by subclass constructors, typically implicit.)</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setDefaultFactory-jakarta.servlet.jsp.JspFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultFactory</h4> |
| <pre>public static void setDefaultFactory(<a href="../../../jakarta/servlet/jsp/JspFactory.html" title="class in jakarta.servlet.jsp">JspFactory</a> deflt)</pre> |
| <div class="block"><p> |
| set the default factory for this implementation. It is illegal for any principal other than the JSP Engine |
| runtime to call this method. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deflt</code> - The default factory implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultFactory</h4> |
| <pre>public static <a href="../../../jakarta/servlet/jsp/JspFactory.html" title="class in jakarta.servlet.jsp">JspFactory</a> getDefaultFactory()</pre> |
| <div class="block">Returns the default factory for this implementation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default factory for this implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPageContext-jakarta.servlet.Servlet-jakarta.servlet.ServletRequest-jakarta.servlet.ServletResponse-java.lang.String-boolean-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageContext</h4> |
| <pre>public abstract <a href="../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a> getPageContext(<a href="../../../jakarta/servlet/Servlet.html" title="interface in jakarta.servlet">Servlet</a> servlet, |
| <a href="../../../jakarta/servlet/ServletRequest.html" title="interface in jakarta.servlet">ServletRequest</a> request, |
| <a href="../../../jakarta/servlet/ServletResponse.html" title="interface in jakarta.servlet">ServletResponse</a> response, |
| java.lang.String errorPageURL, |
| boolean needsSession, |
| int buffer, |
| boolean autoflush)</pre> |
| <div class="block"><p> |
| obtains an instance of an implementation dependent jakarta.servlet.jsp.PageContext abstract class for the calling |
| Servlet and currently pending request and response. |
| </p> |
| |
| <p> |
| This method is typically called early in the processing of the _jspService() method of a JSP implementation class |
| in order to obtain a PageContext object for the request being processed. |
| </p> |
| <p> |
| Invoking this method shall result in the PageContext.initialize() method being invoked. The PageContext returned |
| is properly initialized. |
| </p> |
| <p> |
| All PageContext objects obtained via this method shall be released by invoking releasePageContext(). |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>servlet</code> - the requesting servlet</dd> |
| <dd><code>request</code> - the current request pending on the servlet</dd> |
| <dd><code>response</code> - the current response pending on the servlet</dd> |
| <dd><code>errorPageURL</code> - the URL of the error page for the requesting JSP, or null</dd> |
| <dd><code>needsSession</code> - true if the JSP participates in a session</dd> |
| <dd><code>buffer</code> - size of buffer in bytes, JspWriter.NO_BUFFER if no buffer, JspWriter.DEFAULT_BUFFER if |
| implementation default.</dd> |
| <dd><code>autoflush</code> - should the buffer autoflush to the output stream on buffer overflow, or throw an IOException?</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the page context</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp"><code>PageContext</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="releasePageContext-jakarta.servlet.jsp.PageContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>releasePageContext</h4> |
| <pre>public abstract void releasePageContext(<a href="../../../jakarta/servlet/jsp/PageContext.html" title="class in jakarta.servlet.jsp">PageContext</a> pc)</pre> |
| <div class="block"><p> |
| called to release a previously allocated PageContext object. Results in PageContext.release() being invoked. This |
| method should be invoked prior to returning from the _jspService() method of a JSP implementation class. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pc</code> - A PageContext previously obtained by getPageContext()</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEngineInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEngineInfo</h4> |
| <pre>public abstract <a href="../../../jakarta/servlet/jsp/JspEngineInfo.html" title="class in jakarta.servlet.jsp">JspEngineInfo</a> getEngineInfo()</pre> |
| <div class="block"><p> |
| called to get implementation-specific information on the current JSP engine. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a JspEngineInfo object describing the current JSP engine</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJspApplicationContext-jakarta.servlet.ServletContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getJspApplicationContext</h4> |
| <pre>public abstract <a href="../../../jakarta/servlet/jsp/JspApplicationContext.html" title="interface in jakarta.servlet.jsp">JspApplicationContext</a> getJspApplicationContext(<a href="../../../jakarta/servlet/ServletContext.html" title="interface in jakarta.servlet">ServletContext</a> context)</pre> |
| <div class="block">Obtains the <code>JspApplicationContext</code> instance associated with the web application for the given |
| <code>ServletContext</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The <code>ServletContext</code> for the web application the desired |
| <code>JspApplicationContext</code> is associated with.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <code>JspApplicationContext</code> associated with the web application.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.1</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/jsp/JspException.html" title="class in jakarta.servlet.jsp"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/servlet/jsp/JspPage.html" title="interface in jakarta.servlet.jsp"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/servlet/jsp/JspFactory.html" target="_top">Frames</a></li> |
| <li><a href="JspFactory.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>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> |