bayou.http

Class HttpRequestImpl

java.lang.Object

bayou.http.HttpRequestImpl

All Implemented Interfaces:

HttpRequest

public class HttpRequestImpl
extends Object
implements HttpRequest

A mutable implementation of HttpRequest.

An HttpRequestImpl can be modified after construction, e.g. by header(String, String). These mutation methods return `this` for method chaining.

Constructor Summary

Constructors

Constructor and Description
HttpRequestImpl(String method, String uri, HttpEntity entity) Create an http request.
HttpRequestImpl(HttpRequest originRequest) Copy an http request.

Method Summary

Instance Methods
InetAddress	ip() Get the client IP.
boolean	isHttps() Whether this is an HTTPS request.
List<X509Certificate>	certs() Certificates of the client.
String	method() Get the request method.
String	uri() Get the request URI.
String	uriPath() The path component of the request URI.
String	uriParam(String name) Get the value of a parameter in the request URI.
String	httpVersion() Get the HTTP version.
HeaderMap	headers() Get the headers.
Map<String,String>	cookies() Get the request cookies.
HttpEntity	entity() Get the entity.
HttpRequestImpl	ip(InetAddress ip) Set the client IP.
HttpRequestImpl	isHttps(boolean isHttps) Set the isHttps property..
HttpRequestImpl	method(String method) Set the request method.
HttpRequestImpl	host(String host) Set the "Host" header.
HttpRequestImpl	uri(String uri) Set the request URI.
HttpRequestImpl	header(String name, String value) Set a header.
HttpRequestImpl	cookie(String name, String value) Set a cookie.
HttpRequestImpl	cookies(Map<String,String> cookies) Set the cookies.
HttpRequestImpl	entity(HttpEntity entity) Set the entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.http.HttpRequest

absoluteUri, acceptsGzip, cookie, header, host, scheme

Constructor Detail

HttpRequestImpl

public HttpRequestImpl(String method,
                       String uri,
                       HttpEntity entity)

Create an http request.

See uri(String) for permissible `uri` arguments. It's preferred that `uri` is an absolute URI; otherwise, the caller should set the host afterwards.

Examples:

     new HttpRequestImpl("GET", "https://example.com/", null);

     new HttpRequestImpl("GET", "/search?q=cat", null).host("localhost:8080");

     new HttpRequestImpl("CONNECT", "proxy.com:8080", null);

     new HttpRequestImpl("OPTIONS", "*", null).host("example.com");
 

HttpRequestImpl

public HttpRequestImpl(HttpRequest originRequest)

Copy an http request.

This can be used for request transformation, for example to change the URI, add a header, etc. The origin request is treated as read-only and will not be modified.

Method Detail

ip

public InetAddress ip()

Get the client IP.

See ip(java.net.InetAddress) for changing the IP.

Specified by:

ip in interface HttpRequest

isHttps

public boolean isHttps()

Whether this is an HTTPS request.

See isHttps(boolean) for changing this property.

Specified by:

isHttps in interface HttpRequest

See Also:

HttpRequest.scheme()

certs

public List<X509Certificate> certs()

Certificates of the client. See SSLSession.getPeerCertificates().

Specified by:

certs in interface HttpRequest

method

public String method()

Get the request method.

See method(String) for changing the method.

Specified by:

method in interface HttpRequest

uri

public String uri()

Get the request URI.

See uri(String) for changing the URI.

Specified by:

uri in interface HttpRequest

uriPath

public String uriPath()

Description copied from interface: HttpRequest

The path component of the request URI.

The path is the substring before the first question mark ("?"). For example, if uri()=="/query?term=cat", then uriPath()=="/query".

Specified by:

uriPath in interface HttpRequest

uriParam

public String uriParam(String name)

Description copied from interface: HttpRequest

Get the value of a parameter in the request URI.

For example, if uri()=="/query?term=cat", then uriParam("term")=="cat".

The query component of the request URI is parsed as "application/x-www-form-urlencoded" with UTF-8 charset. If there's any parsing error, this method returns null.

See FormParser for more options.

Specified by:

uriParam in interface HttpRequest

httpVersion

public String httpVersion()

Get the HTTP version.

Specified by:

httpVersion in interface HttpRequest

headers

public HeaderMap headers()

Get the headers.

The returned map is mutable; the request producer can manipulate it at will. See also header(name,value).

Specified by:

headers in interface HttpRequest

cookies

public Map<String,String> cookies()

Get the request cookies.

The cookies are parsed from the "Cookie" header; see parent javadoc.

The returned Map is read-only. To modify cookies, see cookie(String, String) and cookies(java.util.Map) methods; or you can always set the "Cookie" header directly.

Specified by:

cookies in interface HttpRequest

See Also:

HttpRequest.cookie(String)

entity

public HttpEntity entity()

Get the entity.

See entity(HttpEntity) for changing the entity;

Specified by:

entity in interface HttpRequest

ip

public HttpRequestImpl ip(InetAddress ip)

Set the client IP.

Returns:

this

isHttps

public HttpRequestImpl isHttps(boolean isHttps)

Set the isHttps property..

Returns:

this

method

public HttpRequestImpl method(String method)

Set the request method.

Returns:

this

host

public HttpRequestImpl host(String host)

Set the "Host" header.

Returns:

this

uri

public HttpRequestImpl uri(String uri)
                    throws IllegalArgumentException

Set the request URI.

The behavior of this method depends on the request method, which should be settled before calling this method.

See HttpRequest.uri() for permissible `uri` arguments.

In addition, this method also accepts absolute URI, which may change isHttps(boolean) and host(String) too.

Examples:

     req.uri( "/search?q=cat" );   // path-query
     req.uri( "proxy.com:8080" );  // CONNECT
     req.uri( "*" );               // OPTIONS

     req.uri( "https://example.com/" );  // absolute URI
 

Returns:

this

Throws:

IllegalArgumentException

header

public HttpRequestImpl header(String name,
                              String value)

Set a header.

If value==null, the header will be removed.

Returns:

this

cookie

public HttpRequestImpl cookie(String name,
                              String value)
                       throws IllegalArgumentException

Set a cookie.

If value==null, the cookie will be removed.

See Cookie for valid cookie name/value.

Returns:

this

Throws:

IllegalArgumentException

cookies

public HttpRequestImpl cookies(Map<String,String> cookies)

Set the cookies.

All existing cookies will be removed. This method sets a new "Cookie" header based on provided cookies.

See Cookie for valid cookie name/value.

Returns:

this

entity

public HttpRequestImpl entity(HttpEntity entity)

Set the entity.

Returns:

this