groovyx.net.http

Class HttpConfigs.BaseRequest

java.lang.Object

groovyx.net.http.HttpConfigs.BaseRequest

All Implemented Interfaces:

ChainedHttpConfig.ChainedRequest, HttpConfig.Request

Direct Known Subclasses:

HttpConfigs.BasicRequest, HttpConfigs.ThreadSafeRequest

Enclosing class:

HttpConfigs

public abstract static class HttpConfigs.BaseRequest
extends java.lang.Object
implements ChainedHttpConfig.ChainedRequest

Constructor Summary

Constructors

Constructor and Description
BaseRequest(ChainedHttpConfig.ChainedRequest parent)

Method Summary

Modifier and Type	Method and Description
void	cookie(java.lang.String name, java.lang.String value, java.util.Date date) The cookie configuration options provide a means of adding HTTP Cookies to the request.
void	cookie(java.lang.String name, java.lang.String value, java.time.Instant instant)
void	cookie(java.lang.String name, java.lang.String value, java.time.LocalDateTime dateTime) The cookie configuration options provide a means of adding HTTP Cookies to the request.
void	encoder(java.lang.Iterable<java.lang.String> contentTypes, java.util.function.BiConsumer<ChainedHttpConfig,ToServer> val) Specifies the request encoder (ToServer instance) to be used when encoding the given list of content types.
java.util.function.BiConsumer<ChainedHttpConfig,ToServer>	encoder(java.lang.String contentType) Retrieves the request encoder (ToServer instance) for the specified content type wrapped in a BiConsumer function.
void	encoder(java.lang.String contentType, java.util.function.BiConsumer<ChainedHttpConfig,ToServer> val) Specifies the request encoder (ToServer instance) to be used when encoding the given content type.
ChainedHttpConfig.ChainedRequest	getParent()
HttpVerb	getVerb()
void	setAccept(java.lang.Iterable<java.lang.String> values) The accept property allows configuration of the request Accept header, which may be used to specify certain media types which are acceptable for the response.
void	setAccept(java.lang.String[] values) The accept property allows configuration of the request Accept header, which may be used to specify certain media types which are acceptable for the response.
void	setCharset(java.lang.String val) The charset property is used to specify the character set (as a String) used by the request.
void	setHeaders(java.util.Map<java.lang.String,java.lang.CharSequence> toAdd) The headers property allows the direct specification of the request headers as a Map<String,String>.
void	setRaw(java.lang.String val) The request.raw is the means of specifying a "raw" URI as the HTTP endpoint for the request, specified as a String.
void	setUri(java.lang.String val) The request.uri is the URI of the HTTP endpoint for the request, specified as a String in this case.
void	setUri(java.net.URI val) The request.uri is the URI of the HTTP endpoint for the request, specified as a URI in this case.
void	setUri(java.net.URL val) The request.uri is the URI of the HTTP endpoint for the request, specified as a URL in this case.
void	setVerb(HttpVerb verb)

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, getBody, getCharset, getContentType, getCookies, getEncoderMap

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

cookie, getAuth, getHeaders, getUri, setBody, setCharset, setContentType

Constructor Detail

BaseRequest

public BaseRequest(ChainedHttpConfig.ChainedRequest parent)

Method Detail

getParent

public ChainedHttpConfig.ChainedRequest getParent()

Specified by:

getParent in interface ChainedHttpConfig.ChainedRequest

setCharset

public void setCharset(java.lang.String val)

Description copied from interface: HttpConfig.Request

The charset property is used to specify the character set (as a String) used by the request.

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

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

Specified by:

setCharset in interface HttpConfig.Request

Parameters:

val - the content type character set value to be used

setUri

public void setUri(java.lang.String val)

Description copied from interface: HttpConfig.Request

The request.uri is the URI of the HTTP endpoint for the request, specified as a String in this case.

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

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

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

Which allows multiple verb requests to be configured against the same HttpBuilder. See the UriBuilder documentation for more details.

The uri is the only required configuration property.

Specified by:

setUri in interface HttpConfig.Request

Parameters:

val - the URI to be used for the request, as a String

setRaw

public void setRaw(java.lang.String val)

Description copied from interface: HttpConfig.Request

The request.raw is the means of specifying a "raw" URI as the HTTP endpoint for the request, specified as a String. No encoding or decoding is performed on a "raw" URI. Any such encoding or decoding of URI content must be done in the provided string itself, as it will be used "as is" in the resulting URI. This functionality is useful in the case where there are encoded entities in the URI path, since the standard uri method will decode these on building the URI.

Specified by:

setRaw in interface HttpConfig.Request

Parameters:

val - the raw URI string

setUri

public void setUri(java.net.URI val)

Description copied from interface: HttpConfig.Request

The request.uri is the URI of the HTTP endpoint for the request, specified as a URI in this case.

def http = HttpBuilder.configure {
     request.uri = new URI('http://localhost:10101')
}

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

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

Which allows multiple verb requests to be configured against the same HttpBuilder. See the UriBuilder documentation for more details.

The uri is the only required configuration property.

Specified by:

setUri in interface HttpConfig.Request

Parameters:

val - the URI to be used for the request, as a URI

setUri

public void setUri(java.net.URL val)
            throws java.net.URISyntaxException

Description copied from interface: HttpConfig.Request

The request.uri is the URI of the HTTP endpoint for the request, specified as a URL in this case.

