Package org.apache.mina.proxy.handlers.http

Class HttpProxyRequest

  • public class HttpProxyRequest
extends ProxyRequest
    HttpProxyRequest.java - Wrapper class for HTTP requests.
    Since:
    MINA 2.0.0-M3
    Author:
    Apache MINA Project

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpProxyRequest​(java.lang.String httpURI)
      Constructor which creates a HTTP/1.0 GET request to the specified http URI.
      HttpProxyRequest​(java.lang.String httpURI, java.lang.String httpVersion)
      Constructor which creates a GET request to the specified http URI using the provided protocol version
      HttpProxyRequest​(java.lang.String httpVerb, java.lang.String httpURI, java.lang.String httpVersion)
      Constructor which creates a request using the provided HTTP verb targeted at the specified http URI using the provided protocol version.
      HttpProxyRequest​(java.lang.String httpVerb, java.lang.String httpURI, java.lang.String httpVersion, java.util.Map<java.lang.String,​java.util.List<java.lang.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.
      HttpProxyRequest​(java.net.InetSocketAddress endpointAddress)
      Constructor which creates a HTTP/1.0 CONNECT request to the specified endpoint.
      HttpProxyRequest​(java.net.InetSocketAddress endpointAddress, java.lang.String httpVersion)
      Constructor which creates a CONNECT request to the specified endpoint using the provided protocol version.
      HttpProxyRequest​(java.net.InetSocketAddress endpointAddress, java.lang.String httpVersion, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)
      Constructor which creates a CONNECT request to the specified endpoint using the provided protocol version and setting the requested headers.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void checkRequiredProperties​(java.lang.String... propNames)
      Check if the given property(ies) is(are) set.
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()  
      java.lang.String getHost()  
      java.lang.String getHttpURI()  
      java.lang.String getHttpVerb()  
      java.lang.String getHttpVersion()  
      java.util.Map<java.lang.String,​java.lang.String> getProperties()  
      void setHeaders​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)
      Set the HTTP headers.
      void setHttpVersion​(java.lang.String httpVersion)
      Sets the HTTP version.
      void setProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)
      Set additional properties for the request.
      java.lang.String toHttpString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HttpProxyRequest

        public HttpProxyRequest​(java.net.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​(java.net.InetSocketAddress endpointAddress,
                        java.lang.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​(java.net.InetSocketAddress endpointAddress,
                        java.lang.String httpVersion,
                        java.util.Map<java.lang.String,​java.util.List<java.lang.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​(java.lang.String httpURI)
        Constructor which creates a HTTP/1.0 GET request to the specified http URI.
        Parameters:
        httpURI - the target URI

      • HttpProxyRequest

        public HttpProxyRequest​(java.lang.String httpURI,
                        java.lang.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​(java.lang.String httpVerb,
                        java.lang.String httpURI,
                        java.lang.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​(java.lang.String httpVerb,
                        java.lang.String httpURI,
                        java.lang.String httpVersion,
                        java.util.Map<java.lang.String,​java.util.List<java.lang.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 Detail

      • getHttpVerb

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

      • getHttpVersion

        public java.lang.String getHttpVersion()
        Returns:
        the HTTP version.

      • setHttpVersion

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

      • getHost

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

      • getHttpURI

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

      • getHeaders

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

      • setHeaders

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

      • getProperties

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

      • setProperties

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

      • checkRequiredProperties

        public void checkRequiredProperties​(java.lang.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 java.lang.String toHttpString()
        Returns:
        the string representation of the HTTP request .