A B C D E F G H I L M P R S T U V W

A

ACCEPT_ENC_HDR - Static variable in class groovyx.net.http.ContentEncoding
 
addQueryParam(String, Object) - Method in class groovyx.net.http.URIBuilder
This will append a param to the existing query string.
addQueryParams(Map<String, ?>) - Method in class groovyx.net.http.URIBuilder
 
AsyncHTTPBuilder - Class in groovyx.net.http
This implementation makes all requests asynchronous by submitting jobs to a ThreadPoolExecutor.
AsyncHTTPBuilder(Map<String, ?>) - Constructor for class groovyx.net.http.AsyncHTTPBuilder
Accepts the following named parameters: poolSizeMax number of concurrent requests urlDefault request URL contentTypeDefault content type for requests and responses
auth - Variable in class groovyx.net.http.HTTPBuilder
 
AuthConfig - Class in groovyx.net.http
Encapsulates all configuration related to HTTP authentication methods.
AuthConfig(HTTPBuilder) - Constructor for class groovyx.net.http.AuthConfig
 
availableEncoders - Variable in class groovyx.net.http.ContentEncodingRegistry
 

B

base - Variable in class groovyx.net.http.URIBuilder
 
basic(String, String) - Method in class groovyx.net.http.AuthConfig
Set authentication credentials to be used for the current default host.
basic(String, int, String, String) - Method in class groovyx.net.http.AuthConfig
Set authentication credentials to be used for the given host and port.
buildDefaultEncoderMap() - Method in class groovyx.net.http.EncoderRegistry
Returns a map of default encoders.
buildDefaultParserMap() - Method in class groovyx.net.http.ParserRegistry
Returns a map of default parsers.
buildDefaultResponseHandlers() - Method in class groovyx.net.http.HTTPBuilder
 
builder - Variable in class groovyx.net.http.AuthConfig
 

C

certificate(String, String) - Method in class groovyx.net.http.AuthConfig
Sets a certificate to be used for SSL authentication.
client - Variable in class groovyx.net.http.HTTPBuilder
 
CONTENT_ENC_HDR - Static variable in class groovyx.net.http.ContentEncoding
 
ContentEncoding - Class in groovyx.net.http
Base class for handing content-encoding.
ContentEncoding() - Constructor for class groovyx.net.http.ContentEncoding
 
ContentEncoding.RequestInterceptor - Class in groovyx.net.http
Request interceptor that adds the correct Accept header to the outgoing request.
ContentEncoding.RequestInterceptor() - Constructor for class groovyx.net.http.ContentEncoding.RequestInterceptor
 
ContentEncoding.ResponseInterceptor - Class in groovyx.net.http
Response interceptor that filters the response stream to decode the compressed content before it is passed on to the parser.
ContentEncoding.ResponseInterceptor() - Constructor for class groovyx.net.http.ContentEncoding.ResponseInterceptor
 
ContentEncoding.Type - Enum in groovyx.net.http
Enumeration of common content-encodings.
contentEncodingHandler - Variable in class groovyx.net.http.HTTPBuilder
 
ContentEncodingRegistry - Class in groovyx.net.http
Keeps track of available content-encoding handlers.
ContentEncodingRegistry() - Constructor for class groovyx.net.http.ContentEncodingRegistry
 
ContentType - Enum in groovyx.net.http
Enumeration of common IANA content-types.
contentType - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 
convertToURI(Object) - Static method in class groovyx.net.http.URIBuilder
Attempts to convert a URL or String to a URI.
createEntity(ContentType, String) - Method in class groovyx.net.http.EncoderRegistry
Helper method used by encoder methods to creates an HttpEntity instance that encapsulates the request data.

D

DEFAULT_POOL_SIZE - Static variable in class groovyx.net.http.AsyncHTTPBuilder
Default pool size is one is not supplied in the constructor.
defaultContentType - Variable in class groovyx.net.http.HTTPBuilder
 
defaultFailureHandler(HttpResponse) - Method in class groovyx.net.http.HTTPBuilder
This is the default response.failure handler.
defaultParser - Variable in class groovyx.net.http.ParserRegistry
 
