Class HttpProxyRequest

java.lang.Object
org.apache.mina.proxy.handlers.ProxyRequest
org.apache.mina.proxy.handlers.http.HttpProxyRequest
public class HttpProxyRequest extends ProxyRequest
HttpProxyRequest.java - Wrapper class for HTTP requests.
Since:
MINA 2.0.0-M3

  • Field Details

    • LOGGER

      private static final org.slf4j.Logger LOGGER

    • httpVerb

      private final String httpVerb
      The HTTP verb.

    • httpURI

      private final String httpURI
      The HTTP URI.

    • httpVersion

      private String httpVersion
      The HTTP protocol version.

    • host

      private String host
      The target hostname.

    • headers

      private Map<String, List<String>> headers
      The request headers.

    • properties

      private Map<String,String> properties
      The additionnal properties supplied to use with the proxy for authentication for example.

  • Constructor Details

    • HttpProxyRequest

      public HttpProxyRequest(InetSocketAddress endpointAddress)
      Constructor which creates a HTTP/1.0 CONNECT request to the specified endpoint.
      Parameters:
      endpointAddress - the endpoint to connect to

    • HttpProxyRequest

      public HttpProxyRequest(InetSocketAddress endpointAddress, String httpVersion)
      Constructor which creates a CONNECT request to the specified endpoint using the provided protocol version.
      Parameters:
      endpointAddress - the endpoint to connect to
      httpVersion - the HTTP protocol version

    • HttpProxyRequest

      public HttpProxyRequest(InetSocketAddress endpointAddress, String httpVersion, Map<String, List<String>> headers)
      Constructor which creates a CONNECT request to the specified endpoint using the provided protocol version and setting the requested headers.
      Parameters:
      endpointAddress - the endpoint to connect to
      httpVersion - the HTTP protocol version
      headers - the additionnal http headers

    • HttpProxyRequest

      public HttpProxyRequest(String httpURI)
      Constructor which creates a HTTP/1.0 GET request to the specified http URI.
      Parameters:
      httpURI - the target URI

    • HttpProxyRequest

      public HttpProxyRequest(String httpURI, String httpVersion)
      Constructor which creates a GET request to the specified http URI using the provided protocol version
      Parameters:
      httpURI - the target URI
      httpVersion - the HTTP protocol version

    • HttpProxyRequest

      public HttpProxyRequest(String httpVerb, String httpURI, String httpVersion)
      Constructor which creates a request using the provided HTTP verb targeted at the specified http URI using the provided protocol version.
      Parameters:
      httpVerb - the HTTP verb to use
      httpURI - the target URI
      httpVersion - the HTTP protocol version

    • HttpProxyRequest

      public HttpProxyRequest(String httpVerb, String httpURI, String httpVersion, Map<String, List<String>> headers)
      Constructor which creates a request using the provided HTTP verb targeted at the specified http URI using the provided protocol version and setting the requested headers.
      Parameters:
      httpVerb - the HTTP verb to use
      httpURI - the target URI
      httpVersion - the HTTP protocol version
      headers - the additional http headers

  • Method Details

    • getHttpVerb

      public final String getHttpVerb()
      Returns:
      the HTTP request verb.

    • getHttpVersion

      public String getHttpVersion()
      Returns:
      the HTTP version.

    • setHttpVersion

      public void setHttpVersion(String httpVersion)
      Sets the HTTP version.
      Parameters:
      httpVersion - the HTTP protocol version

    • getHost

      public final String getHost()
      Returns:
      the host to which we are connecting.

    • getHttpURI

      public final String getHttpURI()
      Returns:
      the request HTTP URI.

    • getHeaders

      public final Map<String, List<String>> getHeaders()
      Returns:
      the HTTP headers.

    • setHeaders

      public final void setHeaders(Map<String, List<String>> headers)
      Set the HTTP headers.
      Parameters:
      headers - The HTTP headers to set

    • getProperties

      public Map<String,String> getProperties()
      Returns:
      additional properties for the request.

    • setProperties

      public void setProperties(Map<String,String> properties)
      Set additional properties for the request.
      Parameters:
      properties - The properties to add to the reqyest

    • checkRequiredProperties

      public void checkRequiredProperties(String... propNames) throws ProxyAuthException
      Check if the given property(ies) is(are) set. Otherwise throws a ProxyAuthException.
      Parameters:
      propNames - The list of property name to check
      Throws:
      ProxyAuthException - If we get an error during the proxy authentication

    • toHttpString

      public String toHttpString()
      Returns:
      the string representation of the HTTP request .