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
- Author:
- Apache MINA Project
-
-
Constructor Summary
Constructors Constructor Description HttpProxyRequest(String httpURI)
Constructor which creates a HTTP/1.0 GET request to the specified http URI.HttpProxyRequest(String httpURI, String httpVersion)
Constructor which creates a GET request to the specified http URI using the provided protocol versionHttpProxyRequest(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.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.HttpProxyRequest(InetSocketAddress endpointAddress)
Constructor which creates a HTTP/1.0 CONNECT request to the specified endpoint.HttpProxyRequest(InetSocketAddress endpointAddress, String httpVersion)
Constructor which creates a CONNECT request to the specified endpoint using the provided protocol version.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkRequiredProperties(String... propNames)
Check if the given property(ies) is(are) set.Map<String,List<String>>
getHeaders()
String
getHost()
String
getHttpURI()
String
getHttpVerb()
String
getHttpVersion()
Map<String,String>
getProperties()
void
setHeaders(Map<String,List<String>> headers)
Set the HTTP headers.void
setHttpVersion(String httpVersion)
Sets the HTTP version.void
setProperties(Map<String,String> properties)
Set additional properties for the request.String
toHttpString()
-
Methods inherited from class org.apache.mina.proxy.handlers.ProxyRequest
getEndpointAddress
-
-
-
-
Constructor Detail
-
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 tohttpVersion
- 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 tohttpVersion
- the HTTP protocol versionheaders
- 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 URIhttpVersion
- 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 usehttpURI
- the target URIhttpVersion
- 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 usehttpURI
- the target URIhttpVersion
- the HTTP protocol versionheaders
- the additional http headers
-
-
Method Detail
-
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.
-
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 aProxyAuthException
.- 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 .
-
-