defaultRequestHeaders - Variable in class groovyx.net.http.HTTPBuilder
 
defaultResponseHandlers - Variable in class groovyx.net.http.HTTPBuilder
 
defaultSuccessHandler(HttpResponse, Object) - Method in class groovyx.net.http.HTTPBuilder
This is the default response.success handler.
defaultURI - Variable in class groovyx.net.http.HTTPBuilder
 
DeflateEncoding - Class in groovyx.net.http
Content encoding used to handle Deflate responses.
DeflateEncoding() - Constructor for class groovyx.net.http.DeflateEncoding
 
DeflateEncoding.InflaterEntity - Class in groovyx.net.http
Entity used to interpret a Deflate-encoded response
DeflateEncoding.InflaterEntity(HttpEntity) - Constructor for class groovyx.net.http.DeflateEncoding.InflaterEntity
 
doRequest(HTTPBuilder.SendDelegate) - Method in class groovyx.net.http.AsyncHTTPBuilder
Submits a Callable instance to the job pool, which in turn will call HTTPBuilder.doRequest(SendDelegate) in an asynchronous thread.
doRequest(URI, Method, Object, Closure) - Method in class groovyx.net.http.HTTPBuilder
Create a HTTPBuilder.SendDelegate from the given arguments, execute the config closure, then pass the delegate to HTTPBuilder.doRequest(SendDelegate), which actually executes the request.
doRequest(HTTPBuilder.SendDelegate) - Method in class groovyx.net.http.HTTPBuilder
All request methods delegate to this method.

E

encodeForm(Map<String, Object>) - Method in class groovyx.net.http.EncoderRegistry
Set the request body as a url-encoded list of parameters.
encodeJSON(Object) - Method in class groovyx.net.http.EncoderRegistry
Accepts a Map or a JavaBean object which is converted to JSON.
EncoderRegistry - Class in groovyx.net.http
This factory (or registry) handles request body "encoding." This is not to be confused with HTTP content-encoding header.
EncoderRegistry() - Constructor for class groovyx.net.http.EncoderRegistry
 
encoders - Variable in class groovyx.net.http.HTTPBuilder
 
encodeStream(Object) - Method in class groovyx.net.http.EncoderRegistry
Default request encoder for a binary stream.
encodeText(Object) - Method in class groovyx.net.http.EncoderRegistry
Default handler used for a plain text content-type.
encodeXML(Closure) - Method in class groovyx.net.http.EncoderRegistry
Executes the given closure and passes a bound StreamingMarkupBuilder.

F

finalize() - Method in class groovyx.net.http.AsyncHTTPBuilder
find(int) - Static method in enum groovyx.net.http.Status
Find the Status value that matches the given status code.
findResponseHandler(int) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Get the proper response handler for the response code.

G

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.
getAcceptHeader() - Method in enum groovyx.net.http.ContentType
Builds a string to be used as an HTTP Accept header value, i.e.
getAuth() - Method in class groovyx.net.http.HTTPBuilder
Used to access the AuthConfig handler used to configure common authentication mechanism.
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.
getContent() - Method in class groovyx.net.http.DeflateEncoding.InflaterEntity
returns a InflaterInputStream which wraps the original entity's content stream
getContent() - Method in class groovyx.net.http.GZIPEncoding.GZIPDecompressingEntity
returns a GZIPInputStream which wraps the original entity's content stream
getContentEncoding() - Method in class groovyx.net.http.ContentEncoding
 
getContentEncoding() - Method in class groovyx.net.http.DeflateEncoding
 
getContentEncoding() - Method in class groovyx.net.http.GZIPEncoding
Returns the Type#GZIP encoding string which is added to the Accept header by the base class.
getContentLength() - Method in class groovyx.net.http.DeflateEncoding.InflaterEntity
 
getContentLength() - Method in class groovyx.net.http.GZIPEncoding.GZIPDecompressingEntity
 
getContentType() - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Get the content-type of any data sent in the request body and the expected response content-type.
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
 
