Class HttpRequest

java.lang.Object
ee.jakarta.tck.ws.rs.common.webclient.http.HttpRequest
Direct Known Subclasses:
AdaptiveHttpRequest, ApacheRequestAdapter

public class HttpRequest extends Object
Represents an HTTP client Request
  • Field Details

    • DEFAULT_HTTP_PORT

      public static int DEFAULT_HTTP_PORT
      Default HTTP port.
    • DEFAULT_SSL_PORT

      public static final int DEFAULT_SSL_PORT
      Default HTTP SSL port.
      See Also:
    • NO_AUTHENTICATION

      public static final int NO_AUTHENTICATION
      No authentication
      See Also:
    • BASIC_AUTHENTICATION

      public static final int BASIC_AUTHENTICATION
      Basic authentication
      See Also:
    • DIGEST_AUTHENTICATION

      public static final int DIGEST_AUTHENTICATION
      Digest authenctication
      See Also:
    • client

      protected org.apache.commons.httpclient.HttpClient client
  • Constructor Details

    • HttpRequest

      public HttpRequest(String requestLine, String host, int port)
      Creates new HttpRequest based of the passed request line. The request line provied must be in the form of:
           METHOD PATH HTTP-VERSION
           Ex.  GET /index.html HTTP/1.0
       
  • Method Details

    • getRequestPath

      public String getRequestPath()
      getRequestPath returns the request path for this particular request.
      Returns:
      String request path
    • getRequestMethod

      public String getRequestMethod()
      getRequestMethod returns the request type, i.e., GET, POST, etc.
      Returns:
      String request type
    • isSecureRequest

      public boolean isSecureRequest()
      isSecureConnection() indicates if the Request is secure or not.
      Returns:
      boolean whether Request is using SSL or not.
    • setSecureRequest

      public void setSecureRequest(boolean secure)
      setSecureRequest configures this request to use SSL.
      Parameters:
      secure - - whether the Request uses SSL or not.
    • setContent

      public void setContent(String content)
      setContent will set the body for this request. Note, this is only valid for POST and PUT operations, however, if called and the request represents some other HTTP method, it will be no-op'd.
      Parameters:
      content - request content
    • setAuthenticationCredentials

      public void setAuthenticationCredentials(String username, String password, int authType, String realm)
      setAuthenticationCredentials configures the request to perform authentication.

      username and password cannot be null.

      It is legal for realm to be null.

      Parameters:
      username - the user
      password - the user's password
      authType - authentication type
      realm - authentication realm
    • addRequestHeader

      public void addRequestHeader(String headerName, String headerValue)
      addRequestHeader adds a request header to this request. If a request header of the same name already exists, the new value, will be added to the set of already existing values. NOTE: that header names are not case-sensitive.
      Parameters:
      headerName - request header name
      headerValue - request header value
    • addRequestHeader

      public void addRequestHeader(String header)
    • setRequestHeader

      public void setRequestHeader(String headerName, String headerValue)
      setRequestHeader sets a request header for this request overwritting any previously existing header/values with the same name. NOTE: Header names are not case-sensitive.
      Parameters:
      headerName - request header name
      headerValue - request header value
    • setFollowRedirects

      public void setFollowRedirects(boolean followRedirects)
      setFollowRedirects indicates whether HTTP redirects are followed. By default, redirects are not followed.
    • getFollowRedirects

      public boolean getFollowRedirects()
      getFollowRedirects indicates whether HTTP redirects are followed.
    • setState

      public void setState(org.apache.commons.httpclient.HttpState state)
      setState will set the HTTP state for the current request (i.e. session tracking). This has the side affect
    • execute

      public HttpResponse execute() throws IOException, org.apache.commons.httpclient.HttpException
      execute will dispatch the current request to the target server.
      Returns:
      HttpResponse the server's response.
      Throws:
      IOException - if an I/O error occurs during dispatch.
      org.apache.commons.httpclient.HttpException
    • getState

      public org.apache.commons.httpclient.HttpState getState()
      Returns the current state for this request.
      Returns:
      HttpState current state
    • toString

      public String toString()
      Overrides:
      toString in class Object