HttpServerResponseBuilder (RxGORM REST Client)

grails.http.client.builder.server.HttpServerResponseBuilder

A builder for populating io.reactivex.netty.protocol.http.server.HttpServerResponse objects, useful only in testing scenarios. DO NOT use production.
Authors:
Graeme Rocher
Since:
6.0

Properties Summary

Properties
Type	Name and description
`java.nio.charset.Charset`	`charset`
`io.reactivex.netty.protocol.http.server.HttpServerResponse`	`response`

Constructor Summary

Constructors
Constructor and description
`HttpServerResponseBuilder (io.reactivex.netty.protocol.http.server.HttpServerResponse httpMessage, java.nio.charset.Charset charset)`

Methods Summary

Methods
Type	Name and description
`HttpServerResponseBuilder`	`contentType(java.lang.CharSequence contentType)` Sets the content type for the request
`HttpServerResponseBuilder`	`created()` Sets a created status
`protected void`	`defaultContentType(java.lang.String contentType)`
`protected void`	`defaultJsonContentType()`
`HttpServerResponseBuilder`	`forbidden()` Sets an FORBIDDEN status
`HttpServerResponseBuilder`	`header(java.lang.CharSequence name, java.lang.Object value)` Sets a request header
`HttpServerResponseBuilder`	`json(groovy.lang.Closure callable)` Adds JSON to the body of the request
`HttpServerResponseBuilder`	`json(java.util.List array)` Adds JSON to the body of the request
`HttpServerResponseBuilder`	`json(java.util.Map json)` Adds JSON to the body of the request
`HttpServerResponseBuilder`	`json(java.lang.String json)` Adds JSON to the body of the request
`HttpServerResponseBuilder`	`noContent()` Sets a NO_CONTENT status
`HttpServerResponseBuilder`	`notFound()` Sets not found status
`HttpServerResponseBuilder`	`ok()` Sets an ok status
`HttpServerResponseBuilder`	`status(int code)` Sets the status of the response
`HttpServerResponseBuilder`	`status(io.netty.handler.codec.http.HttpResponseStatus status)` Sets the status of the response
`HttpServerResponseBuilder`	`unauthorized()` Sets an UNAUTHORIZED status
`HttpServerResponseBuilder`	`unprocessable()` Sets a UNPROCESSABLE_ENTITY status
`HttpServerResponseBuilder`	`xml(java.lang.String xml)` Sets the body of the request to the XML string argument.
`HttpServerResponseBuilder`	`xml(groovy.lang.Closure closure)` Sets the body of the request to the XML defined by the closure.
`HttpServerResponseBuilder`	`xml(groovy.util.slurpersupport.GPathResult xml)` Sets the body of the request to the XML GPathResult argument.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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 java.nio.charset.Charset charset
  - final io.reactivex.netty.protocol.http.server.HttpServerResponse response
- Constructor Detail
  - HttpServerResponseBuilder(io.reactivex.netty.protocol.http.server.HttpServerResponse httpMessage, java.nio.charset.Charset charset)
- Method Detail
  - HttpServerResponseBuilder contentType(java.lang.CharSequence contentType)
    
    Sets the content type for the request
    Parameters:
    contentType - The content type
  - HttpServerResponseBuilder created()
    
    Sets a created status
    Returns:
    The created status
  - protected void defaultContentType(java.lang.String contentType)
  - protected void defaultJsonContentType()
  - HttpServerResponseBuilder forbidden()
    
    Sets an FORBIDDEN status
    Returns:
    This builder
  - HttpServerResponseBuilder header(java.lang.CharSequence name, java.lang.Object value)
    
    Sets a request header
    Returns:
    This request
    Parameters:
    name - The name of the header
    value - The value of the header
  - HttpServerResponseBuilder json(@groovy.lang.DelegatesTo(StreamingJsonBuilder) groovy.lang.Closure callable)
    
    Adds JSON to the body of the request
    Returns:
    Parameters:
    callable - The callable that defines the JSON
  - HttpServerResponseBuilder json(java.util.List array)
    
    Adds JSON to the body of the request
    Returns:
    This request
    Parameters:
    array - The JSON array
  - HttpServerResponseBuilder json(java.util.Map json)
    
    Adds JSON to the body of the request
    Returns:
    This request
    Parameters:
    json - The JSON as a map
  - HttpServerResponseBuilder json(java.lang.String json)
    
    Adds JSON to the body of the request
    Returns:
    This request
    Parameters:
    json - The JSON as a map
  - HttpServerResponseBuilder noContent()
    
    Sets a NO_CONTENT status
    Returns:
    This builder
  - HttpServerResponseBuilder notFound()
    
    Sets not found status
    Returns:
    The not found status
  - HttpServerResponseBuilder ok()
    
    Sets an ok status
    Returns:
    This builder
  - HttpServerResponseBuilder status(int code)
    
    Sets the status of the response
    Returns:
    This builder
    Parameters:
    code - The status code
  - HttpServerResponseBuilder status(io.netty.handler.codec.http.HttpResponseStatus status)
    
    Sets the status of the response
    Returns:
    This builder
    Parameters:
    code - The status code
  - HttpServerResponseBuilder unauthorized()
    
    Sets an UNAUTHORIZED status
    Returns:
    This builder
  - HttpServerResponseBuilder unprocessable()
    
    Sets a UNPROCESSABLE_ENTITY status
    Returns:
    This builder
  - HttpServerResponseBuilder xml(java.lang.String xml)
    
    Sets the body of the request to the XML string argument.
    Returns:
    This customizer
    Parameters:
    xml - The XML to be used as the body of the request
  - HttpServerResponseBuilder 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
    Returns:
    This customizer
    Parameters:
    closure - The closure that defines the XML
  - HttpServerResponseBuilder xml(groovy.util.slurpersupport.GPathResult xml)
    
    Sets the body of the request to the XML GPathResult argument.
    Returns:
    This customizer
    Parameters:
    xml - The XML to be used as the body of the request

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class HttpServerResponseBuilder

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final java.nio.charset.Charset charset

final io.reactivex.netty.protocol.http.server.HttpServerResponse response

Constructor Detail

HttpServerResponseBuilder(io.reactivex.netty.protocol.http.server.HttpServerResponse httpMessage, java.nio.charset.Charset charset)

Method Detail

HttpServerResponseBuilder contentType(java.lang.CharSequence contentType)

HttpServerResponseBuilder created()

protected void defaultContentType(java.lang.String contentType)

protected void defaultJsonContentType()

HttpServerResponseBuilder forbidden()

HttpServerResponseBuilder header(java.lang.CharSequence name, java.lang.Object value)

HttpServerResponseBuilder json(@groovy.lang.DelegatesTo(StreamingJsonBuilder) groovy.lang.Closure callable)

HttpServerResponseBuilder json(java.util.List array)

HttpServerResponseBuilder json(java.util.Map json)

HttpServerResponseBuilder json(java.lang.String json)

HttpServerResponseBuilder noContent()

HttpServerResponseBuilder notFound()

HttpServerResponseBuilder ok()

HttpServerResponseBuilder status(int code)

HttpServerResponseBuilder status(io.netty.handler.codec.http.HttpResponseStatus status)

HttpServerResponseBuilder unauthorized()

HttpServerResponseBuilder unprocessable()

HttpServerResponseBuilder xml(java.lang.String xml)

HttpServerResponseBuilder xml(@groovy.lang.DelegatesTo(StreamingMarkupBuilder) groovy.lang.Closure closure)

HttpServerResponseBuilder xml(groovy.util.slurpersupport.GPathResult xml)