getDefaultEncoders() - Method in class groovyx.net.http.ContentEncodingRegistry
This implementation adds a GZIPEncoding and DeflateEncoding handler to the registry.
getEncoder() - Method in class groovyx.net.http.HTTPBuilder
Retrieve the map of registered request content-type encoders.
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.SendDelegate
Get request headers (including any default headers).
getParser() - Method in class groovyx.net.http.HTTPBuilder
Retrieve the map of registered response content-type parsers.
getQuery() - Method in class groovyx.net.http.URIBuilder
Get the query string as a map
getRequest() - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
 
getRequestContentType() - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
The request content-type, if different from the HTTPBuilder.SendDelegate.contentType.
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.SendDelegate
Access the response handler map to set response parsing logic.
getResponseInterceptor() - Method in class groovyx.net.http.ContentEncoding
 
getThreadPoolExecutor() - Method in class groovyx.net.http.AsyncHTTPBuilder
Access the underlying threadpool to adjust things like job timeouts.
getURL() - Method in class groovyx.net.http.HTTPBuilder
Get the default URL used for requests that do not explicitly take a url param.
getURL() - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Use this object to manipulate parts of the request URL, like query params and request path.
groovyx.net.http - package groovyx.net.http
Provides a simple Groovy API for HTTP/ REST client operations.
GZIPEncoding - Class in groovyx.net.http
Content encoding used to handle GZIP responses.
GZIPEncoding() - Constructor for class groovyx.net.http.GZIPEncoding
 
GZIPEncoding.GZIPDecompressingEntity - Class in groovyx.net.http
Entity used to interpret a GZIP-encoded response
GZIPEncoding.GZIPDecompressingEntity(HttpEntity) - Constructor for class groovyx.net.http.GZIPEncoding.GZIPDecompressingEntity
 

H

hasEncoding(HttpResponse, String) - Method in class groovyx.net.http.ContentEncoding.ResponseInterceptor
 
hasQueryParam(String) - Method in class groovyx.net.http.URIBuilder
 
headers - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 
HTTPBuilder - Class in groovyx.net.http
Groovy DSL for easily making HTTP requests, and handling request and response data.
HTTPBuilder() - Constructor for class groovyx.net.http.HTTPBuilder
 
HTTPBuilder(Object) - Constructor for class groovyx.net.http.HTTPBuilder
Give a default URL to be used for all request methods that don't explicitly take a URL parameter.
HTTPBuilder(Object, Object) - Constructor for class groovyx.net.http.HTTPBuilder
Give a default URL to be used for all request methods that don't explicitly take a URL parameter, and a default content-type to be used for request encoding and response parsing.
HTTPBuilder.SendDelegate - Class in groovyx.net.http
Encloses all properties and method calls used within the HTTPBuilder.request(Object, Method, Object, Closure) 'config' closure argument.
HTTPBuilder.SendDelegate(HttpRequestBase, Object, Map<String, String>, Map<String, Closure>) - Constructor for class groovyx.net.http.HTTPBuilder.SendDelegate
 

I

initThreadPools(int) - Method in class groovyx.net.http.AsyncHTTPBuilder
Initializes threading parameters for the HTTPClient's ThreadSafeClientConnManager, and this class' ThreadPoolExecutor.

L

log - Variable in class groovyx.net.http.HTTPBuilder
 
log - Variable in class groovyx.net.http.ParserRegistry
 

M

matches(int) - Method in enum groovyx.net.http.Status
Returns true if the numeric code matches the represented status (either success or failure).
Method - Enum in groovyx.net.http
Enumeration of valid HTTP methods that may be used in a request call.

P

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.
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.
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.
process(HttpRequest, HttpContext) - Method in class groovyx.net.http.ContentEncoding.RequestInterceptor
 
process(HttpResponse, HttpContext) - Method in class groovyx.net.http.ContentEncoding.ResponseInterceptor
 

R

register(String, Closure) - Method in class groovyx.net.http.EncoderRegistry
Used to set an additional encoder for the given content type.
register(String, Closure) - Method in class groovyx.net.http.ParserRegistry
Register a new parser for the given content-type.
registeredEncoders - Variable in class groovyx.net.http.EncoderRegistry
 
registeredParsers - Variable in class groovyx.net.http.ParserRegistry
 
removeQueryParam(String) - Method in class groovyx.net.http.URIBuilder
 
