You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@geronimo.apache.org by dj...@apache.org on 2009/06/25 00:05:50 UTC
svn commit: r788194 [2/6] - in
/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet:
./ annotation/ annotation/jaxrs/ http/ http/annotation/
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContext.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContext.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContext.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContext.java Wed Jun 24 22:05:48 2009
@@ -22,427 +22,335 @@
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
+import java.util.EnumSet;
import java.util.Enumeration;
import java.util.Set;
-import java.util.Map;
-import java.util.EnumSet;
/**
- *
* 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/>
* <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.)
- *
+ * and possibly installed via a <code>.war</code> file.)
+ * <p/>
* <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
+ * 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
+ * the information won't be truly global). Use an external resource like
* a database instead.
- *
- * <p>The <code>ServletContext</code> object is contained within
+ * <p/>
+ * <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
- *
+ * @version $Rev$ $Date$
+ * @see Servlet#getServletConfig
+ * @see ServletConfig#getServletContext
*/
public interface ServletContext {
+ /**
+ * @since Servlet 3.0
+ */
+ String TEMPDIR = "javax.servlet.context.tempdir";
+
+ /**
+ * @return context path for this web app or "" for the / context
+ * @since Servlet 2.5
+ */
+ String getContextPath();
/**
- * Returns a <code>ServletContext</code> object that
+ * Returns a <code>ServletContext</code> object that
* corresponds to a specified URL on the server.
- *
+ * <p/>
* <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
+ * 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/>
* <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
*
+ * @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();
-
+ ServletContext getContext(String uripath);
/**
* Returns the major version of the Java Servlet API that this
* servlet container supports. All implementations that comply
- * with Version 2.4 must have this method
- * return the integer 2.
- *
- * @return 2
+ * with Version 3.0 must have this method
+ * return the integer 3.
*
+ * @return 3
*/
-
- public int getMajorVersion();
-
-
+ int getMajorVersion();
/**
* Returns the minor version of the Servlet API that this
* servlet container supports. All implementations that comply
- * with Version 2.4 must have this method
- * return the integer 4.
- *
- * @return 4
+ * with Version 3.0 must have this method
+ * return the integer 0.
*
+ * @return 0
*/
-
- public int getMinorVersion();
-
-
+ int getMinorVersion();
/**
- * Returns the MIME type of the specified file, or <code>null</code> if
+ * 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
- *
+ * @param file a <code>String</code> specifying the name
+ * of a file
+ * @return a <code>String</code> specifying the file's MIME type
+ */
+ 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>
+ * <p/>
+ * /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>
+ * <p/>
+ * 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 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
- */
-
- public Set getResourcePaths(String path);
-
-
+ 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
+ * <p/>
+ * <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.
- *
+ * file system, in a database, or in a <code>.war</code> file.
+ * <p/>
* <p>The servlet container must implement the URL handlers
* and <code>URLConnection</code> objects that are necessary
* to access the resource.
- *
+ * <p/>
* <p>This method returns <code>null</code>
* if no resource is mapped to the pathname.
- *
+ * <p/>
* <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
+ * <p/>
+ * <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
+ * Use a <code>RequestDispatcher</code> instead to include results of
* an execution.
- *
+ * <p/>
* <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;
-
-
+ *
+ * @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
+ * @throws MalformedURLException if the pathname is not given in
+ * the correct form
+ */
+ 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
+ * <p/>
+ * <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.
- *
+ * the specified path.
+ * <p/>
* <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/>
* <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
+ * <p/>
+ * <p>This method is different from
* <code>java.lang.Class.getResourceAsStream</code>,
- * which uses a class loader. This method allows servlet containers
+ * 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
- *
*
+ * @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);
-
-
-
+ 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 <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/>
* <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);
-
-
+ 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
+ * <p/>
+ * <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
+ * A servlet instance can determine its name using
* {@link ServletConfig#getServletName}.
- *
- * <p>This method returns <code>null</code> if the
+ * <p/>
+ * <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
- *
- */
-
- 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.
- *
- */
-
- 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.
- *
+ * @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
+ */
+ RequestDispatcher getNamedDispatcher(String name);
+
+ /**
+ * @deprecated As of Java Servlet API 2.1, with no direct replacement.
+ * <p/>
+ * <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/>
+ * <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.
+ */
+ Servlet getServlet(String name) throws ServletException;
+
+ /**
+ * @deprecated As of Java Servlet API 2.0, with no replacement.
+ * <p/>
+ * <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.
+ */
+ Enumeration<Servlet> getServlets();
+
+ /**
+ * @deprecated As of Java Servlet API 2.1, with no replacement.
+ * <p/>
+ * <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.
*/
-
- public Enumeration getServlets();
-
-
-
-
-
+ Enumeration<String> getServletNames();
/**
- * @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.
- *
- */
-
- public Enumeration getServletNames();
-
-
-
-
-
- /**
- *
* Writes the specified message to a servlet log file, usually
- * an event log. The name and type of the servlet log file is
+ * 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
- *
+ * @param msg a <code>String</code> specifying the
+ * message to be written to the log file
*/
-
- public void log(String msg);
-
-
-
-
+ 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/>
+ * <p>This method was originally defined to write an
+ * exception's stack trace and an explanatory error message
+ * to the servlet log file.
*/
-
- public void log(Exception exception, String msg);
-
-
-
-
+ 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
+ * 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
- *
+ * @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);
-
-
-
-
-
+ void log(String message, Throwable throwable);
+
/**
- * Returns a <code>String</code> containing the real path
+ * 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/>
* <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
@@ -451,68 +359,47 @@
* 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
- *
- *
+ * @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);
-
-
-
+ 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
+ * the servlet is running.
+ * <p/>
+ * <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
+ * <p/>
+ * <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();
-
-
-
+ 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/>
* <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
+ * 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
- *
+ * @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);
-
-
-
+ String getInitParameter(String name);
/**
* Returns the names of the context's initialization parameters as an
@@ -520,19 +407,25 @@
* 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
- *
+ * @return an <code>Enumeration</code> of <code>String</code>
+ * objects containing the names of the context's
+ * initialization parameters
* @see ServletConfig#getInitParameter
*/
+ Enumeration<String> getInitParameterNames();
- public Enumeration getInitParameterNames();
-
-
+ /**
+ * Set the init parameter if it is not already set.
+ *
+ * @param name of the init parameter to set
+ * @param value new value
+ * @return whether it was set
+ * @since 3.0
+ */
+ boolean setInitParameter(String name, String value);
/**
- * Returns the servlet container attribute with the given name,
+ * 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
@@ -540,7 +433,7 @@
* server documentation for information about its attributes.
* A list of supported attributes can be retrieved using
* <code>getAttributeNames</code>.
- *
+ * <p/>
* <p>The attribute is returned as a <code>java.lang.Object</code>
* or some subclass.
* Attribute names should follow the same convention as package
@@ -548,211 +441,212 @@
* 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
- *
+ * @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);
-
-
-
+ Object getAttribute(String name);
/**
- * Returns an <code>Enumeration</code> containing the
+ * 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
- *
+ * @return an <code>Enumeration</code> of attribute
+ * names
+ * @see #getAttribute
*/
+ Enumeration<String> getAttributeNames();
- public Enumeration 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
+ * <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
+ * <p/>
+ * If a null value is passed, the effect is the same as calling
* <code>removeAttribute()</code>.
- *
+ * <p/>
* <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);
-
-
-
-
+ void setAttribute(String name, Object object);
/**
- * Removes the attribute with the given name from
+ * 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
+ * <p/>
+ * <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
*/
+ void removeAttribute(String name);
- 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.
+ * @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();
+ String getServletContextName();
/**
* Add the specified servlet to the context
+ *
* @param servletName servlet's name
- * @param className class name of servlet
+ * @param className class name of servlet
+ * @return ServletRegistration.Dynamic allowing configuration of the servlet
* @throws IllegalArgumentException duplicate servletName
- * @throws IllegalStateException this method called after #initialize
- * @return ServletRegistration allowing configuration of the servlet
- *
+ * @throws IllegalStateException this method called after #initialize
* @since 3.0
*/
- ServletRegistration addServlet(String servletName,
- String className) throws IllegalArgumentException, IllegalStateException;
+ ServletRegistration.Dynamic addServlet(String servletName, String className) throws IllegalArgumentException, IllegalStateException;
/**
* Add the specified servlet to the context
+ *
* @param servletName servlet's name
- * @param clazz class of the servlet
+ * @param servlet servlet instance, perhaps created with createServlet
+ * @return ServletRegistration.Dynamic allowing configuration of the servlet
* @throws IllegalArgumentException duplicate servletName
- * @throws IllegalStateException this method called after #initialize
- * @return ServletRegistration allowing configuration of the servlet
+ * @throws IllegalStateException this method called after #initialize
+ * @since 3.0
+ */
+ ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet) throws IllegalArgumentException, IllegalStateException;
+
+ /**
+ * Add the specified servlet to the context
*
+ * @param servletName servlet's name
+ * @param clazz class of the servlet
+ * @return ServletRegistration.Dynamic allowing configuration of the servlet
+ * @throws IllegalArgumentException duplicate servletName
+ * @throws IllegalStateException this method called after #initialize
* @since 3.0
*/
- ServletRegistration addServlet(String servletName,
- Class<? extends Servlet> clazz) throws IllegalArgumentException, IllegalStateException;
+ ServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> clazz) throws IllegalArgumentException, IllegalStateException;
+
+ /**
+ * Create a servlet with dependencies injected.
+ *
+ * @param clazz servlet class
+ * @return instantiated and injected servlet
+ * @throws ServletException if something goes wrong
+ * @since Servlet 3.0
+ */
+ <T extends Servlet> T createServlet(Class<T> clazz) throws ServletException;
/**
* Fish out the servlet registration for a named servlet
+ *
* @param servletName name of the servlet you want to configure
* @return ServletRegistration for servlet you want
- *
* @since 3.0
*/
ServletRegistration findServletRegistration(String servletName);
/**
* Add a filter to this context
+ *
+ * @param filterName name of filter
+ * @param className class name of filter
+ * @return FilterRegistration.Dynamic allowing configuration of filter
+ * @throws IllegalArgumentException duplicate filter name
+ * @throws IllegalStateException if called after #initialise
+ * @since 3.0
+ */
+ FilterRegistration.Dynamic addFilter(String filterName, String className) throws IllegalArgumentException, IllegalStateException;
+
+ /**
+ * Add a filter to this context
+ *
* @param filterName name of filter
- * @param className class name of filter
+ * @param filter filter instance perhaps from createFilter method
+ * @return FilterRegistration.Dynamic allowing configuration of filter
* @throws IllegalArgumentException duplicate filter name
- * @throws IllegalStateException if called after #initialise
- * @return FilterRegistration allowing configuration of filter
+ * @throws IllegalStateException if called after #initialise
+ * @since 3.0
+ */
+ FilterRegistration.Dynamic addFilter(String filterName, Filter filter) throws IllegalArgumentException, IllegalStateException;
+
+ /**
+ * Add a filter to this context
*
+ * @param filterName name of filter
+ * @param filterClass filter class
+ * @return FilterRegistration.Dynamic allowing configuration of filter
+ * @throws IllegalArgumentException duplicate filter name
+ * @throws IllegalStateException if called after #initialise
* @since 3.0
*/
- FilterRegistration addFilter(String filterName,
- String className) throws IllegalArgumentException, IllegalStateException;
+ FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass) throws IllegalArgumentException, IllegalStateException;
/**
+ * Create a filter with dependencies injected.
*
+ * @param clazz filter class
+ * @return instantiated and injected filter
+ * @throws ServletException if something goes wrong
+ * @since Servlet 3.0
+ */
+ <T extends Filter> T createFilter(Class<T> clazz) throws ServletException;
+
+ /**
* @param filterName Name of filter you want to configure
* @return FilterRegistration allowing configuration of filter
- *
* @since 3.0
*/
FilterRegistration findFilterRegistration(String filterName);
/**
- *
* @param sessionCookieConfig configuration of session cookie
- *
* @since 3.0
*/
void setSessionCookieConfig(SessionCookieConfig sessionCookieConfig);
/**
- *
* @return configuration of session cookie
- *
* @since 3.0
*/
SessionCookieConfig getSessionCookieConfig();
/**
- *
* @param sessionTrackingModes set of SessionTrackingModes for this web app
- *
* @since 3.0
*/
void setSessionTrackingModes(EnumSet<SessionTrackingMode> sessionTrackingModes);
/**
- *
* @return the default session tracking modes
- *
* @since 3.0
*/
EnumSet<SessionTrackingMode> getDefaultSessionTrackingModes();
/**
- *
* @return the actual session tracking modes. These will be the default ones unless they've been explicitly set.
- *
* @since 3.0
*/
EnumSet<SessionTrackingMode> getEffectiveSessionTrackingModes();
- /**
- *
- * @param name of the init parameter to set
- * @param value new value
- * @return whether it was set??
- * @since 3.0
- */
- boolean setInitParameter(String name, String value);
-
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeEvent.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeEvent.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeEvent.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeEvent.java Wed Jun 24 22:05:48 2009
@@ -19,45 +19,46 @@
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;
-
- /** 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;
- }
+/**
+ * This is the event class for notifications about changes to the attributes of the
+ * servlet context of a web application.
+ *
+ * @version $Rev$ $Date$
+ * @see ServletContextAttributeListener
+ * @since v 2.3
+ */
+
+public class ServletContextAttributeEvent extends ServletContextEvent {
+ private final String name;
+ private final Object value;
+
+ /**
+ * 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.
+ * @return name of the changed attribute
+ */
+ public String getName() {
+ return 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.
+ * @return value of the changed attribute
+ */
+ public Object getValue() {
+ return value;
+ }
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeListener.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeListener.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeListener.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextAttributeListener.java Wed Jun 24 22:05:48 2009
@@ -21,20 +21,30 @@
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.
+ *
+ * @version $Rev$ $Date$
+ * @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.
+ */
+ void attributeAdded(ServletContextAttributeEvent scab);
+
+ /**
+ * Notification that an existing attribute has been removed from the servlet context. Called after the attribute is removed.
+ */
+ void attributeRemoved(ServletContextAttributeEvent scab);
+
+ /**
+ * Notification that an attribute on the servlet context has been replaced. Called after the attribute is replaced.
+ */
+ void attributeReplaced(ServletContextAttributeEvent scab);
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextEvent.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextEvent.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextEvent.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextEvent.java Wed Jun 24 22:05:48 2009
@@ -20,31 +20,34 @@
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 {
-
- /** Construct a ServletContextEvent from the given context.
- *
- * @param source - the ServletContext that is sending the event.
- */
+/**
+ * This is the event class for notifications about changes to
+ * the servlet context of a web application.
+ *
+ * @version $Rev$ $Date$
+ * @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.
+ */
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: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextListener.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextListener.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextListener.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletContextListener.java Wed Jun 24 22:05:48 2009
@@ -21,34 +21,37 @@
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.
+ *
+ * @version $Rev$ $Date$
+ * @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.
+ */
+ 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.
+ */
+ void contextDestroyed(ServletContextEvent sce);
+
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletException.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletException.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletException.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletException.java Wed Jun 24 22:05:48 2009
@@ -25,7 +25,7 @@
* encounters difficulty.
*
* @author Various
- * @version $Version$
+ * @version $Rev$ $Date$
*/
public class ServletException extends Exception {
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletInputStream.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletInputStream.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletInputStream.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletInputStream.java Wed Jun 24 22:05:48 2009
@@ -19,90 +19,71 @@
package javax.servlet;
-import java.io.InputStream;
import java.io.IOException;
+import java.io.InputStream;
/**
- *
* 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/>
* <p>A <code>ServletInputStream</code> object is normally retrieved via
* the {@link ServletRequest#getInputStream} method.
- *
- *
+ * <p/>
+ * <p/>
* <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
- *
+ * @version $Rev$ $Date$
+ * @see ServletRequest
*/
public abstract class ServletInputStream extends InputStream {
-
-
/**
* Does nothing, because this is an abstract class.
- *
*/
+ protected ServletInputStream() {
+ }
- protected ServletInputStream() { }
-
-
-
-
/**
- *
* 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/>
* <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
- *
+ * @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
+ * @throws IOException if an input or output exception has occurred
+ * @return an integer specifying the actual number of bytes
+ * read, or -1 if the end of the stream is reached
*/
-
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;
}
+
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletOutputStream.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletOutputStream.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletOutputStream.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletOutputStream.java Wed Jun 24 22:05:48 2009
@@ -27,341 +27,237 @@
/**
* Provides an output stream for sending binary data to the
- * client. A <code>ServletOutputStream</code> object is normally retrieved
+ * client. A <code>ServletOutputStream</code> object is normally retrieved
* via the {@link ServletResponse#getOutputStream} method.
- *
+ * <p/>
* <p>This is an abstract class that the servlet container implements.
* Subclasses of this class
* must implement the <code>java.io.OutputStream.write(int)</code>
* method.
*
- *
- * @author Various
- * @version $Version$
- *
- * @see ServletResponse
- *
+ * @version $Rev$ $Date$
+ * @see ServletResponse
*/
public abstract class ServletOutputStream extends OutputStream {
private static final String LSTRING_FILE = "javax.servlet.LocalStrings";
- private static ResourceBundle lStrings =
- ResourceBundle.getBundle(LSTRING_FILE);
-
+ private static ResourceBundle lStrings = ResourceBundle.getBundle(LSTRING_FILE);
-
/**
- *
* Does nothing, because this is an abstract class.
- *
*/
-
- protected ServletOutputStream() { }
-
+ protected ServletOutputStream() {
+ }
/**
- * Writes a <code>String</code> to the client,
- * without a carriage return-line feed (CRLF)
+ * Writes a <code>String</code> to the client,
+ * without a carriage return-line feed (CRLF)
* character at the end.
*
- *
- * @param s the <code>String</code> to send to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param s the <code>String</code> to send to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void print(String s) throws IOException {
- if (s==null) s="null";
- int len = s.length();
- for (int i = 0; i < len; i++) {
- char c = s.charAt (i);
-
- //
- // XXX NOTE: This is clearly incorrect for many strings,
- // but is the only consistent approach within the current
- // servlet framework. It must suffice until servlet output
- // streams properly encode their output.
- //
- if ((c & 0xff00) != 0) { // high order byte must be zero
- String errMsg = lStrings.getString("err.not_iso8859_1");
- Object[] errArgs = new Object[1];
- errArgs[0] = new Character(c);
- errMsg = MessageFormat.format(errMsg, errArgs);
- throw new CharConversionException(errMsg);
- }
- write (c);
- }
+ if (s == null) s = "null";
+ int len = s.length();
+ for (int i = 0; i < len; i++) {
+ char c = s.charAt(i);
+
+ //
+ // XXX NOTE: This is clearly incorrect for many strings,
+ // but is the only consistent approach within the current
+ // servlet framework. It must suffice until servlet output
+ // streams properly encode their output.
+ //
+ if ((c & 0xff00) != 0) { // high order byte must be zero
+ String errMsg = lStrings.getString("err.not_iso8859_1");
+ Object[] errArgs = new Object[1];
+ errArgs[0] = c;
+ errMsg = MessageFormat.format(errMsg, errArgs);
+ throw new CharConversionException(errMsg);
+ }
+ write(c);
+ }
}
-
-
/**
* Writes a <code>boolean</code> value to the client,
- * with no carriage return-line feed (CRLF)
+ * with no carriage return-line feed (CRLF)
* character at the end.
*
- * @param b the <code>boolean</code> value
- * to send to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param b the <code>boolean</code> value
+ * to send to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void print(boolean b) throws IOException {
- String msg;
- if (b) {
- msg = lStrings.getString("value.true");
- } else {
- msg = lStrings.getString("value.false");
- }
- print(msg);
+ String msg;
+ if (b) {
+ msg = lStrings.getString("value.true");
+ } else {
+ msg = lStrings.getString("value.false");
+ }
+ print(msg);
}
-
-
/**
* Writes a character to the client,
- * with no carriage return-line feed (CRLF)
+ * with no carriage return-line feed (CRLF)
* at the end.
*
- * @param c the character to send to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param c the character to send to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void print(char c) throws IOException {
- print(String.valueOf(c));
+ print(String.valueOf(c));
}
-
-
-
/**
- *
* Writes an int to the client,
- * with no carriage return-line feed (CRLF)
+ * with no carriage return-line feed (CRLF)
* at the end.
*
- * @param i the int to send to the client
- *
- * @exception IOException if an input or output exception occurred
- *
- */
-
+ * @param i the int to send to the client
+ * @throws IOException if an input or output exception occurred
+ */
public void print(int i) throws IOException {
- print(String.valueOf(i));
+ print(String.valueOf(i));
}
-
-
-
/**
- *
* Writes a <code>long</code> value to the client,
* with no carriage return-line feed (CRLF) at the end.
*
- * @param l the <code>long</code> value
- * to send to the client
- *
- * @exception IOException if an input or output exception
- * occurred
- *
+ * @param l the <code>long</code> value
+ * to send to the client
+ * @throws IOException if an input or output exception
+ * occurred
*/
-
public void print(long l) throws IOException {
- print(String.valueOf(l));
+ print(String.valueOf(l));
}
-
-
/**
- *
* Writes a <code>float</code> value to the client,
* with no carriage return-line feed (CRLF) at the end.
*
- * @param f the <code>float</code> value
- * to send to the client
- *
- * @exception IOException if an input or output exception occurred
- *
- *
+ * @param f the <code>float</code> value
+ * to send to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void print(float f) throws IOException {
- print(String.valueOf(f));
+ print(String.valueOf(f));
}
-
-
/**
- *
* Writes a <code>double</code> value to the client,
* with no carriage return-line feed (CRLF) at the end.
- *
- * @param d the <code>double</code> value
- * to send to the client
- *
- * @exception IOException if an input or output exception occurred
*
+ * @param d the <code>double</code> value
+ * to send to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void print(double d) throws IOException {
- print(String.valueOf(d));
+ print(String.valueOf(d));
}
-
-
/**
* Writes a carriage return-line feed (CRLF)
* to the client.
*
- *
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @throws IOException if an input or output exception occurred
*/
-
public void println() throws IOException {
- print("\r\n");
+ print("\r\n");
}
-
-
/**
- * Writes a <code>String</code> to the client,
+ * Writes a <code>String</code> to the client,
* followed by a carriage return-line feed (CRLF).
*
- *
- * @param s the <code>String</code> to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param s the <code>String</code> to write to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void println(String s) throws IOException {
- print(s);
- println();
+ print(s);
+ println();
}
-
-
-
/**
- *
- * Writes a <code>boolean</code> value to the client,
- * followed by a
+ * Writes a <code>boolean</code> value to the client,
+ * followed by a
* carriage return-line feed (CRLF).
*
- *
- * @param b the <code>boolean</code> value
- * to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param b the <code>boolean</code> value
+ * to write to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void println(boolean b) throws IOException {
- print(b);
- println();
+ print(b);
+ println();
}
-
-
/**
- *
* Writes a character to the client, followed by a carriage
* return-line feed (CRLF).
*
- * @param c the character to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param c the character to write to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void println(char c) throws IOException {
- print(c);
- println();
+ print(c);
+ println();
}
-
-
/**
- *
- * Writes an int to the client, followed by a
+ * Writes an int to the client, followed by a
* carriage return-line feed (CRLF) character.
*
- *
- * @param i the int to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param i the int to write to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void println(int i) throws IOException {
- print(i);
- println();
+ print(i);
+ println();
}
-
-
- /**
- *
- * Writes a <code>long</code> value to the client, followed by a
+ /**
+ * Writes a <code>long</code> value to the client, followed by a
* carriage return-line feed (CRLF).
*
- *
- * @param l the <code>long</code> value to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
- */
-
+ * @param l the <code>long</code> value to write to the client
+ * @throws IOException if an input or output exception occurred
+ */
public void println(long l) throws IOException {
- print(l);
- println();
+ print(l);
+ println();
}
-
-
/**
- *
- * Writes a <code>float</code> value to the client,
+ * Writes a <code>float</code> value to the client,
* followed by a carriage return-line feed (CRLF).
*
- * @param f the <code>float</code> value
- * to write to the client
- *
- *
- * @exception IOException if an input or output exception
- * occurred
- *
+ * @param f the <code>float</code> value
+ * to write to the client
+ * @throws IOException if an input or output exception
+ * occurred
*/
-
public void println(float f) throws IOException {
- print(f);
- println();
+ print(f);
+ println();
}
-
-
/**
- *
- * Writes a <code>double</code> value to the client,
+ * Writes a <code>double</code> value to the client,
* followed by a carriage return-line feed (CRLF).
*
- *
- * @param d the <code>double</code> value
- * to write to the client
- *
- * @exception IOException if an input or output exception occurred
- *
+ * @param d the <code>double</code> value
+ * to write to the client
+ * @throws IOException if an input or output exception occurred
*/
-
public void println(double d) throws IOException {
- print(d);
- println();
+ print(d);
+ println();
}
+
}
Modified: geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletRegistration.java
URL: http://svn.apache.org/viewvc/geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletRegistration.java?rev=788194&r1=788193&r2=788194&view=diff
==============================================================================
--- geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletRegistration.java (original)
+++ geronimo/specs/trunk/geronimo-servlet_3.0_spec/src/main/java/javax/servlet/ServletRegistration.java Wed Jun 24 22:05:48 2009
@@ -20,24 +20,17 @@
package javax.servlet;
-import java.util.Map;
-
/**
* @version $Rev$ $Date$
* @since 3.0
*/
-public interface ServletRegistration {
-
- boolean setDescription(String description);
-
- void setAsyncSupported(boolean asyncSupported);
-
- void setLoadOnStartup(int loadOnStartup);
+public interface ServletRegistration extends Registration {
void addMapping(String... urlPatterns);
- boolean setInitParameter(String name, String value);
-
- void setInitParameters(Map<String, String> initParameters);
+ public interface Dynamic extends ServletRegistration, Registration.Dynamic {
+ void setLoadOnStartup(int loadOnStartup);
+
+ }
}