Java Servlets – Client HTTP Request

java servlets client http request

In this guide we will discuss about client http request of java servlets. When a browser requests for a web page, it sends lot of information to the web server which cannot be read directly because this information travel as a part of header of HTTP request. You can check HTTP Protocol for more information on this.

Following is the important header information which comes from browser side and you would use very frequently in web programming −

Sr.No.Header & Description
1AcceptThis header specifies the MIME types that the browser or other clients can handle. Values of image/png or image/jpeg are the two most common possibilities.
2Accept-CharsetThis header specifies the character sets the browser can use to display the information. For example ISO-8859-1.
3Accept-EncodingThis header specifies the types of encodings that the browser knows how to handle. Values of gzip or compress are the two most common possibilities.
4Accept-LanguageThis header specifies the client’s preferred languages in case the servlet can produce results in more than one language. For example en, en-us, ru, etc
5AuthorizationThis header is used by clients to identify themselves when accessing password-protected Web pages.
6ConnectionThis header indicates whether the client can handle persistent HTTP connections. Persistent connections permit the client or other browser to retrieve multiple files with a single request. A value of Keep-Alive means that persistent connections should be used.
7Content-LengthThis header is applicable only to POST requests and gives the size of the POST data in bytes.
8CookieThis header returns cookies to servers that previously sent them to the browser.
9HostThis header specifies the host and port as given in the original URL.
10If-Modified-SinceThis header indicates that the client wants the page only if it has been changed after the specified date. The server sends a code, 304 which means Not Modified header if no newer result is available.
11If-Unmodified-SinceThis header is the reverse of If-Modified-Since; it specifies that the operation should succeed only if the document is older than the specified date.
12RefererThis header indicates the URL of the referring Web page. For example, if you are at Web page 1 and click on a link to Web page 2, the URL of Web page 1 is included in the Referrer header when the browser requests Web page 2.
13User-AgentThis header identifies the browser or other client making the request and can be used to return different content to different types of browsers.

Methods to read HTTP Header

There are following methods which can be used to read HTTP header in your servlet program. These methods are available with HttpServletRequest object

Sr.No.Method & Description
1Cookie[] getCookies()Returns an array containing all of the Cookie objects the client sent with this request.
2Enumeration getAttributeNames()Returns an Enumeration containing the names of the attributes available to this request.
3Enumeration getHeaderNames()Returns an enumeration of all the header names this request contains.
4Enumeration getParameterNames()Returns an Enumeration of String objects containing the names of the parameters contained in this request
5HttpSession getSession()Returns the current session associated with this request, or if the request does not have a session, creates one.
6HttpSession getSession(boolean create)Returns the current HttpSession associated with this request or, if if there is no current session and value of create is true, returns a new session.
7Locale getLocale()Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
8Object getAttribute(String name)Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
9ServletInputStream getInputStream()Retrieves the body of the request as binary data using a ServletInputStream.
10String getAuthType()Returns the name of the authentication scheme used to protect the servlet, for example, “BASIC” or “SSL,” or null if the JSP was not protected.
11String getCharacterEncoding()Returns the name of the character encoding used in the body of this request.
12String getContentType()Returns the MIME type of the body of the request, or null if the type is not known.
13String getContextPath()Returns the portion of the request URI that indicates the context of the request.
14String getHeader(String name)Returns the value of the specified request header as a String.
15String getMethod()Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
16String getParameter(String name)Returns the value of a request parameter as a String, or null if the parameter does not exist.
17String getPathInfo()Returns any extra path information associated with the URL the client sent when it made this request
18String getProtocol()Returns the name and version of the protocol the request.
19String getQueryString()Returns the query string that is contained in the request URL after the path.
20String getRemoteAddr()Returns the Internet Protocol (IP) address of the client that sent the request.
21String getRemoteHost()Returns the fully qualified name of the client that sent the request.
22String getRemoteUser()Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
23String getRequestURI()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.
24String getRequestedSessionId()Returns the session ID specified by the client.
25String getServletPath()Returns the part of this request’s URL that calls the JSP.
26String[] getParameterValues(String name)Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
27boolean isSecure()Returns a Boolean indicating whether this request was made using a secure channel, such as HTTPS.
28int getContentLength()Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
29int getIntHeader(String name)Returns the value of the specified request header as an int.
30int getServerPort()Returns the port number on which this request was received.

HTTP Header Request Example

Following is the example which uses getHeaderNames() method of HttpServletRequest to read the HTTP header information. This method returns an Enumeration that contains the header information associated with the current HTTP request.

Once we have an Enumeration, we can loop down the Enumeration in the standard manner, using hasMoreElements() method to determine when to stop and using nextElement() method to get each parameter name

// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;
 
// Extend HttpServlet class
public class DisplayHeader extends HttpServlet {
 
   // Method to handle GET method request.
   public void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
      
      // Set response content type
      response.setContentType("text/html");
 
      PrintWriter out = response.getWriter();
      String title = "HTTP Header Request Example";
      String docType =
         "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n";

      out.println(docType +
         "<html>\n" +
         "<head><title>" + title + "</title></head>\n"+
         "<body bgcolor = \"#f0f0f0\">\n" +
         "<h1 align = \"center\">" + title + "</h1>\n" +
         "<table width = \"100%\" border = \"1\" align = \"center\">\n" +
         "<tr bgcolor = \"#949494\">\n" +
         "<th>Header Name</th><th>Header Value(s)</th>\n"+
         "</tr>\n"
      );
 
      Enumeration headerNames = request.getHeaderNames();
    
      while(headerNames.hasMoreElements()) {
         String paramName = (String)headerNames.nextElement();
         out.print("<tr><td>" + paramName + "</td>\n");
         String paramValue = request.getHeader(paramName);
         out.println("<td> " + paramValue + "</td></tr>\n");
      }
      out.println("</table>\n</body></html>");
   }
   
   // Method to handle POST method request.
   public void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {

      doGet(request, response);
   }
}

Now calling the above servlet would generate the following result −

                               HTTP Header Request Example
Header Name          Header Value(s)
accept:                */*
accept-language:      en-us
user-agent:           Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1;Trident/4.0;                        
                      InfoPath.2; MS-RTC LM 8)    
accept-encoding:      gzip, deflatehostlocalhost:8080connectionKeep-Alivecache-controlno- 
                      cache

Next Topic : Click Here

This Post Has One Comment

Leave a Reply