request(Method, Closure) - Method in class groovyx.net.http.HTTPBuilder
Make an HTTP request to the default URL and content-type.
request(Method, Object, Closure) - Method in class groovyx.net.http.HTTPBuilder
Make an HTTP request using the default URL, with the given method, content-type, and configuration.
request(Object, Method, Object, Closure) - Method in class groovyx.net.http.HTTPBuilder
Make a request for the given HTTP method and content-type, with additional options configured in the configClosure.
request - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 
requestContentType - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 
responseHandlers - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 

S

send(Object, Object) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Convenience method to set a request content-type at the same time the request body is set.
setAuthConfig(AuthConfig) - Method in class groovyx.net.http.HTTPBuilder
Set an alternative AuthConfig implementation to handle authorization.
setBody(Object) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
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.
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.SendDelegate
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.
setEncoderRegistry(EncoderRegistry) - Method in class groovyx.net.http.HTTPBuilder
Set a custom registry used to handle different request content-types.
setFragment(String) - Method in class groovyx.net.http.URIBuilder
The document fragment, without a preceeding '#'
setHeaders(Map<?, ?>) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
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.
setHost(String) - Method in class groovyx.net.http.URIBuilder
 
setParserRegistry(ParserRegistry) - Method in class groovyx.net.http.HTTPBuilder
Set a custom registry used to handle different response content-types
setPath(String) - Method in class groovyx.net.http.URIBuilder
 
setPort(int) - Method in class groovyx.net.http.URIBuilder
 
setPropertiesFromMap(Map<String, ?>) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Valid arguments: urlEither a URI, URL, or 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<String, ?>) - Method in class groovyx.net.http.URIBuilder
Set the query portion of the URI
setRequestContentType(String) - Method in class groovyx.net.http.HTTPBuilder.SendDelegate
Assign a different content-type for the request than is expected for the response.
setScheme(String) - Method in class groovyx.net.http.URIBuilder
AKA protocol
setURL(Object) - Method in class groovyx.net.http.HTTPBuilder
Set the default URL used for requests that do not explicitly take a url param.
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.
Status - Enum in groovyx.net.http
Mapping of HTTP response codes to a constant 'success' or 'failure' value.

T

threadPool - Variable in class groovyx.net.http.AsyncHTTPBuilder
 
toString() - Method in enum groovyx.net.http.ContentEncoding.Type
Prints the value as it should appear in an HTTP header
toString() - Method in enum groovyx.net.http.ContentType
 
toString() - Method in enum groovyx.net.http.Status
 
toString() - Method in class groovyx.net.http.URIBuilder
 
toURI() - Method in class groovyx.net.http.URIBuilder
 
toURL() - Method in class groovyx.net.http.URIBuilder
 

U

URIBuilder - Class in groovyx.net.http
This class implements a mutable URI.
URIBuilder(String) - Constructor for class groovyx.net.http.URIBuilder
 
URIBuilder(URL) - Constructor for class groovyx.net.http.URIBuilder
 
URIBuilder(URI) - Constructor for class groovyx.net.http.URIBuilder
 
url - Variable in class groovyx.net.http.HTTPBuilder.SendDelegate
 

V

valueOf(String) - Static method in enum groovyx.net.http.ContentEncoding.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum groovyx.net.http.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum groovyx.net.http.Method
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum groovyx.net.http.Status
Returns the enum constant of this type with the specified name.
values() - Static method in enum groovyx.net.http.ContentEncoding.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum groovyx.net.http.ContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum groovyx.net.http.Method
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum groovyx.net.http.Status
Returns an array containing the constants of this enum type, in the order they are declared.

W

wrapResponseEntity(HttpEntity) - Method in class groovyx.net.http.ContentEncoding
 
wrapResponseEntity(HttpEntity) - Method in class groovyx.net.http.DeflateEncoding
Wraps the raw entity in a DeflateEncoding.InflaterEntity.
wrapResponseEntity(HttpEntity) - Method in class groovyx.net.http.GZIPEncoding
Wraps the raw entity in a GZIPEncoding.GZIPDecompressingEntity.

A B C D E F G H I L M P R S T U V W

Copyright © 2008-2009. All Rights Reserved.