You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2010/07/23 17:48:54 UTC
svn commit: r967140 [1/3] - /tomcat/trunk/java/javax/servlet/
Author: markt
Date: Fri Jul 23 15:48:53 2010
New Revision: 967140
URL: http://svn.apache.org/viewvc?rev=967140&view=rev
Log:
Tab police: javax.servlet (remainder - not sub-packages)
Thanks to Checkstyle and Eclipse source formatting
Modified:
tomcat/trunk/java/javax/servlet/ServletConfig.java
tomcat/trunk/java/javax/servlet/ServletContext.java
tomcat/trunk/java/javax/servlet/ServletContextAttributeEvent.java
tomcat/trunk/java/javax/servlet/ServletContextAttributeListener.java
tomcat/trunk/java/javax/servlet/ServletContextEvent.java
tomcat/trunk/java/javax/servlet/ServletContextListener.java
tomcat/trunk/java/javax/servlet/ServletException.java
tomcat/trunk/java/javax/servlet/ServletInputStream.java
tomcat/trunk/java/javax/servlet/ServletOutputStream.java
tomcat/trunk/java/javax/servlet/ServletRequest.java
tomcat/trunk/java/javax/servlet/ServletRequestAttributeEvent.java
tomcat/trunk/java/javax/servlet/ServletRequestEvent.java
tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java
tomcat/trunk/java/javax/servlet/ServletResponse.java
tomcat/trunk/java/javax/servlet/ServletResponseWrapper.java
tomcat/trunk/java/javax/servlet/SingleThreadModel.java
tomcat/trunk/java/javax/servlet/UnavailableException.java
Modified: tomcat/trunk/java/javax/servlet/ServletConfig.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletConfig.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletConfig.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletConfig.java Fri Jul 23 15:48:53 2010
@@ -1,95 +1,69 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
import java.util.Enumeration;
-
-
/**
- *
- * A servlet configuration object used by a servlet container
- * to pass information to a servlet during initialization.
- *
+ * A servlet configuration object used by a servlet container to pass
+ * information to a servlet during initialization.
*/
-
public interface ServletConfig {
-
/**
- * Returns the name of this servlet instance.
- * The name may be provided via server administration, assigned in the
- * web application deployment descriptor, or for an unregistered (and thus
- * unnamed) servlet instance it will be the servlet's class name.
- *
- * @return the name of the servlet instance
- *
- *
- *
+ * Returns the name of this servlet instance. The name may be provided via
+ * server administration, assigned in the web application deployment
+ * descriptor, or for an unregistered (and thus unnamed) servlet instance it
+ * will be the servlet's class name.
+ *
+ * @return the name of the servlet instance
*/
-
public String getServletName();
/**
- * Returns a reference to the {@link ServletContext} in which the caller
- * is executing.
- *
- *
- * @return a {@link ServletContext} object, used
- * by the caller to interact with its servlet
- * container
+ * Returns a reference to the {@link ServletContext} in which the caller is
+ * executing.
*
- * @see ServletContext
- *
+ * @return a {@link ServletContext} object, used by the caller to interact
+ * with its servlet container
+ * @see ServletContext
*/
-
public ServletContext getServletContext();
-
+
/**
- * Returns a <code>String</code> containing the value of the
- * named initialization parameter, or <code>null</code> if
- * the parameter does not exist.
- *
- * @param name a <code>String</code> specifying the name
- * of the initialization parameter
- *
- * @return a <code>String</code> containing the value
- * of the initialization parameter
- *
+ * Returns a <code>String</code> containing the value of the named
+ * initialization parameter, or <code>null</code> if the parameter does not
+ * exist.
+ *
+ * @param name
+ * a <code>String</code> specifying the name of the
+ * initialization parameter
+ * @return a <code>String</code> containing the value of the initialization
+ * parameter
*/
-
public String getInitParameter(String name);
-
/**
- * Returns the names of the servlet's initialization parameters
- * as an <code>Enumeration</code> of <code>String</code> objects,
- * or an empty <code>Enumeration</code> if the servlet has
- * no initialization parameters.
- *
- * @return an <code>Enumeration</code> of <code>String</code>
- * objects containing the names of the servlet's
- * initialization parameters
- *
- *
- *
+ * Returns the names of the servlet's initialization parameters as an
+ * <code>Enumeration</code> of <code>String</code> objects, or an empty
+ * <code>Enumeration</code> if the servlet has no initialization parameters.
+ *
+ * @return an <code>Enumeration</code> of <code>String</code> objects
+ * containing the names of the servlet's initialization parameters
*/
-
public Enumeration<String> getInitParameterNames();
-
-
}
Modified: tomcat/trunk/java/javax/servlet/ServletContext.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContext.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContext.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContext.java Fri Jul 23 15:48:53 2010
@@ -1,19 +1,19 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
import java.io.InputStream;
@@ -27,915 +27,686 @@ import java.util.Set;
import javax.servlet.descriptor.JspConfigDescriptor;
/**
- *
- * Defines a set of methods that a servlet uses to communicate with its
- * servlet container, for example, to get the MIME type of a file, dispatch
- * requests, or write to a log file.
- *
- * <p>There is one context per "web application" per Java Virtual Machine. (A
+ * Defines a set of methods that a servlet uses to communicate with its servlet
+ * container, for example, to get the MIME type of a file, dispatch requests, or
+ * write to a log file.
+ * <p>
+ * There is one context per "web application" per Java Virtual Machine. (A
* "web application" is a collection of servlets and content installed under a
* specific subset of the server's URL namespace such as <code>/catalog</code>
- * and possibly installed via a <code>.war</code> file.)
- *
- * <p>In the case of a web
- * application marked "distributed" in its deployment descriptor, there will
- * be one context instance for each virtual machine. In this situation, the
- * context cannot be used as a location to share global information (because
- * the information won't be truly global). Use an external resource like
- * a database instead.
- *
- * <p>The <code>ServletContext</code> object is contained within
- * the {@link ServletConfig} object, which the Web server provides the
- * servlet when the servlet is initialized.
- *
- * @author Various
- * @version $Version$
- *
- * @see Servlet#getServletConfig
- * @see ServletConfig#getServletContext
- *
+ * and possibly installed via a <code>.war</code> file.)
+ * <p>
+ * In the case of a web application marked "distributed" in its deployment
+ * descriptor, there will be one context instance for each virtual machine. In
+ * this situation, the context cannot be used as a location to share global
+ * information (because the information won't be truly global). Use an external
+ * resource like a database instead.
+ * <p>
+ * The <code>ServletContext</code> object is contained within the
+ * {@link ServletConfig} object, which the Web server provides the servlet when
+ * the servlet is initialized.
+ *
+ * @author Various
+ * @version $Version$
+ * @see Servlet#getServletConfig
+ * @see ServletConfig#getServletContext
*/
-
public interface ServletContext {
public static final String TEMPDIR = "javax.servlet.context.tempdir";
-
+
/**
* @since Servlet 3.0
*/
- public static final String ORDERED_LIBS =
- "javax.servlet.context.orderedLibs";
+ public static final String ORDERED_LIBS = "javax.servlet.context.orderedLibs";
/**
- * Returns a <code>ServletContext</code> object that
- * corresponds to a specified URL on the server.
- *
- * <p>This method allows servlets to gain
- * access to the context for various parts of the server, and as
- * needed obtain {@link RequestDispatcher} objects from the context.
- * The given path must be begin with "/", is interpreted relative
- * to the server's document root and is matched against the context roots of
- * other web applications hosted on this container.
- *
- * <p>In a security conscious environment, the servlet container may
- * return <code>null</code> for a given URL.
- *
- * @param uripath a <code>String</code> specifying the context path of
- * another web application in the container.
- * @return the <code>ServletContext</code> object that
- * corresponds to the named URL, or null if either
- none exists or the container wishes to restrict
- * this access.
- *
- * @see RequestDispatcher
- *
+ * Returns a <code>ServletContext</code> object that corresponds to a
+ * specified URL on the server.
+ * <p>
+ * This method allows servlets to gain access to the context for various
+ * parts of the server, and as needed obtain {@link RequestDispatcher}
+ * objects from the context. The given path must be begin with "/", is
+ * interpreted relative to the server's document root and is matched against
+ * the context roots of other web applications hosted on this container.
+ * <p>
+ * In a security conscious environment, the servlet container may return
+ * <code>null</code> for a given URL.
+ *
+ * @param uripath
+ * a <code>String</code> specifying the context path of another
+ * web application in the container.
+ * @return the <code>ServletContext</code> object that corresponds to the
+ * named URL, or null if either none exists or the container wishes
+ * to restrict this access.
+ * @see RequestDispatcher
*/
-
public ServletContext getContext(String uripath);
-
public String getContextPath();
-
/**
- * Returns the major version of the Java Servlet API that this
- * servlet container supports. All implementations that comply
- * with Version 3.0 must have this method
- * return the integer 3.
- *
- * @return 3
- *
+ * Returns the major version of the Java Servlet API that this servlet
+ * container supports. All implementations that comply with Version 3.0 must
+ * have this method return the integer 3.
+ *
+ * @return 3
*/
-
public int getMajorVersion();
-
-
/**
- * Returns the minor version of the Servlet API that this
- * servlet container supports. All implementations that comply
- * with Version 3.0 must have this method
- * return the integer 0.
- *
- * @return 0
- *
+ * Returns the minor version of the Servlet API that this servlet container
+ * supports. All implementations that comply with Version 3.0 must have this
+ * method return the integer 0.
+ *
+ * @return 0
*/
-
public int getMinorVersion();
-
+
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public int getEffectiveMajorVersion();
-
+
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public int getEffectiveMinorVersion();
/**
- * Returns the MIME type of the specified file, or <code>null</code> if
- * the MIME type is not known. The MIME type is determined
- * by the configuration of the servlet container, and may be specified
- * in a web application deployment descriptor. Common MIME
- * types are <code>"text/html"</code> and <code>"image/gif"</code>.
- *
- *
- * @param file a <code>String</code> specifying the name
- * of a file
- *
- * @return a <code>String</code> specifying the file's MIME type
- *
+ * Returns the MIME type of the specified file, or <code>null</code> if the
+ * MIME type is not known. The MIME type is determined by the configuration
+ * of the servlet container, and may be specified in a web application
+ * deployment descriptor. Common MIME types are <code>"text/html"</code> and
+ * <code>"image/gif"</code>.
+ *
+ * @param file
+ * a <code>String</code> specifying the name of a file
+ * @return a <code>String</code> specifying the file's MIME type
*/
-
public String getMimeType(String file);
-
+
/**
- * Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path
- * matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all
- * relative to the root of the web application and have a leading '/'. For example, for a web application
- * containing<br><br>
-
- * /welcome.html<br>
- * /catalog/index.html<br>
- * /catalog/products.html<br>
- * /catalog/offers/books.html<br>
- * /catalog/offers/music.html<br>
- * /customer/login.jsp<br>
- * /WEB-INF/web.xml<br>
- * /WEB-INF/classes/com.acme.OrderServlet.class,<br><br>
- *
- * getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}<br>
- * getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.<br>
-
-
-
- *@param path the partial path used to match the resources,
- * which must start with a /
- *@return a Set containing the directory listing, or null if there are no resources in the web application whose path
- * begins with the supplied path.
-
- * @since Servlet 2.3
- */
-
+ * Returns a directory-like listing of all the paths to resources within the
+ * web application whose longest sub-path matches the supplied path
+ * argument. Paths indicating subdirectory paths end with a '/'. The
+ * returned paths are all relative to the root of the web application and
+ * have a leading '/'. For example, for a web application containing<br>
+ * <br>
+ * /welcome.html<br>
+ * /catalog/index.html<br>
+ * /catalog/products.html<br>
+ * /catalog/offers/books.html<br>
+ * /catalog/offers/music.html<br>
+ * /customer/login.jsp<br>
+ * /WEB-INF/web.xml<br>
+ * /WEB-INF/classes/com.acme.OrderServlet.class,<br>
+ * <br>
+ * getResourcePaths("/") returns {"/welcome.html", "/catalog/",
+ * "/customer/", "/WEB-INF/"}<br>
+ * getResourcePaths("/catalog/") returns {"/catalog/index.html",
+ * "/catalog/products.html", "/catalog/offers/"}.<br>
+ *
+ * @param path
+ * the partial path used to match the resources, which must start
+ * with a /
+ * @return a Set containing the directory listing, or null if there are no
+ * resources in the web application whose path begins with the
+ * supplied path.
+ * @since Servlet 2.3
+ */
public Set<String> getResourcePaths(String path);
-
-
/**
- * Returns a URL to the resource that is mapped to a specified
- * path. The path must begin with a "/" and is interpreted
- * as relative to the current context root.
- *
- * <p>This method allows the servlet container to make a resource
- * available to servlets from any source. Resources
- * can be located on a local or remote
- * file system, in a database, or in a <code>.war</code> file.
- *
- * <p>The servlet container must implement the URL handlers
- * and <code>URLConnection</code> objects that are necessary
- * to access the resource.
- *
- * <p>This method returns <code>null</code>
- * if no resource is mapped to the pathname.
- *
- * <p>Some containers may allow writing to the URL returned by
- * this method using the methods of the URL class.
- *
- * <p>The resource content is returned directly, so be aware that
- * requesting a <code>.jsp</code> page returns the JSP source code.
- * Use a <code>RequestDispatcher</code> instead to include results of
- * an execution.
- *
- * <p>This method has a different purpose than
- * <code>java.lang.Class.getResource</code>,
- * which looks up resources based on a class loader. This
- * method does not use class loaders.
- *
- * @param path a <code>String</code> specifying
- * the path to the resource
- *
- * @return the resource located at the named path,
- * or <code>null</code> if there is no resource
- * at that path
- *
- * @exception MalformedURLException if the pathname is not given in
- * the correct form
- *
+ * Returns a URL to the resource that is mapped to a specified path. The
+ * path must begin with a "/" and is interpreted as relative to the current
+ * context root.
+ * <p>
+ * This method allows the servlet container to make a resource available to
+ * servlets from any source. Resources can be located on a local or remote
+ * file system, in a database, or in a <code>.war</code> file.
+ * <p>
+ * The servlet container must implement the URL handlers and
+ * <code>URLConnection</code> objects that are necessary to access the
+ * resource.
+ * <p>
+ * This method returns <code>null</code> if no resource is mapped to the
+ * pathname.
+ * <p>
+ * Some containers may allow writing to the URL returned by this method
+ * using the methods of the URL class.
+ * <p>
+ * The resource content is returned directly, so be aware that requesting a
+ * <code>.jsp</code> page returns the JSP source code. Use a
+ * <code>RequestDispatcher</code> instead to include results of an
+ * execution.
+ * <p>
+ * This method has a different purpose than
+ * <code>java.lang.Class.getResource</code>, which looks up resources based
+ * on a class loader. This method does not use class loaders.
+ *
+ * @param path
+ * a <code>String</code> specifying the path to the resource
+ * @return the resource located at the named path, or <code>null</code> if
+ * there is no resource at that path
+ * @exception MalformedURLException
+ * if the pathname is not given in the correct form
*/
-
public URL getResource(String path) throws MalformedURLException;
-
-
/**
- * Returns the resource located at the named path as
- * an <code>InputStream</code> object.
- *
- * <p>The data in the <code>InputStream</code> can be
- * of any type or length. The path must be specified according
- * to the rules given in <code>getResource</code>.
- * This method returns <code>null</code> if no resource exists at
- * the specified path.
- *
- * <p>Meta-information such as content length and content type
- * that is available via <code>getResource</code>
- * method is lost when using this method.
- *
- * <p>The servlet container must implement the URL handlers
- * and <code>URLConnection</code> objects necessary to access
- * the resource.
- *
- * <p>This method is different from
- * <code>java.lang.Class.getResourceAsStream</code>,
- * which uses a class loader. This method allows servlet containers
- * to make a resource available
- * to a servlet from any location, without using a class loader.
- *
- *
- * @param path a <code>String</code> specifying the path
- * to the resource
- *
- * @return the <code>InputStream</code> returned to the
- * servlet, or <code>null</code> if no resource
- * exists at the specified path
- *
- *
+ * Returns the resource located at the named path as an
+ * <code>InputStream</code> object.
+ * <p>
+ * The data in the <code>InputStream</code> can be of any type or length.
+ * The path must be specified according to the rules given in
+ * <code>getResource</code>. This method returns <code>null</code> if no
+ * resource exists at the specified path.
+ * <p>
+ * Meta-information such as content length and content type that is
+ * available via <code>getResource</code> method is lost when using this
+ * method.
+ * <p>
+ * The servlet container must implement the URL handlers and
+ * <code>URLConnection</code> objects necessary to access the resource.
+ * <p>
+ * This method is different from
+ * <code>java.lang.Class.getResourceAsStream</code>, which uses a class
+ * loader. This method allows servlet containers to make a resource
+ * available to a servlet from any location, without using a class loader.
+ *
+ * @param path
+ * a <code>String</code> specifying the path to the resource
+ * @return the <code>InputStream</code> returned to the servlet, or
+ * <code>null</code> if no resource exists at the specified path
*/
-
public InputStream getResourceAsStream(String path);
-
-
-
/**
- *
- * Returns a {@link RequestDispatcher} object that acts
- * as a wrapper for the resource located at the given path.
- * A <code>RequestDispatcher</code> object can be used to forward
- * a request to the resource or to include the resource in a response.
- * The resource can be dynamic or static.
- *
- * <p>The pathname must begin with a "/" and is interpreted as relative
- * to the current context root. Use <code>getContext</code> to obtain
- * a <code>RequestDispatcher</code> for resources in foreign contexts.
- * This method returns <code>null</code> if the <code>ServletContext</code>
+ * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
+ * resource located at the given path. A <code>RequestDispatcher</code>
+ * object can be used to forward a request to the resource or to include the
+ * resource in a response. The resource can be dynamic or static.
+ * <p>
+ * The pathname must begin with a "/" and is interpreted as relative to the
+ * current context root. Use <code>getContext</code> to obtain a
+ * <code>RequestDispatcher</code> for resources in foreign contexts. This
+ * method returns <code>null</code> if the <code>ServletContext</code>
* cannot return a <code>RequestDispatcher</code>.
- *
- * @param path a <code>String</code> specifying the pathname
- * to the resource
- *
- * @return a <code>RequestDispatcher</code> object
- * that acts as a wrapper for the resource
- * at the specified path, or <code>null</code> if
- * the <code>ServletContext</code> cannot return
- * a <code>RequestDispatcher</code>
- *
- * @see RequestDispatcher
- * @see ServletContext#getContext
- *
+ *
+ * @param path
+ * a <code>String</code> specifying the pathname to the resource
+ * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
+ * the resource at the specified path, or <code>null</code> if the
+ * <code>ServletContext</code> cannot return a
+ * <code>RequestDispatcher</code>
+ * @see RequestDispatcher
+ * @see ServletContext#getContext
*/
-
public RequestDispatcher getRequestDispatcher(String path);
-
-
/**
- * Returns a {@link RequestDispatcher} object that acts
- * as a wrapper for the named servlet.
- *
- * <p>Servlets (and JSP pages also) may be given names via server
- * administration or via a web application deployment descriptor.
- * A servlet instance can determine its name using
+ * Returns a {@link RequestDispatcher} object that acts as a wrapper for the
+ * named servlet.
+ * <p>
+ * Servlets (and JSP pages also) may be given names via server
+ * administration or via a web application deployment descriptor. A servlet
+ * instance can determine its name using
* {@link ServletConfig#getServletName}.
- *
- * <p>This method returns <code>null</code> if the
- * <code>ServletContext</code>
+ * <p>
+ * This method returns <code>null</code> if the <code>ServletContext</code>
* cannot return a <code>RequestDispatcher</code> for any reason.
- *
- * @param name a <code>String</code> specifying the name
- * of a servlet to wrap
- *
- * @return a <code>RequestDispatcher</code> object
- * that acts as a wrapper for the named servlet,
- * or <code>null</code> if the <code>ServletContext</code>
- * cannot return a <code>RequestDispatcher</code>
- *
- * @see RequestDispatcher
- * @see ServletContext#getContext
- * @see ServletConfig#getServletName
- *
+ *
+ * @param name
+ * a <code>String</code> specifying the name of a servlet to wrap
+ * @return a <code>RequestDispatcher</code> object that acts as a wrapper for
+ * the named servlet, or <code>null</code> if the
+ * <code>ServletContext</code> cannot return a
+ * <code>RequestDispatcher</code>
+ * @see RequestDispatcher
+ * @see ServletContext#getContext
+ * @see ServletConfig#getServletName
*/
-
public RequestDispatcher getNamedDispatcher(String name);
-
-
-
-
- /**
- *
- * @deprecated As of Java Servlet API 2.1, with no direct replacement.
- *
- * <p>This method was originally defined to retrieve a servlet
- * from a <code>ServletContext</code>. In this version, this method
- * always returns <code>null</code> and remains only to preserve
- * binary compatibility. This method will be permanently removed
- * in a future version of the Java Servlet API.
- *
- * <p>In lieu of this method, servlets can share information using the
- * <code>ServletContext</code> class and can perform shared business logic
- * by invoking methods on common non-servlet classes.
- *
+
+ /**
+ * @deprecated As of Java Servlet API 2.1, with no direct replacement.
+ * <p>
+ * This method was originally defined to retrieve a servlet from
+ * a <code>ServletContext</code>. In this version, this method
+ * always returns <code>null</code> and remains only to preserve
+ * binary compatibility. This method will be permanently removed
+ * in a future version of the Java Servlet API.
+ * <p>
+ * In lieu of this method, servlets can share information using
+ * the <code>ServletContext</code> class and can perform shared
+ * business logic by invoking methods on common non-servlet
+ * classes.
* @deprecated
*/
- @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+ @SuppressWarnings("dep-ann")
+ // Spec API does not use @Deprecated
public Servlet getServlet(String name) throws ServletException;
-
-
-
-
-
-
- /**
- *
- * @deprecated As of Java Servlet API 2.0, with no replacement.
- *
- * <p>This method was originally defined to return an <code>Enumeration</code>
- * of all the servlets known to this servlet context. In this
- * version, this method always returns an empty enumeration and
- * remains only to preserve binary compatibility. This method
- * will be permanently removed in a future version of the Java
- * Servlet API.
- *
+
+ /**
+ * @deprecated As of Java Servlet API 2.0, with no replacement.
+ * <p>
+ * This method was originally defined to return an
+ * <code>Enumeration</code> of all the servlets known to this
+ * servlet context. In this version, this method always returns
+ * an empty enumeration and remains only to preserve binary
+ * compatibility. This method will be permanently removed in a
+ * future version of the Java Servlet API.
* @deprecated
*/
- @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+ @SuppressWarnings("dep-ann")
+ // Spec API does not use @Deprecated
public Enumeration<Servlet> getServlets();
-
-
-
-
-
/**
- * @deprecated As of Java Servlet API 2.1, with no replacement.
- *
- * <p>This method was originally defined to return an
- * <code>Enumeration</code>
- * of all the servlet names known to this context. In this version,
- * this method always returns an empty <code>Enumeration</code> and
- * remains only to preserve binary compatibility. This method will
- * be permanently removed in a future version of the Java Servlet API.
- *
+ * @deprecated As of Java Servlet API 2.1, with no replacement.
+ * <p>
+ * This method was originally defined to return an
+ * <code>Enumeration</code> of all the servlet names known to
+ * this context. In this version, this method always returns an
+ * empty <code>Enumeration</code> and remains only to preserve
+ * binary compatibility. This method will be permanently removed
+ * in a future version of the Java Servlet API.
* @deprecated
*/
- @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+ @SuppressWarnings("dep-ann")
+ // Spec API does not use @Deprecated
public Enumeration<String> getServletNames();
-
-
-
-
-
- /**
- *
- * Writes the specified message to a servlet log file, usually
- * an event log. The name and type of the servlet log file is
- * specific to the servlet container.
- *
- *
- * @param msg a <code>String</code> specifying the
- * message to be written to the log file
- *
+
+ /**
+ * Writes the specified message to a servlet log file, usually an event log.
+ * The name and type of the servlet log file is specific to the servlet
+ * container.
+ *
+ * @param msg
+ * a <code>String</code> specifying the message to be written to
+ * the log file
*/
-
public void log(String msg);
-
-
-
-
/**
- * @deprecated As of Java Servlet API 2.1, use
- * {@link #log(String message, Throwable throwable)}
- * instead.
- *
- * <p>This method was originally defined to write an
- * exception's stack trace and an explanatory error message
- * to the servlet log file.
- *
+ * @deprecated As of Java Servlet API 2.1, use
+ * {@link #log(String message, Throwable throwable)} instead.
+ * <p>
+ * This method was originally defined to write an exception's
+ * stack trace and an explanatory error message to the servlet
+ * log file.
* @deprecated
*/
- @SuppressWarnings("dep-ann") // Spec API does not use @Deprecated
+ @SuppressWarnings("dep-ann")
+ // Spec API does not use @Deprecated
public void log(Exception exception, String msg);
-
-
-
-
-
- /**
- * Writes an explanatory message and a stack trace
- * for a given <code>Throwable</code> exception
- * to the servlet log file. The name and type of the servlet log
- * file is specific to the servlet container, usually an event log.
- *
- *
- * @param message a <code>String</code> that
- * describes the error or exception
- *
- * @param throwable the <code>Throwable</code> error
- * or exception
- *
+
+ /**
+ * Writes an explanatory message and a stack trace for a given
+ * <code>Throwable</code> exception to the servlet log file. The name and
+ * type of the servlet log file is specific to the servlet container,
+ * usually an event log.
+ *
+ * @param message
+ * a <code>String</code> that describes the error or exception
+ * @param throwable
+ * the <code>Throwable</code> error or exception
*/
-
public void log(String message, Throwable throwable);
-
-
-
-
-
- /**
- * Returns a <code>String</code> containing the real path
- * for a given virtual path. For example, the path "/index.html"
- * returns the absolute file path on the server's filesystem would be
- * served by a request for "http://host/contextPath/index.html",
- * where contextPath is the context path of this ServletContext..
- *
- * <p>The real path returned will be in a form
- * appropriate to the computer and operating system on
- * which the servlet container is running, including the
- * proper path separators. This method returns <code>null</code>
- * if the servlet container cannot translate the virtual path
- * to a real path for any reason (such as when the content is
- * being made available from a <code>.war</code> archive).
- *
- *
- * @param path a <code>String</code> specifying a virtual path
- *
- *
- * @return a <code>String</code> specifying the real path,
- * or null if the translation cannot be performed
- *
- *
- */
+ /**
+ * Returns a <code>String</code> containing the real path for a given
+ * virtual path. For example, the path "/index.html" returns the absolute
+ * file path on the server's filesystem would be served by a request for
+ * "http://host/contextPath/index.html", where contextPath is the context
+ * path of this ServletContext..
+ * <p>
+ * The real path returned will be in a form appropriate to the computer and
+ * operating system on which the servlet container is running, including the
+ * proper path separators. This method returns <code>null</code> if the
+ * servlet container cannot translate the virtual path to a real path for
+ * any reason (such as when the content is being made available from a
+ * <code>.war</code> archive).
+ *
+ * @param path
+ * a <code>String</code> specifying a virtual path
+ * @return a <code>String</code> specifying the real path, or null if the
+ * translation cannot be performed
+ */
public String getRealPath(String path);
-
-
-
/**
- * Returns the name and version of the servlet container on which
- * the servlet is running.
- *
- * <p>The form of the returned string is
- * <i>servername</i>/<i>versionnumber</i>.
- * For example, the JavaServer Web Development Kit may return the string
+ * Returns the name and version of the servlet container on which the
+ * servlet is running.
+ * <p>
+ * The form of the returned string is
+ * <i>servername</i>/<i>versionnumber</i>. For example, the JavaServer Web
+ * Development Kit may return the string
* <code>JavaServer Web Dev Kit/1.0</code>.
- *
- * <p>The servlet container may return other optional information
- * after the primary string in parentheses, for example,
+ * <p>
+ * The servlet container may return other optional information after the
+ * primary string in parentheses, for example,
* <code>JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)</code>.
- *
- *
- * @return a <code>String</code> containing at least the
- * servlet container name and version number
- *
+ *
+ * @return a <code>String</code> containing at least the servlet container
+ * name and version number
*/
-
public String getServerInfo();
-
-
-
/**
* Returns a <code>String</code> containing the value of the named
- * context-wide initialization parameter, or <code>null</code> if the
+ * context-wide initialization parameter, or <code>null</code> if the
* parameter does not exist.
- *
- * <p>This method can make available configuration information useful
- * to an entire "web application". For example, it can provide a
- * webmaster's email address or the name of a system that holds
- * critical data.
- *
- * @param name a <code>String</code> containing the name of the
- * parameter whose value is requested
- *
- * @return a <code>String</code> containing at least the
- * servlet container name and version number
- *
+ * <p>
+ * This method can make available configuration information useful to an
+ * entire "web application". For example, it can provide a webmaster's email
+ * address or the name of a system that holds critical data.
+ *
+ * @param name
+ * a <code>String</code> containing the name of the parameter
+ * whose value is requested
+ * @return a <code>String</code> containing at least the servlet container
+ * name and version number
* @see ServletConfig#getInitParameter
*/
-
public String getInitParameter(String name);
-
-
-
/**
* Returns the names of the context's initialization parameters as an
- * <code>Enumeration</code> of <code>String</code> objects, or an
- * empty <code>Enumeration</code> if the context has no initialization
- * parameters.
- *
- * @return an <code>Enumeration</code> of <code>String</code>
- * objects containing the names of the context's
- * initialization parameters
- *
+ * <code>Enumeration</code> of <code>String</code> objects, or an empty
+ * <code>Enumeration</code> if the context has no initialization parameters.
+ *
+ * @return an <code>Enumeration</code> of <code>String</code> objects
+ * containing the names of the context's initialization parameters
* @see ServletConfig#getInitParameter
*/
public Enumeration<String> getInitParameterNames();
-
-
+
/**
- *
* @param name
* @param value
* @return
* @throws IllegalStateException
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public boolean setInitParameter(String name, String value);
-
-
+
/**
- * Returns the servlet container attribute with the given name,
- * or <code>null</code> if there is no attribute by that name.
- * An attribute allows a servlet container to give the
- * servlet additional information not
- * already provided by this interface. See your
- * server documentation for information about its attributes.
- * A list of supported attributes can be retrieved using
- * <code>getAttributeNames</code>.
- *
- * <p>The attribute is returned as a <code>java.lang.Object</code>
- * or some subclass.
- * Attribute names should follow the same convention as package
- * names. The Java Servlet API specification reserves names
- * matching <code>java.*</code>, <code>javax.*</code>,
- * and <code>sun.*</code>.
- *
- *
- * @param name a <code>String</code> specifying the name
- * of the attribute
- *
- * @return an <code>Object</code> containing the value
- * of the attribute, or <code>null</code>
- * if no attribute exists matching the given
- * name
- *
- * @see ServletContext#getAttributeNames
- *
+ * Returns the servlet container attribute with the given name, or
+ * <code>null</code> if there is no attribute by that name. An attribute
+ * allows a servlet container to give the servlet additional information not
+ * already provided by this interface. See your server documentation for
+ * information about its attributes. A list of supported attributes can be
+ * retrieved using <code>getAttributeNames</code>.
+ * <p>
+ * The attribute is returned as a <code>java.lang.Object</code> or some
+ * subclass. Attribute names should follow the same convention as package
+ * names. The Java Servlet API specification reserves names matching
+ * <code>java.*</code>, <code>javax.*</code>, and <code>sun.*</code>.
+ *
+ * @param name
+ * a <code>String</code> specifying the name of the attribute
+ * @return an <code>Object</code> containing the value of the attribute, or
+ * <code>null</code> if no attribute exists matching the given name
+ * @see ServletContext#getAttributeNames
*/
-
public Object getAttribute(String name);
-
-
-
-
- /**
- * Returns an <code>Enumeration</code> containing the
- * attribute names available
- * within this servlet context. Use the
- * {@link #getAttribute} method with an attribute name
- * to get the value of an attribute.
- *
- * @return an <code>Enumeration</code> of attribute
- * names
- *
- * @see #getAttribute
- *
- */
+ /**
+ * Returns an <code>Enumeration</code> containing the attribute names
+ * available within this servlet context. Use the {@link #getAttribute}
+ * method with an attribute name to get the value of an attribute.
+ *
+ * @return an <code>Enumeration</code> of attribute names
+ * @see #getAttribute
+ */
public Enumeration<String> getAttributeNames();
-
-
-
-
- /**
- *
- * Binds an object to a given attribute name in this servlet context. If
- * the name specified is already used for an attribute, this
- * method will replace the attribute with the new to the new attribute.
- * <p>If listeners are configured on the <code>ServletContext</code> the
+
+ /**
+ * Binds an object to a given attribute name in this servlet context. If the
+ * name specified is already used for an attribute, this method will replace
+ * the attribute with the new to the new attribute.
+ * <p>
+ * If listeners are configured on the <code>ServletContext</code> the
* container notifies them accordingly.
* <p>
- * If a null value is passed, the effect is the same as calling
+ * If a null value is passed, the effect is the same as calling
* <code>removeAttribute()</code>.
+ * <p>
+ * Attribute names should follow the same convention as package names. The
+ * Java Servlet API specification reserves names matching
+ * <code>java.*</code>, <code>javax.*</code>, and <code>sun.*</code>.
*
- * <p>Attribute names should follow the same convention as package
- * names. The Java Servlet API specification reserves names
- * matching <code>java.*</code>, <code>javax.*</code>, and
- * <code>sun.*</code>.
- *
- *
- * @param name a <code>String</code> specifying the name
- * of the attribute
- *
- * @param object an <code>Object</code> representing the
- * attribute to be bound
- *
- *
- *
+ * @param name
+ * a <code>String</code> specifying the name of the attribute
+ * @param object
+ * an <code>Object</code> representing the attribute to be bound
*/
-
public void setAttribute(String name, Object object);
-
-
-
-
/**
- * Removes the attribute with the given name from
- * the servlet context. After removal, subsequent calls to
- * {@link #getAttribute} to retrieve the attribute's value
- * will return <code>null</code>.
-
- * <p>If listeners are configured on the <code>ServletContext</code> the
+ * Removes the attribute with the given name from the servlet context. After
+ * removal, subsequent calls to {@link #getAttribute} to retrieve the
+ * attribute's value will return <code>null</code>.
+ * <p>
+ * If listeners are configured on the <code>ServletContext</code> the
* container notifies them accordingly.
-
- *
- *
- * @param name a <code>String</code> specifying the name
- * of the attribute to be removed
- *
+ *
+ * @param name
+ * a <code>String</code> specifying the name of the attribute to
+ * be removed
*/
-
public void removeAttribute(String name);
-
+
/**
- * 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.
- *
- *
- * @return The name of the web application or null if no name has been declared in the deployment descriptor.
+ * 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.
+ *
+ * @return The name of the web application or null if no name has been
+ * declared in the deployment descriptor.
* @since Servlet 2.3
*/
-
public String getServletContextName();
-
/**
- *
* @param servletName
* @param className
- * @throws IllegalStateException If the context has already been
- * initialised
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public ServletRegistration.Dynamic addServlet(String servletName,
String className);
-
-
+
/**
- *
* @param servletName
* @param servlet
- * @throws IllegalStateException If the context has already been
- * initialised
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public ServletRegistration.Dynamic addServlet(String servletName,
Servlet servlet);
-
-
+
/**
- *
* @param servletName
* @param servletClass
- * @throws IllegalStateException If the context has already been
- * initialised
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public ServletRegistration.Dynamic addServlet(String servletName,
Class<? extends Servlet> servletClass);
-
/**
- *
* @param c
* @return
* @throws ServletException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public <T extends Servlet> T createServlet(Class<T> c)
- throws ServletException;
+ throws ServletException;
-
/**
- *
* @param servletName
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public ServletRegistration getServletRegistration(String servletName);
-
-
+
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public Map<String, ? extends ServletRegistration> getServletRegistrations();
-
/**
- *
* @param filterName
* @param className
- * @throws IllegalStateException If the context has already been
- * initialised
- *
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- public FilterRegistration.Dynamic addFilter(String filterName,
+ public FilterRegistration.Dynamic addFilter(String filterName,
String className);
-
-
+
/**
- *
* @param filterName
* @param filter
- * @throws IllegalStateException If the context has already been
- * initialised
- *
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- public FilterRegistration.Dynamic addFilter(String filterName,
- Filter filter);
+ public FilterRegistration.Dynamic addFilter(String filterName, Filter filter);
-
/**
- *
* @param filterName
* @param filterClass
- * @throws IllegalStateException If the context has already been
- * initialised
- *
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @throws IllegalStateException
+ * If the context has already been initialised
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- public FilterRegistration.Dynamic addFilter(String filterName,
+ public FilterRegistration.Dynamic addFilter(String filterName,
Class<? extends Filter> filterClass);
-
/**
- *
* @param c
* @return
* @throws ServletException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public <T extends Filter> T createFilter(Class<T> c)
- throws ServletException;
+ throws ServletException;
-
/**
- *
* @param filterName
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public FilterRegistration getFilterRegistration(String filterName);
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public Map<String, ? extends FilterRegistration> getFilterRegistrations();
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public SessionCookieConfig getSessionCookieConfig();
/**
- *
* @param sessionTrackingModes
- * @throws IllegalArgumentException If sessionTrackingModes specifies
- * {@link SessionTrackingMode#SSL} in
- * combination with any other
- * {@link SessionTrackingMode}
- * @throws IllegalStateException If the context has already been
- * initialised
+ * @throws IllegalArgumentException
+ * If sessionTrackingModes specifies
+ * {@link SessionTrackingMode#SSL} in combination with any other
+ * {@link SessionTrackingMode}
+ * @throws IllegalStateException
+ * If the context has already been initialised
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public void setSessionTrackingModes(
Set<SessionTrackingMode> sessionTrackingModes)
throws IllegalStateException, IllegalArgumentException;
-
+
/**
- *
* @return
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public Set<SessionTrackingMode> getDefaultSessionTrackingModes();
-
+
/**
- *
* @return
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public Set<SessionTrackingMode> getEffectiveSessionTrackingModes();
-
+
/**
- *
* @param listenerClass
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
- public void addListener(Class <? extends EventListener> listenerClass);
-
+ public void addListener(Class<? extends EventListener> listenerClass);
+
/**
- *
* @param className
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public void addListener(String className);
/**
- *
* @param <T>
* @param t
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public <T extends EventListener> void addListener(T t);
-
+
/**
- *
* @param <T>
* @param c
* @return
* @throws ServletException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public <T extends EventListener> T createListener(Class<T> c)
- throws ServletException;
-
+ throws ServletException;
+
/**
- *
* @param roleNames
* @throws UnsupportedOperationException
* @throws IllegalArgumentException
* @throws IllegalStateException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public void declareRoles(String... roleNames);
-
+
/**
- *
* @return
* @throws UnsupportedOperationException
* @throws SecurityException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public ClassLoader getClassLoader();
-
+
/**
- *
* @return
* @throws UnsupportedOperationException
- * @since Servlet 3.0
- * TODO SERVLET3 - Add comments
+ * @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public JspConfigDescriptor getJspConfigDescriptor();
}
Modified: tomcat/trunk/java/javax/servlet/ServletContextAttributeEvent.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContextAttributeEvent.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContextAttributeEvent.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContextAttributeEvent.java Fri Jul 23 15:48:53 2010
@@ -1,60 +1,57 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
+/**
+ * This is the event class for notifications about changes to the attributes of
+ * the servlet context of a web application.
+ *
+ * @see ServletContextAttributeListener
+ * @since v 2.3
+ */
+public class ServletContextAttributeEvent extends ServletContextEvent {
+ private String name;
+ private Object value;
- /**
- * This is the event class for notifications about changes to the attributes of the
- * servlet context of a web application.
- * @see ServletContextAttributeListener
- * @since v 2.3
- */
+ /**
+ * Construct a ServletContextAttributeEvent from the given context for the
+ * given attribute name and attribute value.
+ */
+ public ServletContextAttributeEvent(ServletContext source, String name,
+ Object value) {
+ super(source);
+ this.name = name;
+ this.value = value;
+ }
-public class ServletContextAttributeEvent extends ServletContextEvent {
- private String name;
- private Object value;
+ /**
+ * Return the name of the attribute that changed on the ServletContext.
+ */
+ public String getName() {
+ return this.name;
+ }
- /** Construct a ServletContextAttributeEvent from the given context for the
- ** given attribute name and attribute value.
- */
- public ServletContextAttributeEvent(ServletContext source, String name, Object value) {
- super(source);
- this.name = name;
- this.value = value;
- }
-
- /**
- * Return the name of the attribute that changed on the ServletContext.
- *
- */
- public String getName() {
- return this.name;
- }
-
- /**
- * 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.
- *
- */
-
- public Object getValue() {
- return this.value;
- }
+ /**
+ * 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.
+ */
+ public Object getValue() {
+ return this.value;
+ }
}
-
Modified: tomcat/trunk/java/javax/servlet/ServletContextAttributeListener.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContextAttributeListener.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContextAttributeListener.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContextAttributeListener.java Fri Jul 23 15:48:53 2010
@@ -1,37 +1,49 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
import java.util.EventListener;
- /** Implementations of this interface receive notifications of
- ** changes to the attribute list on the servlet context of a web application.
- * To receive notification events, the implementation class
- * must be configured in the deployment descriptor for the web application.
- * @see ServletContextAttributeEvent
- * @since v 2.3
- */
+/**
+ * Implementations of this interface receive notifications of changes to the
+ * attribute list on the servlet context of a web application. To receive
+ * notification events, the implementation class must be configured in the
+ * deployment descriptor for the web application.
+ *
+ * @see ServletContextAttributeEvent
+ * @since v 2.3
+ */
public interface ServletContextAttributeListener extends EventListener {
- /** Notification that a new attribute was added to the servlet context. Called after the attribute is added.*/
-public void attributeAdded(ServletContextAttributeEvent scab);
- /** Notification that an existing attribute has been removed from the servlet context. Called after the attribute is removed.*/
-public void attributeRemoved(ServletContextAttributeEvent scab);
- /** Notification that an attribute on the servlet context has been replaced. Called after the attribute is replaced. */
-public void attributeReplaced(ServletContextAttributeEvent scab);
-}
+ /**
+ * Notification that a new attribute was added to the servlet context.
+ * Called after the attribute is added.
+ */
+ public void attributeAdded(ServletContextAttributeEvent scab);
+
+ /**
+ * Notification that an existing attribute has been removed from the servlet
+ * context. Called after the attribute is removed.
+ */
+ public void attributeRemoved(ServletContextAttributeEvent scab);
+ /**
+ * Notification that an attribute on the servlet context has been replaced.
+ * Called after the attribute is replaced.
+ */
+ public void attributeReplaced(ServletContextAttributeEvent scab);
+}
Modified: tomcat/trunk/java/javax/servlet/ServletContextEvent.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContextEvent.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContextEvent.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContextEvent.java Fri Jul 23 15:48:53 2010
@@ -1,47 +1,46 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
+/**
+ * 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 {
- /**
- * 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.
- */
+ /**
+ * Construct a ServletContextEvent from the given context.
+ *
+ * @param source
+ * - the ServletContext that is sending the event.
+ */
public ServletContextEvent(ServletContext source) {
- super(source);
+ super(source);
}
-
- /**
- * Return the ServletContext that changed.
- *
- * @return the ServletContext that sent the event.
- */
- public ServletContext getServletContext () {
- return (ServletContext) super.getSource();
+
+ /**
+ * Return the ServletContext that changed.
+ *
+ * @return the ServletContext that sent the event.
+ */
+ public ServletContext getServletContext() {
+ return (ServletContext) super.getSource();
}
-
}
-
Modified: tomcat/trunk/java/javax/servlet/ServletContextListener.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContextListener.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContextListener.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContextListener.java Fri Jul 23 15:48:53 2010
@@ -1,51 +1,46 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
import java.util.EventListener;
- /**
- * 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
- */
+/**
+ * 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
- ** 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 and filters have been destroy()ed before any
- ** ServletContextListeners are notified of context
- ** destruction.
- */
- public void contextDestroyed ( ServletContextEvent sce );
+
+ /**
+ ** 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 and filters have been destroy()ed before any
+ * ServletContextListeners are notified of context destruction.
+ */
+ public void contextDestroyed(ServletContextEvent sce);
}
-
Modified: tomcat/trunk/java/javax/servlet/ServletException.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletException.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletException.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletException.java Fri Jul 23 15:48:53 2010
@@ -1,28 +1,27 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
-
/**
- * Defines a general exception a servlet can throw when it
- * encounters difficulty.
- *
- * @author Various
- * @version $Version$
+ * Defines a general exception a servlet can throw when it encounters
+ * difficulty.
+ *
+ * @author Various
+ * @version $Version$
*/
public class ServletException extends Exception {
@@ -34,53 +33,49 @@ public class ServletException extends Ex
}
/**
- * Constructs a new servlet exception with the
- * specified message. The message can be written
- * to the server log and/or displayed for the user.
- *
- * @param message a <code>String</code>
- * specifying the text of
- * the exception message
+ * Constructs a new servlet exception with the specified message. The
+ * message can be written to the server log and/or displayed for the user.
+ *
+ * @param message
+ * a <code>String</code> specifying the text of the exception
+ * message
*/
public ServletException(String message) {
super(message);
}
/**
- * Constructs a new servlet exception when the servlet
- * needs to throw an exception and include a message
- * about the "root cause" exception that interfered with its
- * normal operation, including a description message.
- *
- * @param message a <code>String</code> containing
- * the text of the exception message
- *
- * @param rootCause the <code>Throwable</code> exception
- * that interfered with the servlet's
- * normal operation, making this servlet
- * exception necessary
+ * Constructs a new servlet exception when the servlet needs to throw an
+ * exception and include a message about the "root cause" exception that
+ * interfered with its normal operation, including a description message.
+ *
+ * @param message
+ * a <code>String</code> containing the text of the exception
+ * message
+ * @param rootCause
+ * the <code>Throwable</code> exception that interfered with the
+ * servlet's normal operation, making this servlet exception
+ * necessary
*/
public ServletException(String message, Throwable rootCause) {
super(message, rootCause);
}
/**
- * Constructs a new servlet exception when the servlet
- * needs to throw an exception and include a message
- * about the "root cause" exception that interfered with its
- * normal operation. The exception's message is based on the localized
- * message of the underlying exception.
- *
- * <p>This method calls the <code>getLocalizedMessage</code> method
- * on the <code>Throwable</code> exception to get a localized exception
- * message. When subclassing <code>ServletException</code>,
- * this method can be overridden to create an exception message
- * designed for a specific locale.
- *
- * @param rootCause the <code>Throwable</code> exception
- * that interfered with the servlet's
- * normal operation, making the servlet exception
- * necessary
+ * Constructs a new servlet exception when the servlet needs to throw an
+ * exception and include a message about the "root cause" exception that
+ * interfered with its normal operation. The exception's message is based on
+ * the localized message of the underlying exception.
+ * <p>
+ * This method calls the <code>getLocalizedMessage</code> method on the
+ * <code>Throwable</code> exception to get a localized exception message.
+ * When subclassing <code>ServletException</code>, this method can be
+ * overridden to create an exception message designed for a specific locale.
+ *
+ * @param rootCause
+ * the <code>Throwable</code> exception that interfered with the
+ * servlet's normal operation, making the servlet exception
+ * necessary
*/
public ServletException(Throwable rootCause) {
super(rootCause);
@@ -88,9 +83,8 @@ public class ServletException extends Ex
/**
* Returns the exception that caused this servlet exception.
- *
- * @return the <code>Throwable</code>
- * that caused this servlet exception
+ *
+ * @return the <code>Throwable</code> that caused this servlet exception
*/
public Throwable getRootCause() {
return getCause();
Modified: tomcat/trunk/java/javax/servlet/ServletInputStream.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletInputStream.java?rev=967140&r1=967139&r2=967140&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletInputStream.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletInputStream.java Fri Jul 23 15:48:53 2010
@@ -1,107 +1,84 @@
/*
-* Licensed to the Apache Software Foundation (ASF) under one or more
-* contributor license agreements. See the NOTICE file distributed with
-* this work for additional information regarding copyright ownership.
-* The ASF licenses this file to You under the Apache License, Version 2.0
-* (the "License"); you may not use this file except in compliance with
-* the License. You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
package javax.servlet;
import java.io.InputStream;
import java.io.IOException;
/**
+ * Provides an input stream for reading binary data from a client request,
+ * including an efficient <code>readLine</code> method for reading data one line
+ * at a time. With some protocols, such as HTTP POST and PUT, a
+ * <code>ServletInputStream</code> object can be used to read data sent from the
+ * client.
+ * <p>
+ * A <code>ServletInputStream</code> object is normally retrieved via the
+ * {@link ServletRequest#getInputStream} method.
+ * <p>
+ * This is an abstract class that a servlet container implements. Subclasses of
+ * this class must implement the <code>java.io.InputStream.read()</code> method.
*
- * Provides an input stream for reading binary data from a client
- * request, including an efficient <code>readLine</code> method
- * for reading data one line at a time. With some protocols, such
- * as HTTP POST and PUT, a <code>ServletInputStream</code>
- * object can be used to read data sent from the client.
- *
- * <p>A <code>ServletInputStream</code> object is normally retrieved via
- * the {@link ServletRequest#getInputStream} method.
- *
- *
- * <p>This is an abstract class that a servlet container implements.
- * Subclasses of this class
- * must implement the <code>java.io.InputStream.read()</code> method.
- *
- *
- * @author Various
- * @version $Version$
- *
- * @see ServletRequest
- *
+ * @author Various
+ * @version $Version$
+ * @see ServletRequest
*/
-
public abstract class ServletInputStream extends InputStream {
-
-
/**
* Does nothing, because this is an abstract class.
- *
*/
protected ServletInputStream() {
// NOOP
}
-
-
-
/**
- *
- * Reads the input stream, one line at a time. Starting at an
- * offset, reads bytes into an array, until it reads a certain number
- * of bytes or reaches a newline character, which it reads into the
- * array as well.
- *
- * <p>This method returns -1 if it reaches the end of the input
- * stream before reading the maximum number of bytes.
- *
- *
- *
- * @param b an array of bytes into which data is read
- *
- * @param off an integer specifying the character at which
- * this method begins reading
- *
- * @param len an integer specifying the maximum number of
- * bytes to read
- *
- * @return an integer specifying the actual number of bytes
- * read, or -1 if the end of the stream is reached
- *
- * @exception IOException if an input or output exception has occurred
- *
+ * Reads the input stream, one line at a time. Starting at an offset, reads
+ * bytes into an array, until it reads a certain number of bytes or reaches
+ * a newline character, which it reads into the array as well.
+ * <p>
+ * This method returns -1 if it reaches the end of the input stream before
+ * reading the maximum number of bytes.
+ *
+ * @param b
+ * an array of bytes into which data is read
+ * @param off
+ * an integer specifying the character at which this method
+ * begins reading
+ * @param len
+ * an integer specifying the maximum number of bytes to read
+ * @return an integer specifying the actual number of bytes read, or -1 if
+ * the end of the stream is reached
+ * @exception IOException
+ * if an input or output exception has occurred
*/
-
public int readLine(byte[] b, int off, int len) throws IOException {
- if (len <= 0) {
- return 0;
- }
- int count = 0, c;
-
- while ((c = read()) != -1) {
- b[off++] = (byte)c;
- count++;
- if (c == '\n' || count == len) {
- break;
- }
- }
- return count > 0 ? count : -1;
+ if (len <= 0) {
+ return 0;
+ }
+ int count = 0, c;
+
+ while ((c = read()) != -1) {
+ b[off++] = (byte) c;
+ count++;
+ if (c == '\n' || count == len) {
+ break;
+ }
+ }
+ return count > 0 ? count : -1;
}
}
-
-
-
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org