001: /*
002: * Copyright (c) 1998-2003 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: * Free SoftwareFoundation, Inc.
023: * 59 Temple Place, Suite 330
024: * Boston, MA 02111-1307 USA
025: *
026: * @author Scott Ferguson
027: */
028:
029: package javax.servlet.jsp;
030:
031: import javax.servlet.Servlet;
032: import javax.servlet.ServletConfig;
033: import javax.servlet.ServletContext;
034: import javax.servlet.ServletException;
035: import javax.servlet.ServletRequest;
036: import javax.servlet.ServletResponse;
037: import javax.servlet.http.HttpSession;
038: import javax.servlet.jsp.tagext.BodyContent;
039: import java.io.IOException;
040: import java.util.Enumeration;
041:
042: public abstract class PageContext extends JspContext {
043: public final static int PAGE_SCOPE = 1;
044: public final static int REQUEST_SCOPE = 2;
045: public final static int SESSION_SCOPE = 3;
046: public final static int APPLICATION_SCOPE = 4;
047:
048: public final static String PAGE = "javax.servlet.jsp.jspPage";
049: public final static String PAGECONTEXT = "javax.servlet.jsp.jspPageContext";
050: public final static String REQUEST = "javax.servlet.jsp.jspRequest";
051: public final static String RESPONSE = "javax.servlet.jsp.jspResponse";
052: public final static String CONFIG = "javax.servlet.jsp.jspConfig";
053: public final static String SESSION = "javax.servlet.jsp.jspSession";
054: public final static String OUT = "javax.servlet.jsp.jspOut";
055: public final static String APPLICATION = "javax.servlet.jsp.jspApplication";
056: public final static String EXCEPTION = "javax.servlet.jsp.jspException";
057:
058: /**
059: * Gets the named page attribute.
060: *
061: * @param name of the attribute
062: */
063: public abstract Object getAttribute(String name);
064:
065: /**
066: * Sets the named page attribute.
067: *
068: * @param name name of the attribute
069: * @param attribute non-null attribute value.
070: */
071: public abstract void setAttribute(String name, Object attribute);
072:
073: /**
074: * Removes the named page attribute.
075: */
076: public abstract void removeAttribute(String name);
077:
078: /**
079: * Return an enumeration of all the attribute names.
080: */
081: public abstract Enumeration getAttributeNames();
082:
083: /**
084: * Returns the current output for the page.
085: */
086: public abstract JspWriter getOut();
087:
088: /**
089: * Returns the request's session.
090: */
091: public abstract HttpSession getSession();
092:
093: /**
094: * Return the servlet object for the page.
095: */
096: public abstract Object getPage();
097:
098: /**
099: * Returns the ServletRequest for the page.
100: */
101: public abstract ServletRequest getRequest();
102:
103: /**
104: * Returns the ServletResponse for the page.
105: */
106: public abstract ServletResponse getResponse();
107:
108: /**
109: * Returns the exception for error pages.
110: */
111: public abstract Exception getException();
112:
113: /**
114: * Returns the servletConfig for the JSP page.
115: */
116: public abstract ServletConfig getServletConfig();
117:
118: /**
119: * Returns the servletContext (application object) for the request.
120: */
121: public abstract ServletContext getServletContext();
122:
123: /**
124: * Forwards the request relative to the current URL.
125: */
126: public abstract void forward(String relativeUrl)
127: throws ServletException, IOException;
128:
129: /**
130: * Includes the a page relative to the current URL.
131: */
132: public void include(String relativeUrl) throws ServletException,
133: IOException {
134: include(relativeUrl, true);
135: }
136:
137: /**
138: * Includes the a page relative to the current URL.
139: */
140: public abstract void include(String relativeUrl, boolean flush)
141: throws ServletException, IOException;
142:
143: /**
144: * Internal routine to initialize the PageContext for a page.
145: */
146: public abstract void initialize(Servlet servlet,
147: ServletRequest request, ServletResponse response,
148: String errorPageURL, boolean needsSession, int bufferSize,
149: boolean autoFlush) throws IOException,
150: IllegalStateException, IllegalArgumentException;
151:
152: /**
153: * Internal routine to support BodyTags. Pushes the new bodyContent
154: * to become the value of getOut().
155: */
156: public BodyContent pushBody() {
157: return null;
158: }
159:
160: /**
161: * Internal routine to support errorPages. Kept for backward
162: * compatibility.
163: */
164: public abstract void handlePageException(Exception e)
165: throws ServletException, IOException;
166:
167: /**
168: * Internal routine to support errorPages
169: */
170: public abstract void handlePageException(Throwable t)
171: throws ServletException, IOException;
172:
173: /**
174: * Internal routine to free PageContext resources at the end of a page.
175: */
176: public abstract void release();
177:
178: /**
179: * Returns an error data instance.
180: */
181: public abstract ErrorData getErrorData();
182:
183: }
|