- GAEConnectionManager - Class in groovyx.net.http.thirdparty
-
- GAEConnectionManager() - Constructor for class groovyx.net.http.thirdparty.GAEConnectionManager
-
- get(Map<String, ?>) - Method in class groovyx.net.http.HTTPBuilder
-
Convenience method to perform an HTTP GET.
- get(Map<String, ?>, Closure) - Method in class groovyx.net.http.HTTPBuilder
-
Convenience method to perform an HTTP GET.
- get(Map<String, ?>) - Method in class groovyx.net.http.RESTClient
-
Convenience method to perform an HTTP GET request.
- getAcceptHeader() - Method in enum groovyx.net.http.ContentType
-
Builds a string to be used as an HTTP Accept
header
value, i.e.
- getAllHeaders() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getAt(Object) - Method in class groovyx.net.http.EncoderRegistry
-
Retrieve a encoder for the given content-type.
- getAt(String) - Method in class groovyx.net.http.HttpContextDecorator
-
Groovy support for the index [] operator
- getAt(String) - Method in class groovyx.net.http.HttpResponseDecorator.HeadersDecorator
-
Access the named header value, using bracket form.
- getAt(Object) - Method in class groovyx.net.http.ParserRegistry
-
Retrieve a parser for the given response content-type string.
- getAttribute(String) - Method in class groovyx.net.http.HttpContextDecorator
-
- getAuth() - Method in class groovyx.net.http.HTTPBuilder
-
Used to access the
AuthConfig
handler used to configure common
authentication mechanism.
- getCatalogResolver() - Static method in class groovyx.net.http.ParserRegistry
-
Access the default catalog used by all HTTPBuilder instances.
- getCause() - Method in exception groovyx.net.http.ResponseParseException
-
- getCharset(HttpResponse) - Static method in class groovyx.net.http.ParserRegistry
-
Helper method to get the charset from the response.
- getClient() - Method in class groovyx.net.http.HTTPBuilder
-
Return the underlying HTTPClient that is used to handle HTTP requests.
- getContentEncoding() - Method in class groovyx.net.http.ContentEncoding
-
- getContentEncoding() - Method in class groovyx.net.http.DeflateEncoding
-
- getContentEncoding() - Method in class groovyx.net.http.GZIPEncoding
-
- getContentType() - Method in class groovyx.net.http.HTTPBuilder
-
- getContentType() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Get the content-type of any data sent in the request body and the
expected response content-type.
- getContentType() - Method in class groovyx.net.http.HttpResponseDecorator
-
Get the content-type for this response.
- getContentType() - Method in class groovyx.net.http.HttpURLClient
-
Get the default content-type used for parsing response data.
- getContentType(HttpResponse) - Static method in class groovyx.net.http.ParserRegistry
-
Helper method to get the content-type string from the response
(no charset).
- getContentTypeStrings() - Method in enum groovyx.net.http.ContentType
-
- getContext() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Get the
HttpContext
that will be used for this request.
- getContext() - Method in class groovyx.net.http.HttpResponseDecorator
-
Get the execution context used during this request
- getData() - Method in class groovyx.net.http.HttpResponseDecorator
-
Return the parsed data from this response body.
- getDefaultEncoders() - Method in class groovyx.net.http.ContentEncodingRegistry
-
- getDefaultParser() - Method in class groovyx.net.http.ParserRegistry
-
Get the default parser used for unregistered content-types.
- getEncoder() - Method in class groovyx.net.http.HTTPBuilder
-
Retrieve the map of registered request content-type encoders.
- getEncoders() - Method in class groovyx.net.http.HttpURLClient
-
Get the encoder registry used by this instance, which can be used
to directly modify the request serialization behavior.
- getEntity() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getFirstHeader(String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- getFragment() - Method in class groovyx.net.http.URIBuilder
-
- getHandler() - Method in class groovyx.net.http.HTTPBuilder
-
Retrieve the map of response code handlers.
- getHeaders() - Method in class groovyx.net.http.HTTPBuilder
-
Get the map of default headers that will be added to all requests.
- getHeaders() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
- getHeaders() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getHeaders(String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- getHeaders() - Method in class groovyx.net.http.HttpURLClient
-
Retrieve the default headers that will be sent in each request.
- getHost() - Method in class groovyx.net.http.URIBuilder
-
- getLastHeader(String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- getLocale() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getParams() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getParser() - Method in class groovyx.net.http.HTTPBuilder
-
Retrieve the map of registered response content-type parsers.
- getParsers() - Method in class groovyx.net.http.HttpURLClient
-
Retrieve the parser registry used by this instance, which can be used to
directly modify the parsing behavior.
- getPath() - Method in class groovyx.net.http.URIBuilder
-
Note that this property is
not necessarily reflexive
with the
URIBuilder.setPath(String)
method!
URIBuilder.setPath()
will resolve a relative path, whereas this method will always return the
full, absolute path.
- getPort() - Method in class groovyx.net.http.URIBuilder
-
- getProtocolVersion() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getQuery() - Method in class groovyx.net.http.URIBuilder
-
Get the query string as a map for convenience.
- getQueryNVP() - Method in class groovyx.net.http.URIBuilder
-
- getRequest() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Directly access the Apache HttpClient instance that will
be used to execute this request.
- getRequestContentType() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
- getRequestContentType() - Method in class groovyx.net.http.HttpURLClient
-
Get the default content-type used to serialize the request data.
- getRequestInterceptor() - Method in class groovyx.net.http.ContentEncoding
-
- getRequestType() - Method in enum groovyx.net.http.Method
-
Get the HttpRequest class that represents this request type.
- getResponse() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Access the response handler map to set response parsing logic.
- getResponse() - Method in exception groovyx.net.http.HttpResponseException
-
- getResponseInterceptor() - Method in class groovyx.net.http.ContentEncoding
-
- getScheme() - Method in class groovyx.net.http.URIBuilder
-
Get the scheme for this URI.
- getSchemeRegistry() - Method in class groovyx.net.http.thirdparty.GAEConnectionManager
-
- getStatus() - Method in class groovyx.net.http.HttpResponseDecorator
-
Get the response status code.
- getStatusLine() - Method in class groovyx.net.http.HttpResponseDecorator
-
- getThreadExecutor() - Method in class groovyx.net.http.AsyncHTTPBuilder
-
Access the underlying threadpool to adjust things like job timeouts.
- getTimeout() - Method in class groovyx.net.http.AsyncHTTPBuilder
-
Get the timeout in for establishing an HTTP connection.
- getUri() - Method in class groovyx.net.http.HTTPBuilder
-
Get the default URI used for requests that do not explicitly take a
uri
param.
- getUri() - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Use this object to manipulate parts of the request URI, like
query params and request path.
- getUrl() - Method in class groovyx.net.http.HttpURLClient
-
The default URL for this request.
- getUserInfo() - Method in class groovyx.net.http.URIBuilder
-
- groovyx.net.http - package groovyx.net.http
-
HTTPBuilder provides a simple Groovy API for HTTP and REST client operations.
- groovyx.net.http.thirdparty - package groovyx.net.http.thirdparty
-
- GZIPEncoding - Class in groovyx.net.http
-
Content encoding used to handle GZIP responses.
- GZIPEncoding() - Constructor for class groovyx.net.http.GZIPEncoding
-
- parseForm(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Default parser used to decode a URL-encoded response.
- parseHTML(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Parse an HTML document by passing it through the NekoHTML parser.
- parseJSON(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Default parser used to decode a JSON response.
- parseResponse(HttpResponse, Object) - Method in class groovyx.net.http.HTTPBuilder
-
Parse the response data based on the given content-type.
- ParserRegistry - Class in groovyx.net.http
-
Keeps track of response parsers for each content type.
- ParserRegistry() - Constructor for class groovyx.net.http.ParserRegistry
-
- parsers - Variable in class groovyx.net.http.HTTPBuilder
-
- parseStream(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Default parser used for binary data.
- parseText(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Default parser used to handle plain text data.
- parseXML(HttpResponse) - Method in class groovyx.net.http.ParserRegistry
-
Default parser used to decode an XML response.
- patch(Map<String, ?>) - Method in class groovyx.net.http.RESTClient
-
Convenience method to perform a PATCH request.
- post(Map<String, ?>) - Method in class groovyx.net.http.HTTPBuilder
-
Convenience method to perform an HTTP POST.
- post(Map<String, ?>, Closure) - Method in class groovyx.net.http.HTTPBuilder
-
Convenience method to perform an HTTP form POST.
- post(Map<String, ?>) - Method in class groovyx.net.http.RESTClient
-
Convenience method to perform a POST request.
- process(HttpRequest, HttpContext) - Method in class groovyx.net.http.ContentEncoding.RequestInterceptor
-
- process(HttpResponse, HttpContext) - Method in class groovyx.net.http.ContentEncoding.ResponseInterceptor
-
- propertyMissing(Object) - Method in class groovyx.net.http.EncoderRegistry
-
- propertyMissing(Object, Closure) - Method in class groovyx.net.http.EncoderRegistry
-
- propertyMissing(String) - Method in class groovyx.net.http.HttpResponseDecorator.HeadersDecorator
-
Allow property-style access to header values.
- propertyMissing(Object) - Method in class groovyx.net.http.ParserRegistry
-
- propertyMissing(Object, Closure) - Method in class groovyx.net.http.ParserRegistry
-
- put(Map<String, ?>) - Method in class groovyx.net.http.RESTClient
-
Convenience method to perform a PUT request.
- putAt(Object, Closure) - Method in class groovyx.net.http.EncoderRegistry
-
Register a new encoder for the given content type.
- putAt(Object, Closure) - Method in class groovyx.net.http.ParserRegistry
-
Register a new parser for the given content-type.
- send(Object, Object) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Convenience method to set a request content-type at the same time
the request body is set.
- setAt(String, Object) - Method in class groovyx.net.http.HttpContextDecorator
-
Groovy support for the index [] operator
- setAttribute(String, Object) - Method in class groovyx.net.http.HttpContextDecorator
-
- setAuthConfig(AuthConfig) - Method in class groovyx.net.http.HTTPBuilder
-
Set an alternative
AuthConfig
implementation to handle
authorization.
- setAutoAcceptHeader(boolean) - Method in class groovyx.net.http.HTTPBuilder
-
Indicate whether or not this cliernt should send an
Accept
header automatically based on the
contentType
property.
- setBasicAuth(Object, Object) - Method in class groovyx.net.http.HttpURLClient
-
Set basic user and password authorization to be used for every request.
- setBody(Object) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Set the request body.
- setCharset(String) - Method in class groovyx.net.http.EncoderRegistry
-
Set the charset used in the content-type header of all requests that send
textual data.
- setClient(HttpClient) - Method in class groovyx.net.http.HTTPBuilder
-
- setContentEncoding(Object...) - Method in class groovyx.net.http.HTTPBuilder
-
Set acceptable request and response content-encodings.
- setContentEncodingRegistry(ContentEncodingRegistry) - Method in class groovyx.net.http.HTTPBuilder
-
Set a custom registry used to handle different
content-encoding
types in responses.
- setContentType(Object) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Set the content-type used for any data in the request body, as well
as the Accept
content-type that will be used for parsing
the response.
- setContentType(Object) - Method in class groovyx.net.http.HTTPBuilder
-
Set the default content type that will be used to select the appropriate
request encoder and response parser.
- setContentType(Object) - Method in class groovyx.net.http.HttpURLClient
-
Set the default content-type used to control response parsing and request
serialization behavior.
- setContext(HttpContext) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Set the
HttpContext
that will be used for this request.
- setDefaultCharset(String) - Static method in class groovyx.net.http.ParserRegistry
-
Set the charset to use for parsing character streams when no charset
is given in the Content-Type header.
- setDefaultParser(Closure) - Method in class groovyx.net.http.ParserRegistry
-
Set the default parser used for unregistered content-types.
- setEncoderRegistry(EncoderRegistry) - Method in class groovyx.net.http.HTTPBuilder
-
Set a custom registry used to handle different request
content-type
s.
- setEncoders(EncoderRegistry) - Method in class groovyx.net.http.HttpURLClient
-
- setEntity(HttpEntity) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setFollowRedirects(boolean) - Method in class groovyx.net.http.HttpURLClient
-
Control whether this instance should automatically follow redirect
responses.
- setFragment(String) - Method in class groovyx.net.http.URIBuilder
-
The document fragment, without a preceeding '#'.
- setHeader(Header) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setHeader(String, String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setHeaders(Map<?, ?>) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Set request headers.
- setHeaders(Map<?, ?>) - Method in class groovyx.net.http.HTTPBuilder
-
Set the default headers to add to all requests made by this builder
instance.
- setHeaders(Header[]) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setHeaders(Map<?, ?>) - Method in class groovyx.net.http.HttpURLClient
-
Set default headers to be sent with every request.
- setHost(String) - Method in class groovyx.net.http.URIBuilder
-
Set the host portion of this URI.
- setLocale(Locale) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setOAuth(Object, Object, Object, Object) - Method in class groovyx.net.http.HttpURLClient
-
Sign all outbound requests with the given OAuth keys and tokens.
- setParams(HttpParams) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setParserRegistry(ParserRegistry) - Method in class groovyx.net.http.HTTPBuilder
-
Set a custom registry used to handle different response
content-type
s
- setParsers(ParserRegistry) - Method in class groovyx.net.http.HttpURLClient
-
- setPath(String) - Method in class groovyx.net.http.URIBuilder
-
Set the path component of this URI.
- setPort(int) - Method in class groovyx.net.http.URIBuilder
-
Set the port for this URI, or -1
to unset the port.
- setPropertiesFromMap(Map<String, ?>) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Valid arguments:
uriEither a URI, URL, or object whose
toString()
method produces a valid URI string.
- setProxy(String, int, String) - Method in class groovyx.net.http.HTTPBuilder
-
Set the default HTTP proxy to be used for all requests.
- setQuery(Map<?, ?>) - Method in class groovyx.net.http.URIBuilder
-
Set the query portion of the URI.
- setQueryNVP(List<NameValuePair>) - Method in class groovyx.net.http.URIBuilder
-
- setRawQuery(String) - Method in class groovyx.net.http.URIBuilder
-
Set the raw, already-escaped query string.
- setReasonPhrase(String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setRequestContentType(Object) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Assign a different content-type for the request than is expected for
the response.
- setRequestContentType(Object) - Method in class groovyx.net.http.HttpURLClient
-
Set the default content-type used to control request body serialization.
- setScheme(String) - Method in class groovyx.net.http.URIBuilder
-
Set the URI scheme, AKA the 'protocol.' e.g.
- setStatusCode(int) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setStatusLine(StatusLine) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setStatusLine(ProtocolVersion, int) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setStatusLine(ProtocolVersion, int, String) - Method in class groovyx.net.http.HttpResponseDecorator
-
- setTimeout(int) - Method in class groovyx.net.http.AsyncHTTPBuilder
-
This timeout is used for both the time to wait for an established
connection, and the time to wait for data.
- setUri(Object) - Method in class groovyx.net.http.HTTPBuilder.RequestConfigDelegate
-
Set the entire URI to be used for this request.
- setUri(Object) - Method in class groovyx.net.http.HTTPBuilder
-
Set the default URI used for requests that do not explicitly take a
uri
param.
- setUrl(Object) - Method in class groovyx.net.http.HttpURLClient
-
Set the default request URL.
- setUserInfo(String) - Method in class groovyx.net.http.URIBuilder
-
Set the userInfo portion of the URI, or null
if the URI
should have no user information.
- shutdown() - Method in class groovyx.net.http.AsyncHTTPBuilder
-
Release any system resources held by this instance.
- shutdown() - Method in class groovyx.net.http.HTTPBuilder
-
Release any system resources held by this instance.
- shutdown() - Method in class groovyx.net.http.thirdparty.GAEConnectionManager
-
- Status - Enum in groovyx.net.http
-
Mapping of HTTP response codes to a constant 'success' or 'failure' value.