jfarcand 2003/09/30 12:49:00 Modified: jsr154/src/share/javax/servlet Filter.java FilterChain.java GenericServlet.java ServletContext.java ServletContextAttributeEvent.java ServletContextAttributeListener.java ServletContextEvent.java ServletContextListener.java ServletOutputStream.java ServletRequest.java ServletRequestAttributeEvent.java ServletRequestAttributeListener.java ServletRequestEvent.java ServletRequestListener.java ServletResponse.java jsr154/src/share/javax/servlet/http HttpServletRequest.java HttpServletResponse.java HttpSession.java HttpSessionBindingEvent.java Log: Apply patch submitted by Yutaka Yoshida at Sun: The attached file is to update the Servlet 2.4 API. Changes are synchronizing with the latest specification and fixing a typo and a bad indentation. All semantics stay the same. Revision Changes Path 1.3 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/Filter.java Index: Filter.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/Filter.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- Filter.java 18 Aug 2003 16:50:33 -0000 1.2 +++ Filter.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -114,7 +114,7 @@ * filter content or headers for output filtering <br> * 4. a) <strong>Either</strong> invoke the next entity in the chain using the FilterChain object (<code>chain.doFilter()</code>), <br> ** 4. b) <strong>or</strong> not pass on the request/response pair to the next entity in the filter chain to block the request processing<br> - ** 5. Directly set headers on the response after invocation of the next entity in ther filter chain. + ** 5. Directly set headers on the response after invocation of the next entity in the filter chain. **/ public void doFilter ( ServletRequest request, ServletResponse response, FilterChain chain ) throws IOException, ServletException; 1.2 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/FilterChain.java Index: FilterChain.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/FilterChain.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- FilterChain.java 13 Aug 2002 16:21:42 -0000 1.1 +++ FilterChain.java 30 Sep 2003 19:49:00 -0000 1.2 @@ -66,7 +66,7 @@ * A FilterChain is an object provided by the servlet container to the developer * giving a view into the invocation chain of a filtered request for a resource. Filters * use the FilterChain to invoke the next filter in the chain, or if the calling filter - * is the last filter in the chain, to invoke the rosource at the end of the chain. + * is the last filter in the chain, to invoke the resource at the end of the chain. * * @see Filter * @since Servlet 2.3 1.3 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/GenericServlet.java Index: GenericServlet.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/GenericServlet.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- GenericServlet.java 11 Jan 2003 00:26:02 -0000 1.2 +++ GenericServlet.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -136,7 +136,7 @@ * of the initialization parameter * * @return String a <code>String</code> containing the value - * of the initalization parameter + * of the initialization parameter * */ 1.6 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContext.java Index: ServletContext.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContext.java,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- ServletContext.java 2 Sep 2003 21:14:10 -0000 1.5 +++ ServletContext.java 30 Sep 2003 19:49:00 -0000 1.6 @@ -674,7 +674,7 @@ public void removeAttribute(String name); /** - * Returns the name of this web application correponding to this ServletContext as specified in the deployment + * Returns the name of this web application corresponding to this ServletContext as specified in the deployment * descriptor for this web application by the display-name element. * * 1.3 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextAttributeEvent.java Index: ServletContextAttributeEvent.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextAttributeEvent.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- ServletContextAttributeEvent.java 18 Aug 2003 16:50:33 -0000 1.2 +++ ServletContextAttributeEvent.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -91,7 +91,7 @@ /** * Returns the value of the attribute that has been added, removed, or replaced. - * If the attribute was added, this is the value of the attribute. If the attrubute was + * If the attribute was added, this is the value of the attribute. If the attribute was * removed, this is the value of the removed attribute. If the attribute was replaced, this * is the old value of the attribute. * 1.3 +2 -2 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextAttributeListener.java Index: ServletContextAttributeListener.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextAttributeListener.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- ServletContextAttributeListener.java 5 Mar 2003 19:42:48 -0000 1.2 +++ ServletContextAttributeListener.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -2,9 +2,9 @@ import java.util.EventListener; - /** Implementations of this interface recieve notifications of + /** Implementations of this interface receive notifications of ** changes to the attribute list on the servlet context of a web application. - * To recieve notification events, the implementation class + * To receive notification events, the implementation class * must be configured in the deployment descriptor for the web application. * @see ServletContextAttributeEvent * @since v 2.3 1.2 +10 -9 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextEvent.java Index: ServletContextEvent.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextEvent.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ServletContextEvent.java 13 Aug 2002 16:21:43 -0000 1.1 +++ ServletContextEvent.java 30 Sep 2003 19:49:00 -0000 1.2 @@ -62,26 +62,27 @@ /** - * This is the event class for notifications about changes to the servlet context of a web application. - * @see ServletContextListener + * This is the event class for notifications about changes to + * the servlet context of a web application. + * @see ServletContextListener * @since v 2.3 - */ + */ public class ServletContextEvent extends java.util.EventObject { /** Construct a ServletContextEvent from the given context. - * - * @param source - the ServletContext that is sending the event. + * + * @param source - the ServletContext that is sending the event. */ public ServletContextEvent(ServletContext source) { super(source); } /** - * Return the ServletContext that changed. - * - * @return the ServletContext that sent the event. - */ + * Return the ServletContext that changed. + * + * @return the ServletContext that sent the event. + */ public ServletContext getServletContext () { return (ServletContext) super.getSource(); } 1.4 +21 -14 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextListener.java Index: ServletContextListener.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletContextListener.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ServletContextListener.java 18 Aug 2003 16:50:33 -0000 1.3 +++ ServletContextListener.java 30 Sep 2003 19:49:00 -0000 1.4 @@ -63,26 +63,33 @@ import java.util.EventListener; /** - * Implementations of this interface recieve notifications about changes to the servlet context of the web application they are part of. - * To recieve notification events, the implementation class - * must be configured in the deployment descriptor for the web application. - * @see ServletContextEvent + * Implementations of this interface receive notifications about + * changes to the servlet context of the web application they are + * part of. + * To receive notification events, the implementation class + * must be configured in the deployment descriptor for the web + * application. + * @see ServletContextEvent * @since v 2.3 - */ + */ public interface ServletContextListener extends EventListener { - /** Notification that the web application initialization - ** process is starting. - ** All ServletContextListeners are notified of context - ** initialisation before any filter or servlet in the web - ** application is initialized. - */ + /** + ** Notification that the web application initialization + ** process is starting. + ** All ServletContextListeners are notified of context + ** initialization before any filter or servlet in the web + ** application is initialized. + */ public void contextInitialized ( ServletContextEvent sce ); - /** Notification that the servlet context is about to be shut down. All servlets - have been destroy()ed before any ServletContextListeners are notified of context - destruction. */ + /** + ** Notification that the servlet context is about to be shut down. + ** All servlets and filters have been destroy()ed before any + ** ServletContextListeners are notified of context + ** destruction. + */ public void contextDestroyed ( ServletContextEvent sce ); } 1.3 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletOutputStream.java Index: ServletOutputStream.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletOutputStream.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- ServletOutputStream.java 18 Aug 2003 16:50:33 -0000 1.2 +++ ServletOutputStream.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -276,7 +276,7 @@ * followed by a carriage return-line feed (CRLF). * * - * @param s the </code>String</code> to write to the client + * @param s the <code>String</code> to write to the client * * @exception IOException if an input or output exception occurred * 1.8 +8 -3 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequest.java Index: ServletRequest.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequest.java,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- ServletRequest.java 2 Sep 2003 21:14:10 -0000 1.7 +++ ServletRequest.java 30 Sep 2003 19:49:00 -0000 1.8 @@ -147,7 +147,7 @@ * * * @return a <code>String</code> containing the name of - * the chararacter encoding, or <code>null</code> + * the character encoding, or <code>null</code> * if the request does not specify a character encoding * */ @@ -161,7 +161,7 @@ * * * @param env a <code>String</code> containing the name of - * the chararacter encoding. + * the character encoding. * @throws java.io.UnsupportedEncodingException if this is not a valid encoding */ @@ -451,7 +451,10 @@ * reserved for use by Sun Microsystems. *<br> If the object passed in is null, the effect is the same as * calling [EMAIL PROTECTED] #removeAttribute}. - * + * <br> It is warned that when the request is dispatched from the + * servlet resides in a different web application by + * <code>RequestDispatcher</code>, the object set by this method + * may not be correctly retrieved in the caller servlet. * * * @param name a <code>String</code> specifying @@ -593,6 +596,8 @@ /** * Returns the Internet Protocol (IP) source port of the client * or last proxy that sent the request. + * + * @return an integer specifying the port number * * @since 2.4 */ 1.2 +13 -12 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestAttributeEvent.java Index: ServletRequestAttributeEvent.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestAttributeEvent.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ServletRequestAttributeEvent.java 13 Aug 2002 16:21:44 -0000 1.1 +++ ServletRequestAttributeEvent.java 30 Sep 2003 19:49:00 -0000 1.2 @@ -62,23 +62,24 @@ /** - * This is the event class for notifications about changes to the - * attributes of the servlet request of a web application. + * This is the event class for notifications of changes to the + * attributes of the servlet request in an application. * @see ServletRequestAttributeListener - * @since v 2.4 + * @since Servlet 2.4 */ public class ServletRequestAttributeEvent extends ServletRequestEvent { private String name; private Object value; - /** Construct a ServletRequestAttributeEvent from the given context for the - * given attribute name and attribute value. + /** Construct a ServletRequestAttributeEvent giving the servlet context + * of this web application, the ServletRequest whose attributes are + * changing and the name and value of the attribute. * - * @param sc - the ServletContext that is sending the event. - * @param request - the ServletRequest that is sending the event. - * @param name - the name of the request attribute. - * @param value - the value of the request attribute. + * @param sc the ServletContext that is sending the event. + * @param request the ServletRequest that is sending the event. + * @param name the name of the request attribute. + * @param value the value of the request attribute. */ public ServletRequestAttributeEvent(ServletContext sc, ServletRequest request, String name, Object value) { super(sc, request); @@ -89,20 +90,20 @@ /** * Return the name of the attribute that changed on the ServletRequest. * - * @return String - the name of the changed request attribute. + * @return the name of the changed request attribute */ public String getName() { return this.name; } /** - * Returns the value of the attribute that has been added removed or + * Returns the value of the attribute that has been added, removed or * replaced. If the attribute was added, this is the value of the * attribute. If the attribute was removed, this is the value of the * removed attribute. If the attribute was replaced, this is the old * value of the attribute. * - * @return Object - the value of the changed request attribute. + * @return the value of the changed request attribute */ public Object getValue() { return this.value; 1.2 +20 -10 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestAttributeListener.java Index: ServletRequestAttributeListener.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestAttributeListener.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ServletRequestAttributeListener.java 13 Aug 2002 16:21:42 -0000 1.1 +++ ServletRequestAttributeListener.java 30 Sep 2003 19:49:00 -0000 1.2 @@ -68,23 +68,33 @@ import java.util.EventListener; - /** Implementations of this interface receive notifications of - * changes to the attribute list on the servlet request of a - * web application. - * To receive notification events, the implementation class - * must be configured in the deployment descriptor for the web application. - * @see ServletRequestAttributeEvent - * @since v 2.4 + /** + * A ServletRequestAttributeListener can be implemented by the + * developer interested in being notified of request attribute + * changes. Notifications will be generated while the request + * is within the scope of the web application in which the listener + * is registered. A request is defined as coming into scope when + * it is about to enter the first servlet or filter in each web + * application, as going out of scope when it exits the last servlet + * or the first filter in the chain. + * + * @since Servlet 2.4 */ public interface ServletRequestAttributeListener extends EventListener { - /** Notification that a new attribute was added to the servlet request. Called after the attribute is added.*/ + /** Notification that a new attribute was added to the + ** servlet request. Called after the attribute is added. + */ public void attributeAdded(ServletRequestAttributeEvent srae); - /** Notification that an existing attribute has been removed from the servlet request. Called after the attribute is removed.*/ + /** Notification that an existing attribute has been removed from the + ** servlet request. Called after the attribute is removed. + */ public void attributeRemoved(ServletRequestAttributeEvent srae); - /** Notification that an attribute on the servlet request has been replaced. Called after the attribute is replaced. */ + /** Notification that an attribute was replaced on the + ** servlet request. Called after the attribute is replaced. + */ public void attributeReplaced(ServletRequestAttributeEvent srae); } 1.4 +11 -12 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestEvent.java Index: ServletRequestEvent.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestEvent.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ServletRequestEvent.java 29 Oct 2002 19:33:16 -0000 1.3 +++ ServletRequestEvent.java 30 Sep 2003 19:49:00 -0000 1.4 @@ -62,19 +62,22 @@ /** - * This is the event class for notifications about changes to the - * servlet request of a web application. + * Events of this kind indicate lifecycle + * events for a ServletRequest. + * The source of the event + * is the ServletContext of this web application. * @see ServletRequestListener - * @since v 2.4 + * @since Servlet 2.4 */ public class ServletRequestEvent extends java.util.EventObject { private ServletRequest request; - /** Construct a ServletRequestEvent from the given context. + /** Construct a ServletRequestEvent for the given ServletContext + * and ServletRequest. * - * @param sc - the ServletContext of the web application. - * @param request - the ServletRequest that is sending the event. + * @param sc the ServletContext of the web application. + * @param request the ServletRequest that is sending the event. */ public ServletRequestEvent(ServletContext sc, ServletRequest request) { super(sc); @@ -82,18 +85,14 @@ } /** - * Return the ServletRequest that changed. - * - * @return the ServletRequest that sent the event. + * Returns the ServletRequest that is changing. */ public ServletRequest getServletRequest () { return this.request; } /** - * Return the ServletContext that changed. - * - * @return the ServletContext of the web application. + * Returns the ServletContext of this web application. */ public ServletContext getServletContext () { return (ServletContext) super.getSource(); 1.2 +14 -11 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestListener.java Index: ServletRequestListener.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletRequestListener.java,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- ServletRequestListener.java 13 Aug 2002 16:21:42 -0000 1.1 +++ ServletRequestListener.java 30 Sep 2003 19:49:00 -0000 1.2 @@ -62,20 +62,23 @@ import java.util.EventListener; - /** - * Implementations of this interface recieve notifications about changes - * to the servlet request of the web application they are part of. - * To receive notification events, the implementation class - * must be configured in the deployment descriptor for the web - * application. - * @see ServletContextEvent - * @since v 2.4 - */ + /** + * A ServletRequestListener can be implemented by the developer + * interested in being notified of requests coming in and out of + * scope in a web component. A request is defined as coming into + * scope when it is about to enter the first servlet or filter + * in each web application, as going out of scope when it exits + * the last servlet or the first filter in the chain. + * + * @since Servlet 2.4 + */ + public interface ServletRequestListener extends EventListener { - /** Notification that the servlet request is about to go out of scope. */ + + /** The request is about to go out of scope of the web application. */ public void requestDestroyed ( ServletRequestEvent sre ); - /** Notification that the servlet request is about to go into scope. */ + /** The request is about to come into scope of the web application. */ public void requestInitialized ( ServletRequestEvent sre ); } 1.6 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletResponse.java Index: ServletResponse.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/ServletResponse.java,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- ServletResponse.java 2 Sep 2003 21:14:10 -0000 1.5 +++ ServletResponse.java 30 Sep 2003 19:49:00 -0000 1.6 @@ -396,7 +396,7 @@ /** * Returns a boolean indicating if the response has been - * committed. A commited response has already had its status + * committed. A committed response has already had its status * code and headers written. * * @return a boolean indicating if the response has been 1.6 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpServletRequest.java Index: HttpServletRequest.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpServletRequest.java,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- HttpServletRequest.java 18 Aug 2003 16:50:33 -0000 1.5 +++ HttpServletRequest.java 30 Sep 2003 19:49:00 -0000 1.6 @@ -169,7 +169,7 @@ * since January 1, 1970 GMT, * or -1 if the named header * was not included with the - * reqest + * request * * @exception IllegalArgumentException If the header value * can't be converted 1.7 +2 -2 jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpServletResponse.java Index: HttpServletResponse.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpServletResponse.java,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- HttpServletResponse.java 2 Sep 2003 21:14:10 -0000 1.6 +++ HttpServletResponse.java 30 Sep 2003 19:49:00 -0000 1.7 @@ -135,7 +135,7 @@ * includes the logic to determine whether the session ID * needs to be encoded in the URL. Because the rules for making * this determination can differ from those used to decide whether to - * encode a normal link, this method is separete from the + * encode a normal link, this method is separated from the * <code>encodeURL</code> method. * * <p>All URLs sent to the <code>HttpServletResponse.sendRedirect</code> @@ -339,7 +339,7 @@ * set the return status code when there is no error (for example, * for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there * is an error, and the caller wishes to invoke an error-page defined - * in the web applicaion, the <code>sendError</code> method should be used + * in the web application, the <code>sendError</code> method should be used * instead. * <p> The container clears the buffer and sets the Location header, preserving * cookies and other headers. 1.5 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpSession.java Index: HttpSession.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpSession.java,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- HttpSession.java 18 Aug 2003 16:50:33 -0000 1.4 +++ HttpSession.java 30 Sep 2003 19:49:00 -0000 1.5 @@ -89,7 +89,7 @@ * the servlet notifies the object that it has been bound to or unbound * from the session. Notifications are sent after the binding methods complete. * For session that are invalidated or expire, notifications are sent after - * the session has been invalidatd or expired. + * the session has been invalidated or expired. * * <p> When container migrates a session between VMs in a distributed container * setting, all session attributes implementing the [EMAIL PROTECTED] HttpSessionActivationListener} 1.3 +1 -1 jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpSessionBindingEvent.java Index: HttpSessionBindingEvent.java =================================================================== RCS file: /home/cvs/jakarta-servletapi-5/jsr154/src/share/javax/servlet/http/HttpSessionBindingEvent.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- HttpSessionBindingEvent.java 2 Sep 2003 21:14:10 -0000 1.2 +++ HttpSessionBindingEvent.java 30 Sep 2003 19:49:00 -0000 1.3 @@ -175,7 +175,7 @@ /** * Returns the value of the attribute that has been added, removed or replaced. - * If the attribute was added (or bound), this is the value of the attribute. If the attrubute was + * If the attribute was added (or bound), this is the value of the attribute. If the attribute was * removed (or unbound), this is the value of the removed attribute. If the attribute was replaced, this * is the old value of the attribute. *
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]