groovyx.net.http

Class HttpConfigs.BasicRequest

java.lang.Object

groovyx.net.http.HttpConfigs.BaseRequest

groovyx.net.http.HttpConfigs.BasicRequest

All Implemented Interfaces:

ChainedHttpConfig.ChainedRequest, HttpConfig.Request

Enclosing class:

HttpConfigs

public static class HttpConfigs.BasicRequest
extends HttpConfigs.BaseRequest

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicRequest(ChainedHttpConfig.ChainedRequest parent)

Method Summary

Modifier and Type	Method and Description
HttpConfigs.BasicAuth	getAuth() Retrieves the authentication information for the request.
java.lang.Object	getBody()
java.nio.charset.Charset	getCharset()
java.lang.String	getContentType()
java.util.List<java.net.HttpCookie>	getCookies()
java.util.Map<java.lang.String,java.util.function.BiConsumer<ChainedHttpConfig,ToServer>>	getEncoderMap()
java.util.Map<java.lang.String,java.lang.CharSequence>	getHeaders() Used to retrieve the request headers.
UriBuilder	getUri() Retrieves the UriBuilder for the request, which provides methods for more fine-grained URI specification.
void	setBody(java.lang.Object val) The body property is used to configure the body content for the request.
void	setCharset(java.nio.charset.Charset val) The charset property is used to specify the character set (as a Charset) used by the request.
void	setContentType(java.lang.String val) The contentType property is used to specify the Content-Type header value for the request.

Methods inherited from class groovyx.net.http.HttpConfigs.BaseRequest

cookie, cookie, cookie, encoder, encoder, encoder, getParent, getVerb, setAccept, setAccept, setCharset, setHeaders, setRaw, setUri, setUri, setUri, setVerb

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovyx.net.http.ChainedHttpConfig.ChainedRequest

actualAuth, actualBody, actualCharset, actualContentType, actualCookies, actualEncoder, actualHeaders

Methods inherited from interface groovyx.net.http.HttpConfig.Request

cookie

Constructor Detail

BasicRequest

protected BasicRequest(ChainedHttpConfig.ChainedRequest parent)

Method Detail

getEncoderMap

public java.util.Map<java.lang.String,java.util.function.BiConsumer<ChainedHttpConfig,ToServer>> getEncoderMap()

getCookies

public java.util.List<java.net.HttpCookie> getCookies()

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String val)

Description copied from interface: HttpConfig.Request

The contentType property is used to specify the Content-Type header value for the request.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.contentType = 'text/json'
}

http.post {
     request.uri.path = '/bar'
     request.contentType = 'text/csv'
}

By default, the value will be text/plain. The ContentTypes class provides a helper for some of the more common content type values.

Parameters:

val - the content type value to be used

setCharset

public void setCharset(java.nio.charset.Charset val)

Description copied from interface: HttpConfig.Request

The charset property is used to specify the character set (as a Charset) used by the request. This value will be reflected in the Content-Type header value (e.g. Content-Type: text/plain; charset=utf-8). A content-type value must be specified in order for this value to be applied.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.charset = 'utf-16'
}

http.post {
     request.uri.path = '/bar'
     request.charset = 'utf-8'
}

Parameters:

val - the content type character set value to be used

getCharset

public java.nio.charset.Charset getCharset()

getUri

public UriBuilder getUri()

Description copied from interface: HttpConfig.Request

Retrieves the UriBuilder for the request, which provides methods for more fine-grained URI specification.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
}

http.get {
     request.uri.path = '/foo'
}

Returns:

the UriBuilder for the request

getHeaders

public java.util.Map<java.lang.String,java.lang.CharSequence> getHeaders()

Description copied from interface: HttpConfig.Request

Used to retrieve the request headers.

Returns:

the Map of request headers

getBody

public java.lang.Object getBody()

setBody

public void setBody(java.lang.Object val)

Description copied from interface: HttpConfig.Request

The body property is used to configure the body content for the request. The request body content may be altered by configured encoders internally or may be passed on unmodified. See HttpConfig and HttpObjectConfig for content-altering methods (encoders, decoders and interceptors).

Parameters:

val - the request body content

getAuth

public HttpConfigs.BasicAuth getAuth()

Description copied from interface: HttpConfig.Request

Retrieves the authentication information for the request.

Returns:

the authentication information for the request.