groovyx.net.http

Interface HttpConfig

All Known Subinterfaces:

ChainedHttpConfig, HttpObjectConfig

All Known Implementing Classes:

HttpConfigs.BaseHttpConfig, HttpConfigs.BasicHttpConfig, HttpConfigs.ThreadSafeHttpConfig, HttpObjectConfigImpl

public interface HttpConfig

Provides the public interface used for the HttpBuilder shared and per-verb configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpConfig.Auth Defines the configurable HTTP request authentication properties.
static class	HttpConfig.AuthType Defines the allowed values of the HTTP authentication type.
static interface	HttpConfig.Request Defines the configurable HTTP request properties.
static interface	HttpConfig.Response Defines the configurable HTTP response properties.
static class	HttpConfig.Status Defines the an enumeration of the overall HTTP response status categories.

Method Summary

Modifier and Type	Method and Description
default void	context(java.lang.Iterable<java.lang.String> contentTypes, java.lang.Object id, java.lang.Object obj) Used to register a content-type-scoped object on the context in the specified content-type scopes.
void	context(java.lang.String contentType, java.lang.Object id, java.lang.Object obj) Registers a context-level content-type specific object.
HttpConfig.Request	getRequest() Used to retrieve configuration information about the HTTP request.
HttpConfig.Response	getResponse() Used to retrieve configuration information about the HTTP response.

Method Detail

context

void context(java.lang.String contentType,
             java.lang.Object id,
             java.lang.Object obj)

Registers a context-level content-type specific object.

Parameters:

contentType - the content type scope of the mapping

id - the mapping key

obj - the mapping value

context

default void context(java.lang.Iterable<java.lang.String> contentTypes,
                     java.lang.Object id,
                     java.lang.Object obj)

Used to register a content-type-scoped object on the context in the specified content-type scopes.

Parameters:

contentTypes - the content-types where the mapping is scoped

id - the mapping key

obj - the mapping value

getRequest

HttpConfig.Request getRequest()

Used to retrieve configuration information about the HTTP request.

Returns:

the HTTP request

getResponse

HttpConfig.Response getResponse()

Used to retrieve configuration information about the HTTP response.

Returns:

the HTTP response