HttpRequestBuilder (RxGORM REST Client)

grails.http.client.builder.HttpRequestBuilder

Represents the HTTP request to be customized
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`HttpRequestBuilder.FormDataBuilder`
`static class`	`HttpRequestBuilder.MultipartBuilder`	Helps with building multipart requests

Properties Summary

Properties
Type	Name and description
`io.netty.handler.codec.http.FullHttpRequest`	`request`
`io.netty.handler.codec.http.HttpRequest`	`wrapped`

Constructor Summary

Constructors
Constructor and description
`HttpRequestBuilder (io.netty.handler.codec.http.FullHttpRequest request, java.lang.String encoding)`
`HttpRequestBuilder (io.netty.handler.codec.http.FullHttpRequest request, java.nio.charset.Charset charset)`

Methods Summary

Methods
Type	Name and description
`HttpRequestBuilder`	`accept(java.lang.CharSequence... contentTypes)` Sets the Accept HTTP header to the given value.
`HttpRequestBuilder`	`auth(java.lang.String username, java.lang.String password)` Used to configure BASIC authentication.
`HttpRequestBuilder`	`auth(java.lang.CharSequence accessToken)` Sets the Authorization HTTP header to the given value.
`HttpRequestBuilder`	`form(groovy.lang.Closure formDefinition)` Builds a form
`HttpRequestBuilder`	`method(java.lang.CharSequence method)` Sets the method of the request
`HttpRequestBuilder`	`multipart(groovy.lang.Closure formDefinition)` Builds a multipart form
`HttpRequestBuilder`	`uri(java.lang.CharSequence uri)` Sets the URI of the request

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class HttpMessageBuilder`	`contentType, defaultContentType, defaultJsonContentType, header, json, json, json, json, prepareJsonBuilder, xml, xml, xml`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - final io.netty.handler.codec.http.FullHttpRequest request
  - io.netty.handler.codec.http.HttpRequest wrapped
- Constructor Detail
  - HttpRequestBuilder(io.netty.handler.codec.http.FullHttpRequest request, java.lang.String encoding)
  - HttpRequestBuilder(io.netty.handler.codec.http.FullHttpRequest request, java.nio.charset.Charset charset)
- Method Detail
  - HttpRequestBuilder accept(java.lang.CharSequence... contentTypes)
    
    Sets the Accept HTTP header to the given value. Example:
```
 restBuilder.get("http://..") {
      accept "application/xml"
 }
 
```
    Returns:
    The customizer
    Parameters:
    contentTypes - The content types
  - HttpRequestBuilder auth(java.lang.String username, java.lang.String password)
    
    Used to configure BASIC authentication. Example:
```
 builder.put("http://..") {
      auth "myuser", "mypassword"
 }
 
```
    Returns:
    The request
    Parameters:
    username - The username
    password - The password
  - HttpRequestBuilder auth(java.lang.CharSequence accessToken)
    
    Sets the Authorization HTTP header to the given value. Used typically to pass OAuth access tokens.
```
 builder.put("http://..") {
      auth myToken
 }
 
```
    Returns:
    The customizer
    Parameters:
    accessToken - The access token
  - HttpRequestBuilder form(@groovy.lang.DelegatesTo(FormDataBuilder) groovy.lang.Closure formDefinition)
    
    Builds a form
    Returns:
    this object
    Parameters:
    formDefinition - The form definition
  - HttpRequestBuilder method(java.lang.CharSequence method)
    
    Sets the method of the request
    Returns:
    This request
    Parameters:
    method - The HTTP method
  - HttpRequestBuilder multipart(@groovy.lang.DelegatesTo(MultipartBuilder) groovy.lang.Closure formDefinition)
    
    Builds a multipart form
    Returns:
    this object
    Parameters:
    formDefinition - The form definition
  - HttpRequestBuilder uri(java.lang.CharSequence uri)
    
    Sets the URI of the request
    Returns:
    the request
    Parameters:
    uri - The uriTemplate of the request

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class HttpRequestBuilder

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final io.netty.handler.codec.http.FullHttpRequest request

io.netty.handler.codec.http.HttpRequest wrapped

Constructor Detail

HttpRequestBuilder(io.netty.handler.codec.http.FullHttpRequest request, java.lang.String encoding)

HttpRequestBuilder(io.netty.handler.codec.http.FullHttpRequest request, java.nio.charset.Charset charset)

Method Detail

HttpRequestBuilder accept(java.lang.CharSequence... contentTypes)

HttpRequestBuilder auth(java.lang.String username, java.lang.String password)

HttpRequestBuilder auth(java.lang.CharSequence accessToken)

HttpRequestBuilder form(@groovy.lang.DelegatesTo(FormDataBuilder) groovy.lang.Closure formDefinition)

HttpRequestBuilder method(java.lang.CharSequence method)

HttpRequestBuilder multipart(@groovy.lang.DelegatesTo(MultipartBuilder) groovy.lang.Closure formDefinition)

HttpRequestBuilder uri(java.lang.CharSequence uri)