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 2014/01/27 20:41:48 UTC
svn commit: r1561806 -
/tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java
Author: markt
Date: Mon Jan 27 19:41:48 2014
New Revision: 1561806
URL: http://svn.apache.org/r1561806
Log:
Fix Javadoc warnings
Modified:
tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java
Modified: tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java?rev=1561806&r1=1561805&r2=1561806&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java (original)
+++ tomcat/tc6.0.x/trunk/java/javax/servlet/http/HttpServletRequest.java Mon Jan 27 19:41:48 2014
@@ -21,21 +21,13 @@ import javax.servlet.ServletRequest;
import java.util.Enumeration;
/**
- *
* Extends the {@link javax.servlet.ServletRequest} interface
* to provide request information for HTTP servlets.
*
* <p>The servlet container creates an <code>HttpServletRequest</code>
* object and passes it as an argument to the servlet's service
* methods (<code>doGet</code>, <code>doPost</code>, etc).
- *
- *
- * @author Various
- * @version $Version$
- *
- *
*/
-
public interface HttpServletRequest extends ServletRequest {
/**
@@ -74,14 +66,10 @@ public interface HttpServletRequest exte
* not authenticated.
*
*/
-
public String getAuthType();
-
-
-
+
/**
- *
* Returns an array containing all of the <code>Cookie</code>
* objects the client sent with this request.
* This method returns <code>null</code> if no cookies were sent.
@@ -89,17 +77,11 @@ public interface HttpServletRequest exte
* @return an array of all the <code>Cookies</code>
* included with this request, or <code>null</code>
* if the request has no cookies
- *
- *
*/
-
public Cookie[] getCookies();
-
-
/**
- *
* Returns the value of the specified request header
* as a <code>long</code> value that represents a
* <code>Date</code> object. Use this method with
@@ -130,16 +112,11 @@ public interface HttpServletRequest exte
* @exception IllegalArgumentException If the header value
* can't be converted
* to a date
- *
*/
-
public long getDateHeader(String name);
-
-
/**
- *
* Returns the value of the specified request header
* as a <code>String</code>. If the request did not include a header
* of the specified name, this method returns <code>null</code>.
@@ -156,16 +133,11 @@ public interface HttpServletRequest exte
* header, or <code>null</code>
* if the request does not
* have a header of that name
- *
*/
-
public String getHeader(String name);
-
-
/**
- *
* Returns all the values of the specified request header
* as an <code>Enumeration</code> of <code>String</code> objects.
*
@@ -189,17 +161,11 @@ public interface HttpServletRequest exte
* enumeration. If
* the container does not allow access to
* header information, return null
- *
*/
-
public Enumeration getHeaders(String name);
-
-
-
/**
- *
* Returns an enumeration of all the header names
* this request contains. If the request has no
* headers, this method returns an empty enumeration.
@@ -215,17 +181,11 @@ public interface HttpServletRequest exte
* if the servlet container does not
* allow servlets to use this method,
* <code>null</code>
- *
- *
*/
-
public Enumeration getHeaderNames();
-
-
/**
- *
* Returns the value of the specified request header
* as an <code>int</code>. If the request does not have a header
* of the specified name, this method returns -1. If the
@@ -246,14 +206,10 @@ public interface HttpServletRequest exte
* can't be converted
* to an <code>int</code>
*/
-
public int getIntHeader(String name);
-
-
/**
- *
* Returns the name of the HTTP method with which this
* request was made, for example, GET, POST, or PUT.
* Same as the value of the CGI variable REQUEST_METHOD.
@@ -262,16 +218,11 @@ public interface HttpServletRequest exte
* specifying the name
* of the method with which
* this request was made
- *
*/
-
public String getMethod();
-
-
/**
- *
* Returns any extra path information associated with
* the URL the client sent when it made this request.
* The extra path information follows the servlet path
@@ -291,16 +242,11 @@ public interface HttpServletRequest exte
* the query string in the request URL;
* or <code>null</code> if the URL does not have
* any extra path information
- *
*/
-
public String getPathInfo();
-
-
/**
- *
* Returns any extra path information after the servlet name
* but before the query string, and translates it to a real
* path. Same as the value of the CGI variable PATH_TRANSLATED.
@@ -312,22 +258,15 @@ public interface HttpServletRequest exte
*
* The web container does not decode this string.
*
- *
* @return a <code>String</code> specifying the
* real path, or <code>null</code> if
* the URL does not have any extra path
* information
- *
- *
*/
-
public String getPathTranslated();
-
-
/**
- *
* Returns the portion of the request URI that indicates the context
* of the request. The context path always comes first in a request
* URI. The path starts with a "/" character but does not end with a "/"
@@ -338,17 +277,11 @@ public interface HttpServletRequest exte
* @return a <code>String</code> specifying the
* portion of the request URI that indicates the context
* of the request
- *
- *
*/
-
public String getContextPath();
-
-
/**
- *
* Returns the query string that is contained in the request
* URL after the path. This method returns <code>null</code>
* if the URL does not have a query string. Same as the value
@@ -358,16 +291,11 @@ public interface HttpServletRequest exte
* string or <code>null</code> if the URL
* contains no query string. The value is not
* decoded by the container.
- *
*/
-
public String getQueryString();
-
-
/**
- *
* Returns the login of the user making this request, if the
* user has been authenticated, or <code>null</code> if the user
* has not been authenticated.
@@ -378,16 +306,11 @@ public interface HttpServletRequest exte
* @return a <code>String</code> specifying the login
* of the user making this request, or <code>null</code>
* if the user login is not known
- *
*/
-
public String getRemoteUser();
-
-
/**
- *
* Returns a boolean indicating whether the authenticated user is included
* in the specified logical "role". Roles and role membership can be
* defined using deployment descriptors. If the user has not been
@@ -400,16 +323,11 @@ public interface HttpServletRequest exte
* the user making this request belongs to a given role;
* <code>false</code> if the user has not been
* authenticated
- *
*/
-
public boolean isUserInRole(String role);
-
-
/**
- *
* Returns a <code>java.security.Principal</code> object containing
* the name of the current authenticated user. If the user has not been
* authenticated, the method returns <code>null</code>.
@@ -418,45 +336,32 @@ public interface HttpServletRequest exte
* the name of the user making this request;
* <code>null</code> if the user has not been
* authenticated
- *
*/
-
public java.security.Principal getUserPrincipal();
-
-
/**
- *
* Returns the session ID specified by the client. This may
* not be the same as the ID of the current valid session
* for this request.
* If the client did not specify a session ID, this method returns
* <code>null</code>.
*
- *
* @return a <code>String</code> specifying the session
* ID, or <code>null</code> if the request did
* not specify a session ID
*
* @see #isRequestedSessionIdValid
- *
*/
-
public String getRequestedSessionId();
-
-
/**
- *
* Returns the part of this request's URL from the protocol
* name up to the query string in the first line of the HTTP request.
* The web container does not decode this String.
* For example:
*
- *
-
* <table summary="Examples of Returned Values">
* <tr align=left><th>First line of HTTP request </th>
* <th> Returned Value</th>
@@ -467,20 +372,16 @@ public interface HttpServletRequest exte
* </table>
*
* <p>To reconstruct an URL with a scheme and host, use
- * {@link HttpUtils#getRequestURL}.
+ * {@link #getRequestURL}.
*
* @return a <code>String</code> containing
* the part of the URL from the
* protocol name up to the query string
- *
- * @see HttpUtils#getRequestURL
- *
*/
-
public String getRequestURI();
+
/**
- *
* Reconstructs the URL the client used to make the request.
* The returned URL contains a protocol, server name, port
* number, and server path, but it does not include query
@@ -495,13 +396,11 @@ public interface HttpServletRequest exte
*
* @return a <code>StringBuffer</code> object containing
* the reconstructed URL
- *
*/
public StringBuffer getRequestURL();
/**
- *
* Returns the part of this request's URL that calls
* the servlet. This path starts with a "/" character
* and includes either the servlet name or a path to
@@ -519,16 +418,11 @@ public interface HttpServletRequest exte
* decoded, or an empty string if the servlet
* used to process the request is matched
* using the "/*" pattern.
- *
*/
-
public String getServletPath();
-
-
/**
- *
* Returns the current <code>HttpSession</code>
* associated with this request or, if there is no
* current session and <code>create</code> is true, returns
@@ -544,9 +438,6 @@ public interface HttpServletRequest exte
* to maintain session integrity and is asked to create a new session
* when the response is committed, an IllegalStateException is thrown.
*
- *
- *
- *
* @param create <code>true</code> to create
* a new session for this request if necessary;
* <code>false</code> to return <code>null</code>
@@ -559,18 +450,11 @@ public interface HttpServletRequest exte
* and the request has no valid session
*
* @see #getSession()
- *
- *
*/
-
public HttpSession getSession(boolean create);
-
-
-
/**
- *
* Returns the current session associated with this request,
* or if the request does not have a session, creates one.
*
@@ -578,18 +462,11 @@ public interface HttpServletRequest exte
* with this request
*
* @see #getSession(boolean)
- *
*/
-
public HttpSession getSession();
-
-
-
-
/**
- *
* Checks whether the requested session ID is still valid.
*
* @return <code>true</code> if this
@@ -600,16 +477,11 @@ public interface HttpServletRequest exte
* @see #getRequestedSessionId
* @see #getSession
* @see HttpSessionContext
- *
*/
-
public boolean isRequestedSessionIdValid();
-
-
/**
- *
* Checks whether the requested session ID came in as a cookie.
*
* @return <code>true</code> if the session ID
@@ -618,16 +490,11 @@ public interface HttpServletRequest exte
*
*
* @see #getSession
- *
*/
-
public boolean isRequestedSessionIdFromCookie();
-
-
/**
- *
* Checks whether the requested session ID came in as part of the
* request URL.
*
@@ -635,27 +502,15 @@ public interface HttpServletRequest exte
* came in as part of a URL; otherwise,
* <code>false</code>
*
- *
* @see #getSession
- *
*/
-
public boolean isRequestedSessionIdFromURL();
-
-
-
/**
- *
* @deprecated As of Version 2.1 of the Java Servlet
* API, use {@link #isRequestedSessionIdFromURL}
* instead.
- *
*/
-
public boolean isRequestedSessionIdFromUrl();
-
-
-
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org