|
Glassfish example source code file (HttpServletRequest.java)
The Glassfish HttpServletRequest.java source code/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html * or packager/legal/LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at packager/legal/LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. * * * This file incorporates work covered by the following copyright and * permission notice: * * Copyright 2004 The Apache Software Foundation * * Licensed 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.http; import java.io.IOException; import java.util.*; import javax.servlet.ServletException; import javax.servlet.ServletRequest; /** * * Extends the {@link javax.servlet.ServletRequest} interface * to provide request information for HTTP servlets. * * <p>The servlet container creates an | First line of HTTP request | POST /some/path.html HTTP/1.1 | /some/path.html * <tr> | GET http://foo.bar/a.html HTTP/1.0 * <td> | /a.html * <tr> | HEAD /xyz?a=b HTTP/1.1 | /xyz
* </table>
*
* <p>To reconstruct an URL with a scheme and host, use
* {@link HttpUtils#getRequestURL}.
*
* @return a <code>String 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
* string parameters.
*
* <p>If this request has been forwarded using
* {@link javax.servlet.RequestDispatcher#forward}, the server path in the
* reconstructed URL must reflect the path used to obtain the
* RequestDispatcher, and not the server path specified by the client.
*
* <p>Because this method returns a StringBuffer ,
* not a string, you can modify the URL easily, for example,
* to append query parameters.
*
* <p>This method is useful for creating redirect messages
* and for reporting errors.
*
* @return a <code>StringBuffer 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
* the servlet, but does not include any extra path
* information or a query string. Same as the value of
* the CGI variable SCRIPT_NAME.
*
* <p>This method will return an empty string ("") if the
* servlet used to process this request was matched using
* the "/*" pattern.
*
* @return a <code>String containing
* the name or path of the servlet being
* called, as specified in the request URL,
* 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
* associated with this request or, if there is no
* current session and <code>create is true, returns
* a new session.
*
* <p>If create is false
* and the request has no valid <code>HttpSession,
* this method returns <code>null.
*
* <p>To make sure the session is properly maintained,
* you must call this method before
* the response is committed. If the container is using cookies
* 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 to create
* a new session for this request if necessary;
* <code>false to return null
* if there's no current session
*
*
* @return the <code>HttpSession associated
* with this request or <code>null if
* <code>create is false
* 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.
*
* @return the <code>HttpSession associated
* with this request
*
* @see #getSession(boolean)
*
*/
public HttpSession getSession();
/**
*
* Checks whether the requested session ID is still valid.
*
* <p>If the client did not specify any session ID, this method returns
* <code>false.
*
* @return <code>true if this
* request has an id for a valid session
* in the current session context;
* <code>false otherwise
*
* @see #getRequestedSessionId
* @see #getSession
* @see HttpSessionContext
*
*/
public boolean isRequestedSessionIdValid();
/**
*
* Checks whether the requested session ID came in as a cookie.
*
* @return <code>true if the session ID
* came in as a
* cookie; otherwise, <code>false
*
*
* @see #getSession
*
*/
public boolean isRequestedSessionIdFromCookie();
/**
*
* Checks whether the requested session ID came in as part of the
* request URL.
*
* @return <code>true if the session ID
* came in as part of a URL; otherwise,
* <code>false
*
*
* @see #getSession
*
*/
public boolean isRequestedSessionIdFromURL();
/**
*
* @deprecated As of Version 2.1 of the Java Servlet
* API, use {@link #isRequestedSessionIdFromURL}
* instead.
*
*/
public boolean isRequestedSessionIdFromUrl();
/**
* Use the container login mechanism configured for the
* <code>ServletContext to authenticate the user making
* this request.
*
* <p>This method may modify and commit the argument
* <code>HttpServletResponse.
*
* @param response The <code>HttpServletResponse
* associated with this <code>HttpServletRequest
*
* @return <code>true when non-null values were or have been
* established as the values returned by <code>getUserPrincipal,
* <code>getRemoteUser, and getAuthType . Return
* <code>false if authentication is incomplete and the underlying
* login mechanism has committed, in the response, the message (e.g.,
* challenge) and HTTP status code to be returned to the user.
*
* @throws IOException if an input or output error occurred while
* reading from this request or writing to the given response
*
* @throws IllegalStateException if the login mechanism attempted to
* modify the response and it was already committed
*
* @throws ServletException if the authentication failed and
* the caller is responsible for handling the error (i.e., the
* underlying login mechanism did NOT establish the message and
* HTTP status code to be returned to the user)
*
* @since Servlet 3.0
*/
public boolean authenticate(HttpServletResponse response)
throws IOException,ServletException;
/**
* Validate the provided username and password in the password validation
* realm used by the web container login mechanism configured for the
* <code>ServletContext.
*
* <p>This method returns without throwing a ServletException
* when the login mechanism configured for the <code>ServletContext
* supports username password validation, and when, at the time of the
* call to login, the identity of the caller of the request had
* not been established (i.e, all of <code>getUserPrincipal,
* <code>getRemoteUser, and getAuthType return null),
* and when validation of the provided credentials is successful.
* Otherwise, this method throws a <code>ServletException as
* described below.
*
* <p>When this method returns without throwing an exception, it must
* have established non-null values as the values returned by
* <code>getUserPrincipal, getRemoteUser , and
* <code>getAuthType.
*
* @param username The <code>String value corresponding to
* the login identifier of the user.
*
* @param password The password <code>String corresponding
* to the identified user.
*
* @exception ServletException if the configured login mechanism
* does not support username
* password authentication, or if a
* non-null caller identity had
* already been established (prior
* to the call to login), or if
* validation of the provided
* username and password fails.
*
* @since Servlet 3.0
*/
public void login(String username, String password)
throws ServletException;
/**
* Establish <code>null as the value returned when
* <code>getUserPrincipal, getRemoteUser ,
* and <code>getAuthType is called on the request.
*
* @exception ServletException if logout fails
*
* @since Servlet 3.0
*/
public void logout() throws ServletException;
/**
* Gets all the {@link Part} components of this request, provided
* that it is of type <tt>multipart/form-data.
*
* <p>If this request is of type multipart/form-data, but
* does not contain any Part components, the returned
* <tt>Collection will be empty.
*
* <p>Any changes to the returned Collection must not
* affect this <code>HttpServletRequest.
*
* @return a (possibly empty) <code>Collection of the
* Part components of this request
*
* @throws IOException if an I/O error occurred during the retrieval
* of the {@link Part} components of this request
*
* @throws ServletException if this request is not of type
* <tt>multipart/form-data
*
* @throws IllegalStateException if the request body is larger than
* <tt>maxRequestSize, or any Part in the request is larger than
* <tt>maxFileSize
*
* @see javax.servlet.annotation.MultipartConfig#maxFileSize
* @see javax.servlet.annotation.MultipartConfig#maxRequestSize
*
* @since Servlet 3.0
*/
public Collection<Part> getParts() throws IOException, ServletException;
/**
* Gets the {@link Part} with the given name.
*
* @param name the name of the requested Part
*
* @return The Part with the given name, or <tt>null if this
* request is of type <tt>multipart/form-data, but does not
* contain the requested Part
*
* @throws IOException if an I/O error occurred during the retrieval
* of the requested Part
* @throws ServletException if this request is not of type
* <tt>multipart/form-data
* @throws IllegalStateException if the request body is larger than
* <tt>maxRequestSize, or any Part in the request is larger than
* <tt>maxFileSize
*
* @see javax.servlet.annotation.MultipartConfig#maxFileSize
* @see javax.servlet.annotation.MultipartConfig#maxRequestSize
*
* @since Servlet 3.0
*/
public Part getPart(String name) throws IOException, ServletException;
}
Other Glassfish examples (source code examples)Here is a short list of links related to this Glassfish HttpServletRequest.java source code file: |
---|
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.