HttpRequest (HTTP Client Documentation)

public interface HttpRequest

This class represents an immutable client request is ready for execution. Request may be executed synchronously or asynchronously.

The following example illustrates the synchronous(blocking) invocation of a request:

 HttpResponse response = request.invoke();
 if (HttpResponse.OK == response.getResponseCode()) {
     // handle the response
     ...
 }

Asynchronous invocation of a request:

 HttpResponse response = request.invoke(
     new HttpResponseListener() {
         public void handle(HttpResponse response) {
             // handle the response
             ...
         }
         public void failed(Throwable exc) {
             // handle the exception
             //...
         }
     });

See Also:: HttpResponseListener

Method Summary

Methods
Modifier and Type	Method and Description
`HttpRequestBuilder`	`createBuilder()` Returns a new instance of `HttpRequestBuilder` based on the request parameters.
`StreamedMessageBody`	`getBody()` Returns the message body associated with this request.
`java.lang.String`	`getHeader(HttpHeader header)` Returns the value of `header` for the request.
`HttpMessageHeaders`	`getHeaders()` Returns an unmodifiable view of the HTTP headers and corresponding values.
`HttpMethod`	`getMethod()` Returns the HTTP method.
`java.lang.String`	`getURI()` Returns the string representation of URI.
`boolean`	`hasBody()` Returns `true` if the request contains a message body.
`HttpResponse`	`invoke()` Synchronously invoke the request.
`void`	`invoke(HttpResponseListener listener)` Asynchronously invoke the request with the given `listener`.

- Method Detail
  - getURI
```
java.lang.String getURI()
```
    Returns the string representation of URI.
    
    Returns:
    URI.
  - getMethod
```
HttpMethod getMethod()
```
    Returns the HTTP method.
    
    Returns:
    HTTP method.
  - getHeader
```
java.lang.String getHeader(HttpHeader header)
```
    Returns the value of header for the request.
    
    Parameters:
    header - HTTP header.
    
    Returns:
    HTTP header value. If the header is not present then returned value is null.
    
    Throws:
    
    java.lang.NullPointerException - in case of header is null.
  - getHeaders
```
HttpMessageHeaders getHeaders()
```
    Returns an unmodifiable view of the HTTP headers and corresponding values.
    
    Returns:
    the request headers.
  - hasBody
```
boolean hasBody()
```
    Returns true if the request contains a message body.
    
    Returns:
    true if the request contains a message body.
  - getBody
```
StreamedMessageBody getBody()
```
    Returns the message body associated with this request.
    
    Returns:
    message body. Returns null if the request does not contain a message body.
  - invoke
```
HttpResponse invoke()
                    throws HttpClientException
```
    Synchronously invoke the request.
    
    Returns:
    HttpResponse instance.
    
    Throws:
    
    HttpClientException
  - invoke
```
void invoke(HttpResponseListener listener)
```
    Asynchronously invoke the request with the given listener.
    
    Parameters:
    listener - invocation listener for asynchronous handling a response.
    
    Throws:
    
    java.lang.NullPointerException - in case of listener is null.
  - createBuilder
```
HttpRequestBuilder createBuilder()
```
    Returns a new instance of HttpRequestBuilder based on the request parameters.
    
    Returns:
    a new instance of HttpRequestBuilder.

Interface HttpRequest

Method Summary

Method Detail

getURI

getMethod

getHeader

getHeaders

hasBody

getBody

invoke

invoke

createBuilder