Index (Atlassian HTTP Client API 0.17.0-ACDEV-250-m01 API)

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

A

ACCEPT - Static variable in class com.atlassian.httpclient.api.Headers.Name
add(String, String) - Method in interface com.atlassian.httpclient.api.Headers.Builder
addAll(Iterable<Pair<String, String>>) - Method in interface com.atlassian.httpclient.api.Headers.Builder
addAll(Map<String, String>) - Method in interface com.atlassian.httpclient.api.Headers.Builder
addParam(String) - Method in interface com.atlassian.httpclient.api.FormBuilder: Adds a value-less parameter.
addParam(String, String) - Method in interface com.atlassian.httpclient.api.FormBuilder: Adds a parameter and its value.
Attributes - Interface in com.atlassian.httpclient.api: Attributes are request metadata that are forwarded to the analytics plugin when enabled.
attributes() - Method in interface com.atlassian.httpclient.api.Request: Gets all attributes for this request.

B

badRequest(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'bad request' (400) HTTP responses.
build() - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder
builder() - Static method in class com.atlassian.httpclient.api.ResponseTransformation.Builder
Builders - Interface in com.atlassian.httpclient.api
builders() - Method in interface com.atlassian.httpclient.api.HttpClient

C

clientError(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'client error' (4xx) HTTP responses.
code - Variable in enum com.atlassian.httpclient.api.HttpStatus
com.atlassian.httpclient.api - package com.atlassian.httpclient.api
com.atlassian.httpclient.api.factory - package com.atlassian.httpclient.api.factory
compose(Iterable<Function<A, Option<B>>>) - Static method in class com.atlassian.httpclient.api.PartialFunctions
conflict(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'conflict' (409) HTTP responses.
CONTENT_TYPE - Static variable in class com.atlassian.httpclient.api.Headers.Name
contentCharset() - Method in interface com.atlassian.httpclient.api.Headers: Returns the currently set content charset value, if any.
contentLength() - Method in interface com.atlassian.httpclient.api.Headers
contentType() - Method in interface com.atlassian.httpclient.api.Headers: Returns the IANA media type, minus charset information, for the current entity, if any.
create(HttpClientOptions) - Method in interface com.atlassian.httpclient.api.factory.HttpClientFactory: Creates a new instance of HttpClient
create(HttpClientOptions, ThreadLocalContextManager<?>) - Method in interface com.atlassian.httpclient.api.factory.HttpClientFactory: Creates a new instance of HttpClient
created(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'created' (201) HTTP responses.

D

delegate() - Method in class com.atlassian.httpclient.api.ForwardingHttpClient
delete() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to DELETE
done(Function<Response, O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform all completed (1xx, 2xx, 3xx, 4xx, and 5xx) HTTP responses.

E

Entity - Interface in com.atlassian.httpclient.api
entity() - Method in interface com.atlassian.httpclient.api.Message: Returns the current entity if available
Entity.Builder - Interface in com.atlassian.httpclient.api
error(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform all error (4xx and 5xx) HTTP responses.
execute(Request) - Method in class com.atlassian.httpclient.api.ForwardingHttpClient
execute(Request) - Method in interface com.atlassian.httpclient.api.HttpClient: Executes this request through the HttpClient service.

F

fail(Function<Throwable, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform exceptions thrown while executing the HTTP request.
forbidden(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'forbidden' (403) HTTP responses.
FormBuilder - Interface in com.atlassian.httpclient.api: Builds url-encoded form entities for use as HTTP request message bodies.
ForwardingHttpClient - Class in com.atlassian.httpclient.api: An HTTP Client which forwards all its method calls to another HTTP Client.
ForwardingHttpClient() - Constructor for class com.atlassian.httpclient.api.ForwardingHttpClient: Constructor for use by subclasses.
from(Predicate<A>, Function<? super A, ? extends B>) - Static method in class com.atlassian.httpclient.api.PartialFunctions
fromCode(int) - Static method in enum com.atlassian.httpclient.api.HttpStatus

G

get(String) - Method in interface com.atlassian.httpclient.api.Attributes
get(String) - Method in interface com.atlassian.httpclient.api.Headers
get() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to GET
getAccept() - Method in interface com.atlassian.httpclient.api.Request: Returns this request's Accept header, if set.
getCallbackExecutor() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getConnectionPoolTimeToLive() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getConnectionTimeout() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getIoSelectInterval() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions: Determines time interval in milliseconds at which the I/O reactor wakes up to check for timed out sessions and session requests.
getIoThreadCount() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions: Determines the number of I/O dispatch threads to be used by the I/O reactor.
getLeaseTimeout() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getMaxCacheEntries() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getMaxCacheObjectSize() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getMaxConnectionsPerHost() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getMaxEntitySize() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getRequestPreparer() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getRequestTimeout() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getResponse() - Method in exception com.atlassian.httpclient.api.UnexpectedResponseException: Returns the unexpected response
getSocketTimeout() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getThreadPrefix() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
getUserAgent() - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions

H

head() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to HEAD
headers() - Method in interface com.atlassian.httpclient.api.Builders
headers() - Method in interface com.atlassian.httpclient.api.Entity
Headers - Interface in com.atlassian.httpclient.api
headers() - Method in interface com.atlassian.httpclient.api.Message: Returns a map of all headers that have been set on this object.
Headers.Builder - Interface in com.atlassian.httpclient.api
Headers.Name - Class in com.atlassian.httpclient.api
Headers.Name() - Constructor for class com.atlassian.httpclient.api.Headers.Name
HttpClient - Interface in com.atlassian.httpclient.api: A service providing asynchronous HTTP request creation and execution.
HttpClientFactory - Interface in com.atlassian.httpclient.api.factory: Creates configured instances of HttpClient
HttpClientOptions - Class in com.atlassian.httpclient.api.factory: Configuration options for the http client instance and its caching system
HttpClientOptions() - Constructor for class com.atlassian.httpclient.api.factory.HttpClientOptions
HttpStatus - Enum in com.atlassian.httpclient.api: HTTP Status code, for reference see: the wikipedia page. Hypertext Transfer Protocol -- HTTP/1.1, RFC 2616 HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV), RFC 4918 Binding Extensions to Web Distributed Authoring and Versioning (WebDAV), RFC 5842 Delta encoding in HTTP, RFC 3229

I

informational(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'informational' (1xx) HTTP responses.
inputStream() - Method in interface com.atlassian.httpclient.api.Entity
internalServerError(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'internal server error' (500) HTTP responses.
isBadRequest() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Bad Request".
isClientError() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as "Client Error" (4xx).
isConflict() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Conflict".
isCreated() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Created".
isError() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as either "Client Error" or "Server Error".
isForbidden() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Forbidden".
isInformational() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as "Informational" (1xx).
isInternalServerError() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Internal Server Error".
isNoContent() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "No Content".
isNotFound() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Not Found".
isNotModified() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Not Modified".
isNotSuccessful() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as one of "Informational", "Redirection", "Client Error" or "Server Error".
isOk() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "OK".
isRedirection() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as "Redirection" (3xx).
isSeeOther() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "See Other".
isServerError() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as "Server Error" (5xx).
isServiceUnavailable() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Service Unavailable".
isSuccessful() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is categorized as "Successful" (2xx).
isUnauthorized() - Method in interface com.atlassian.httpclient.api.Response: Indicates whether or not this response's status code is "Unauthorized".

M

Message - Interface in com.atlassian.httpclient.api: An abstract base class for HTTP messages (i.e.
Message.Builder - Interface in com.atlassian.httpclient.api
method() - Method in interface com.atlassian.httpclient.api.Request

N

newRequest() - Method in interface com.atlassian.httpclient.api.RequestFactory: Constructs a new request.
newRequest(URI) - Method in interface com.atlassian.httpclient.api.RequestFactory: Constructs a new Request with the specified URI.
newRequest(String) - Method in interface com.atlassian.httpclient.api.RequestFactory: Constructs a new Request with the specified URI.
newRequest(URI, String, String) - Method in interface com.atlassian.httpclient.api.RequestFactory: Constructs a new Request with the specified URI, contentType, and entity.
newRequest(String, String, String) - Method in interface com.atlassian.httpclient.api.RequestFactory: Constructs a new Request with the specified URI, contentType, and entity.
noContent(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'no content' (204) HTTP responses.
notFound(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'not found' (404) HTTP responses.
notModified(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'not modified' (304) HTTP responses.
notSuccessful(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform all non-'successful' (1xx, 3xx, 4xx, 5xx) HTTP responses.

O

ok(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'ok' (200) HTTP responses.
on(HttpStatus, Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform HTTP responses with a specific status.
on(int, Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform HTTP responses with a specific status code.
options() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to OPTIONS
others(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform all other HTTP responses (i.e.
otherwise(Function<Throwable, O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform both of the following events: Any value passed to fail() Any value passed to others(), converted into an exception

P

PartialFunctions - Class in com.atlassian.httpclient.api
PartialFunctions() - Constructor for class com.atlassian.httpclient.api.PartialFunctions
post() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to POST
put() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to PUT

R

redirection(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'redirection' (3xx) HTTP responses.
request() - Method in interface com.atlassian.httpclient.api.Builders
Request - Interface in com.atlassian.httpclient.api: An interface for building and executing HTTP requests.
Request.Builder - Interface in com.atlassian.httpclient.api
Request.Method - Enum in com.atlassian.httpclient.api
RequestFactory - Interface in com.atlassian.httpclient.api: Convenient factory methods for creating a Request.Builder with common defaults.
Response - Interface in com.atlassian.httpclient.api: Represents the result of an HTTP request.
Response.Builder - Interface in com.atlassian.httpclient.api
ResponseTransformation<O> - Interface in com.atlassian.httpclient.api: Transforms the Promise into a target object, allowing for transforming functions based on different HTTP codes or exceptions.
ResponseTransformation.Builder<O> - Class in com.atlassian.httpclient.api
ResponseTransformation.Builder() - Constructor for class com.atlassian.httpclient.api.ResponseTransformation.Builder
ResponseTransformationException - Exception in com.atlassian.httpclient.api
ResponseTransformationException(Throwable) - Constructor for exception com.atlassian.httpclient.api.ResponseTransformationException

S

seeOther(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'see other' (303) HTTP responses.
serverError(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'server error' (5xx) HTTP responses.
serviceUnavailable(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'service unavailable' (503) HTTP responses.
setAccept(String) - Method in interface com.atlassian.httpclient.api.Headers.Builder: Sets the Accept for this object's entity, if any.
setAccept(String) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets the Accept header for the request.
setAttribute(String, String) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets an attribute on the request.
setAttributes(Map<String, String>) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets attributes on the request.
setCallbackExecutor(ExecutorService) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setConnectionPoolTimeToLive(int, TimeUnit) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setConnectionTimeout(int, TimeUnit) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions: Sets how long, in milliseconds, to wait for a TCP connection
setContentCharset(String) - Method in interface com.atlassian.httpclient.api.Headers.Builder: Sets the charset for this object's entity, if any.
setContentType(String) - Method in interface com.atlassian.httpclient.api.Headers.Builder: Sets the IANA media type, for the current entity, if any.
setEntity(String) - Method in interface com.atlassian.httpclient.api.Request.Builder
setIoSelectInterval(int, TimeUnit) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions: Defines time interval in milliseconds at which the I/O reactor wakes up to check for timed out sessions and session requests.
setIoThreadCount(int) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setLeaseTimeout(long) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setMaxCacheEntries(int) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setMaxCacheObjectSize(long) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setMaxConnectionsPerHost(int) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setMaxEntitySize(int) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions: param maxEntitySize The maximum entity size in bytes
setMethod(Request.Method) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method
setParam(String, Iterable<String>) - Method in interface com.atlassian.httpclient.api.FormBuilder: Sets multiple values for the named parameter, resetting any existing values in the process.
setRequestPreparer(Effect<Request>) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setRequestTimeout(int, TimeUnit) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setSocketTimeout(int, TimeUnit) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setStatusCode(int) - Method in interface com.atlassian.httpclient.api.Response.Builder: Sets the status code of the response.
setStatusText(String) - Method in interface com.atlassian.httpclient.api.Response.Builder: Sets the status text of the response.
setThreadPrefix(String) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
setUserAgent(String) - Method in class com.atlassian.httpclient.api.factory.HttpClientOptions
statusCode() - Method in interface com.atlassian.httpclient.api.Response: Gets the status code of the response.
statusText() - Method in interface com.atlassian.httpclient.api.Response: Gets the status text of the response.
successful(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'successful' (2xx) HTTP responses.

T

toString() - Method in enum com.atlassian.httpclient.api.HttpStatus
toString() - Method in exception com.atlassian.httpclient.api.UnexpectedResponseException
trace() - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's Method to TRACE
transform() - Method in interface com.atlassian.httpclient.api.Builders
transform(Promise<Response>) - Method in interface com.atlassian.httpclient.api.ResponseTransformation

U

unauthorized(Function<Response, ? extends O>) - Method in class com.atlassian.httpclient.api.ResponseTransformation.Builder: Register a function to transform 'unauthorized' (401) HTTP responses.
UnexpectedResponseException - Exception in com.atlassian.httpclient.api: Thrown to indicate that a response completed normally but that produced an unexpected status code.
UnexpectedResponseException(Response) - Constructor for exception com.atlassian.httpclient.api.UnexpectedResponseException: Creates a new exception for the given response.
uri(URI) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's URI.
uri() - Method in interface com.atlassian.httpclient.api.Request: Returns this request's URI, if set.
url(String) - Method in interface com.atlassian.httpclient.api.Request.Builder: Sets this request's URI.

V

valueOf(String) - Static method in enum com.atlassian.httpclient.api.HttpStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.atlassian.httpclient.api.Request.Method: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.atlassian.httpclient.api.HttpStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.atlassian.httpclient.api.Request.Method: Returns an array containing the constants of this enum type, in the order they are declared.

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