def http = HttpBuilder.configure {
     request.uri = new URL('http://localhost:10101')
}

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

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

Which allows multiple verb requests to be configured against the same HttpBuilder. See the UriBuilder documentation for more details.

The uri is the only required configuration property.

Specified by:

setUri in interface HttpConfig.Request

Parameters:

val - the URI to be used for the request, as a URL

Throws:

java.net.URISyntaxException

encoder

public java.util.function.BiConsumer<ChainedHttpConfig,ToServer> encoder(java.lang.String contentType)

Description copied from interface: HttpConfig.Request

Retrieves the request encoder (ToServer instance) for the specified content type wrapped in a BiConsumer function.

Specified by:

encoder in interface HttpConfig.Request

Parameters:

contentType - the content type of the encoder to be retrieved

Returns:

the encoder for the specified content type (wrapped in a BiConsumer function)

encoder

public void encoder(java.lang.String contentType,
                    java.util.function.BiConsumer<ChainedHttpConfig,ToServer> val)

Description copied from interface: HttpConfig.Request

Specifies the request encoder (ToServer instance) to be used when encoding the given content type.

Specified by:

encoder in interface HttpConfig.Request

Parameters:

contentType - the content type

val - the request encoder (wrapped in a BiConsumer function)

encoder

public void encoder(java.lang.Iterable<java.lang.String> contentTypes,
                    java.util.function.BiConsumer<ChainedHttpConfig,ToServer> val)

Description copied from interface: HttpConfig.Request

Specifies the request encoder (ToServer instance) to be used when encoding the given list of content types.

Specified by:

encoder in interface HttpConfig.Request

Parameters:

contentTypes - the content types

val - the request encoder (wrapped in a BiConsumer function)

setAccept

public void setAccept(java.lang.String[] values)

Description copied from interface: HttpConfig.Request

The accept property allows configuration of the request Accept header, which may be used to specify certain media types which are acceptable for the response.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.accept = ['image/jpeg']
}

http.post {
     request.uri.path = '/bar'
     request.accept = ['image/tiff', 'image/png']
}

Specified by:

setAccept in interface HttpConfig.Request

Parameters:

values - the accept header values as a String array

setAccept

public void setAccept(java.lang.Iterable<java.lang.String> values)

Description copied from interface: HttpConfig.Request

The accept property allows configuration of the request Accept header, which may be used to specify certain media types which are acceptable for the response.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.accept = ['image/jpeg']
}

http.post {
     request.uri.path = '/bar'
     request.accept = ['image/tiff', 'image/png']
}

Specified by:

setAccept in interface HttpConfig.Request

Parameters:

values - the accept header values as a List

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.CharSequence> toAdd)

Description copied from interface: HttpConfig.Request

The headers property allows the direct specification of the request headers as a Map<String,String>. Be aware that Content-Type and Accept are actually header values and it is up to the implementation to determine which configuration will win out if both are configured.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.headers = [
         ClientId: '987sdfsdf9uh'
     ]
}

http.post {
     request.uri.path = '/bar'
     request.headers = [
         AccessCode: '99887766'
     ]
}

Warning

The headers are additive; however, a header specified in the verb configuration may overwrite one defined in the global configuration.

Specified by:

setHeaders in interface HttpConfig.Request

Parameters:

toAdd - the headers to be added to the request headers

cookie

public void cookie(java.lang.String name,
                   java.lang.String value,
                   java.time.Instant instant)

cookie

public void cookie(java.lang.String name,
                   java.lang.String value,
                   java.util.Date date)

Description copied from interface: HttpConfig.Request

The cookie configuration options provide a means of adding HTTP Cookies to the request. Cookies are defined with a name, value, and expires Date.

def http = HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
     request.cookie 'seen-before', 'true'
}

http.post {
     request.uri.path = '/bar'
     request.cookie 'last-page', 'item-list', Date.parse('MM/dd/yyyy', '12/31/2016')
}

Warning

Cookies are additive, once a Cookie is defined (e.g. in the global configuration), you cannot overwrite it in per-verb configurations.

As noted in the HttpObjectConfig.Client configuration, the default Cookie version supported is 0, but this may be modified.

Specified by:

cookie in interface HttpConfig.Request

Parameters:

name - the cookie name

value - the cookie value

date - the cookie expiration date

cookie

public void cookie(java.lang.String name,
                   java.lang.String value,
                   java.time.LocalDateTime dateTime)

Description copied from interface: HttpConfig.Request

The cookie configuration options provide a means of adding HTTP Cookies to the request. Cookies are defined with a name, value, and an expiration date as LocalDateTime.

HttpBuilder.configure {
     request.uri = 'http://localhost:10101'
}.post {
     request.uri.path = '/bar'
     request.cookie 'last-page', 'item-list', LocalDateTime.now().plus(1, ChronoUnit.MONTHS)
}

Warning

Cookies are additive, once a Cookie is defined (e.g. in the global configuration), you cannot overwrite it in per-verb configurations.

As noted in the HttpObjectConfig.Client configuration, the default Cookie version supported is 0, but this may be modified.

Specified by:

cookie in interface HttpConfig.Request

Parameters:

name - the cookie name

value - the cookie value

dateTime - the cookie expiration date

getVerb

public HttpVerb getVerb()

Specified by:

getVerb in interface ChainedHttpConfig.ChainedRequest

setVerb

public void setVerb(HttpVerb verb)

Specified by:

setVerb in interface ChainedHttpConfig.ChainedRequest