Property Detail

• java.lang.Class acceptType

• java.lang.Object body

• org.springframework.http.HttpHeaders headers

• org.springframework.util.MultiValueMap<java.lang.String, java.lang.Object> mvm

• java.util.Map<java.lang.String, java.lang.Object> urlVariables

Method Detail

• RequestCustomizer accept(java.lang.String... contentTypes)

  Sets the Accept HTTP header to the given value. Example:

  
   restBuilder.get("http://..") {
        accept "application/xml"
   }
   

  Parameters:

  contentTypes - The content types

  Returns:

  The customizer

• RequestCustomizer accept(java.lang.Class responseType, java.lang.String... contentTypes)

  Sets the Accept HTTP header to the given value. Example:

  
   restBuilder.get("http://..") {
        accept XML
   }
   

  Parameters:

  responseType - The expected response type

  contentTypes - The content types

  Returns:

  The customizer

• RequestCustomizer auth(java.lang.String username, java.lang.String password)

  Used to configure BASIC authentication. Example:

  
   builder.put("http://..") {
        auth "myuser", "mypassword"
   }
   

  Parameters:

  username - The username

  password - The password

  Returns:

  The customizer

• RequestCustomizer auth(java.lang.String accessToken)

  Sets the Authorization HTTP header to the given value. Used typically to pass OAuth access tokens.

  
   builder.put("http://..") {
        auth myToken
   }
   

  Parameters:

  accessToken - The access token

  Returns:

  The customizer

• RequestCustomizer body(java.lang.Object content)

  Sets the body of the request to the given argument. Note that if you argument is not convertable to a message body an exception will be thrown. You can register new converters using restBuilder.restTemplate.getMessageConverters().add(..)

  Parameters:

  content - The body content

  Returns:

  This customizer

• RequestCustomizer contentType(java.lang.String contentType)

  Sets the Content-Type HTTP header to the given value. Example:

  
   restBuilder.put("http://..") {
        contentType "application/xml"
   }
   

  Parameters:

  contentType - The content type

  Returns:

  The customizer

• org.springframework.http.HttpEntity createEntity()

• RequestCustomizer header(java.lang.String name, java.lang.String value)

  Sets an HTTP header to the given name and value. Example:

  
   restBuilder.get("http://..") {
        header "Accept", "text/xml"
   }
   

  Parameters:

  name - The name of the header

  value - The value of the header

  Returns:

  The customizer

• RequestCustomizer json(@groovy.lang.DelegatesTo(JSONBuilder) groovy.lang.Closure callable)

  Sets the body of the request to the JSON defined by the closure. The closure uses JSONBuilder to product a JSON object. Example:

  
   restBuilder.put("http://..") {
       json {
          name = "test-group"
          description = "A temporary test group"
       }
   }
   

  Parameters:

  callable - The callable closure

  Returns:

  This customizer

• RequestCustomizer json(grails.converters.JSON json)

  Sets the body of the request to the passed JSON

  Parameters:

  json - The JSON object

  Returns:

  this customizer

• RequestCustomizer json(org.grails.web.json.JSONElement json)

  Sets the body of the request to the passed JSON

  Parameters:

  json - The JSON object

  Returns:

  this customizer

• RequestCustomizer json(java.lang.String json)

  Sets the body of the request to the passed JSON string

  Parameters:

  json - The JSON object

  Returns:

  this customizer

• RequestCustomizer json(java.lang.Object object)

  Converts the given object to JSON and sets the body to the converted JSON object

  Parameters:

  object - The object to convert to JSON

  Returns:

  this customizer

• void setProperty(java.lang.String name, java.lang.Object value)

  Sets multipart values within the request body

  Parameters:

  name - The name of the multipart

  value - The value of the multipart

• RequestCustomizer urlVariables(java.util.Map<java.lang.String, java.lang.Object> variables)

  Configures any variables used in the case of a templated URL. Example:

  
   restBuilder.get("http://../book/{id}") {
        urlVariables id:1
   }
   

  Parameters:

  variables - The URL variables

  Returns:

• RequestCustomizer xml(@groovy.lang.DelegatesTo(StreamingMarkupBuilder) groovy.lang.Closure closure)

  Sets the body of the request to the XML defined by the closure. Uses groovy.xml.StreamingMarkupBuilder to produce the XML

  Parameters:

  closure - The closure that defines the XML

  Returns:

  This customizer

• RequestCustomizer xml(grails.converters.XML xml)

  Sets the body of the request to the XML converter argument.

  Parameters:

  xml - The XML to be used as the body of the request

  Returns:

  This customizer

• RequestCustomizer xml(java.lang.String xml)

  Sets the body of the request to the XML string argument.

  Parameters:

  xml - The XML to be used as the body of the request

  Returns:

  This customizer

• RequestCustomizer xml(groovy.util.slurpersupport.GPathResult xml)

  Sets the body of the request to the XML GPathResult argument.

  Parameters:

  xml - The XML to be used as the body of the request

  Returns:

  This customizer

• RequestCustomizer xml(java.lang.Object object)

  Converts the given object to XML using Grails' converters and sets the XML as the body of the request

  Parameters:

  object - The object

  Returns:

  This customizer