Index (Netty Http Client 2.9.7 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

ActivityMonitor - Interface in com.mastfrog.netty.http.client: Allows network activity to be monitored in an HTTP client
add(Cookie) - Method in class com.mastfrog.netty.http.client.CookieStore
addActivityMonitor(ActivityMonitor) - Method in class com.mastfrog.netty.http.client.HttpClient
addHeader(HeaderValueType<T>, T) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Add a request header.
addMarshaller(Class<T>, Marshaller<T, ByteBuf>) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the marshaller used to convert inbound and outbound message bodies to / from objects.
addPathElement(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Append a path element to the URL
addQueryPair(String, String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Add a query key/value pair to the URL
addQueryPairs(Map<String, Object>, Function<Object, String>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder
addQueryPairs(Map<String, String>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder
addRequestInterceptor(RequestInterceptor) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Add an interceptor which should get a chance to process every request before it is invoked; useful for things that sign requests and such.
await() - Method in class com.mastfrog.netty.http.client.ResponseFuture: Wait for the channel to be closed.
await() - Method in class com.mastfrog.netty.http.client.ResponseHandler
await(long, TimeUnit) - Method in class com.mastfrog.netty.http.client.ResponseFuture: Wait for a timeout for the request to be complleted.
await(long, TimeUnit) - Method in class com.mastfrog.netty.http.client.ResponseHandler
AwaitingResponse - Enum constant in enum com.mastfrog.netty.http.client.StateType: The request has been sent.

B

basicAuthentication(String, String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set basic auth credentials
build() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Build an HTTP client
builder() - Static method in class com.mastfrog.netty.http.client.HttpClient: Create a builder to configure connecting

C

cancel() - Method in class com.mastfrog.netty.http.client.ResponseFuture: Cancel the associated request.
Cancelled - Enum constant in enum com.mastfrog.netty.http.client.StateType: The call was cancelled; useful for cleaning up resources.
checkDomain() - Method in class com.mastfrog.netty.http.client.CookieStore
checkPath() - Method in class com.mastfrog.netty.http.client.CookieStore: Returns a new CookieStore which will check the path parameter of cookies when deciding to add them to a request.
ChunkedContent - Interface in com.mastfrog.netty.http.client
Closed - Enum constant in enum com.mastfrog.netty.http.client.StateType: The connection was closed.
com.mastfrog.netty.http.client - package com.mastfrog.netty.http.client: Async HTTP Client
compareTo(ResponseFuture) - Method in class com.mastfrog.netty.http.client.ResponseFuture
Connected - Enum constant in enum com.mastfrog.netty.http.client.StateType: A connection has been made.
Connecting - Enum constant in enum com.mastfrog.netty.http.client.StateType: A connection has not been made yet.
ContentReceived - Enum constant in enum com.mastfrog.netty.http.client.StateType: One chunk of content has been received - not necessarily the entire response, but some content.
CookieStore - Class in com.mastfrog.netty.http.client: Stores cookies from responses and decorates requests with them where appropriate.
CookieStore() - Constructor for class com.mastfrog.netty.http.client.CookieStore: Create a cookie store which will check domains and paths when adding cookies.
CookieStore(boolean, boolean) - Constructor for class com.mastfrog.netty.http.client.CookieStore: Create a cookie store.

D

delete() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP DELETE request
dontAggregateResponse() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: If called, the request builder will not aggregate http chunks, and the full http response will not be sent to listeners.
dontCheckDomain() - Method in class com.mastfrog.netty.http.client.CookieStore
dontCheckPath() - Method in class com.mastfrog.netty.http.client.CookieStore: Returns a new CookieStore which does not check the path parameter of cookies when deciding to add them to a request.
dontFollowRedirects() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Turn off following of redirects
dontSend100Continue() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Turn off the default behavior of setting the Expect: 100-CONTINUE header when

E

equals(Object) - Method in class com.mastfrog.netty.http.client.CookieStore
Error - Enum constant in enum com.mastfrog.netty.http.client.StateType: An exception was thrown.
errorHandler(Receiver<Throwable>) - Method in class com.mastfrog.netty.http.client.CookieStore: Add a handler which will be called if an exception is thrown when parsing cookies - i.e.
execute() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Launch the request
execute(ResponseHandler<?>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Launch the request

F

Finished - Enum constant in enum com.mastfrog.netty.http.client.StateType: Similar to FullContentReceived, this event gives you a Netty FullHttpRequest with the entire response.
followRedirects() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: HTTP requests will transparently load a redirects.
FullContentReceived - Enum constant in enum com.mastfrog.netty.http.client.StateType: The entire content of the response has arrived.

G

get() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP GET request
get() - Method in class com.mastfrog.netty.http.client.State
get(String) - Method in class com.mastfrog.netty.http.client.CookieStore

H

hashCode() - Method in class com.mastfrog.netty.http.client.CookieStore
head() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP HEAD request Spi
HeadersReceived - Enum constant in enum com.mastfrog.netty.http.client.StateType: The response headers have been received, but the response body has not yet (or there will not be one).
HttpClient - Class in com.mastfrog.netty.http.client: A simple asynchronous HTTP client with an emphasis on ease of use and a simple callback-based API to discourage blocking calls - use HttpClient.builder() to configure and create an instance.
HttpClient() - Constructor for class com.mastfrog.netty.http.client.HttpClient
HttpClient(boolean, int, int, int, int, boolean, CharSequence, List<RequestInterceptor>, Iterable<HttpClientBuilder.ChannelOptionSetting<?>>, boolean, CookieStore, Duration, SslContext, AddressResolverGroup<?>, NioEventLoopGroup, int, NettyContentMarshallers, ObjectMapper) - Constructor for class com.mastfrog.netty.http.client.HttpClient: Create a new HTTP client; prefer HttpClient.builder() where possible, as that is much simpler.HttpClientBuilder will remain backward compatible; this constructor may be changed if new parameters are needed (all state of an HTTP client is immutable and must be passed to the constructor).
HttpClientBuilder - Class in com.mastfrog.netty.http.client: Builds an HTTP client.
HttpClientBuilder() - Constructor for class com.mastfrog.netty.http.client.HttpClientBuilder
HttpClientBuilder.ChannelOptionSetting<T> - Class in com.mastfrog.netty.http.client: Encapsulates a setting that can be set on the Netty Bootstrap; not really an API class, but exposed so that the HttpClient constructor can be invoked directly if someone wants to (using HttpClientBuilder is much easier).
HttpRequestBuilder - Interface in com.mastfrog.netty.http.client: Builds an HTTP request, allows for adding listeners for response events, and for launching such a request.

I

intercept(HttpRequest) - Method in interface com.mastfrog.netty.http.client.RequestInterceptor
internalReceive(HttpResponseStatus, HttpHeaders, ByteBuf) - Method in class com.mastfrog.netty.http.client.ResponseHandler
INVALID_REDIRECT_URL - Enum constant in enum com.mastfrog.netty.http.client.RedirectException.Kind
isEmpty() - Method in class com.mastfrog.netty.http.client.CookieStore
isFailure() - Method in enum com.mastfrog.netty.http.client.StateType
isResponseComplete() - Method in enum com.mastfrog.netty.http.client.StateType
iterator() - Method in class com.mastfrog.netty.http.client.CookieStore

K

kind() - Method in exception com.mastfrog.netty.http.client.RedirectException

L

lastState() - Method in class com.mastfrog.netty.http.client.ResponseFuture

M

maxChunkSize(int) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: The maximum size of a chunk in bytes.
maxHeadersSize(int) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the maximum size of headers in bytes
maxInitialLineLength(int) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the maximum length of the HTTP initial line, e.g.

N

name() - Method in class com.mastfrog.netty.http.client.State
nextChunk(int) - Method in interface com.mastfrog.netty.http.client.ChunkedContent
noCompression() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Turn off HTTP gzip or deflate compression
noConnectionHeader() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Don't send the connection header
noDateHeader() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Don't create a Date: header
noHostHeader() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Don't sent the host header from the URL

O

on(StateType, Receiver<T>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Add an event handler for a particular event, using enum constants.
on(StateType, Receiver<T>) - Method in class com.mastfrog.netty.http.client.ResponseFuture: Add a listener for a particular type of event
on(Class<? extends State<T>>, Receiver<T>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Add an event handler for a particular event
on(Class<? extends State<T>>, Receiver<T>) - Method in class com.mastfrog.netty.http.client.ResponseFuture
onAnyEvent(Receiver<State<?>>) - Method in class com.mastfrog.netty.http.client.ResponseFuture: Add a listener which is notified of all state changes (there are many!).
onEndRequest(URL) - Method in interface com.mastfrog.netty.http.client.ActivityMonitor
onError(Throwable) - Method in class com.mastfrog.netty.http.client.ResponseHandler
onErrorResponse(HttpResponseStatus, HttpHeaders, String) - Method in class com.mastfrog.netty.http.client.ResponseHandler
onErrorResponse(HttpResponseStatus, String) - Method in class com.mastfrog.netty.http.client.ResponseHandler
onErrorResponse(String) - Method in class com.mastfrog.netty.http.client.ResponseHandler
onEvent(Receiver<State<?>>) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Add an event handler which will be called for every event
onStartRequest(URL) - Method in interface com.mastfrog.netty.http.client.ActivityMonitor
option() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder.ChannelOptionSetting
options() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP OPTIONS request

P

post() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP POST request
put() - Method in class com.mastfrog.netty.http.client.HttpClient: Build an HTTP PUT request

R

read(InputStream) - Method in class com.mastfrog.netty.http.client.CookieStore
receive(HttpResponseStatus, HttpHeaders, T) - Method in class com.mastfrog.netty.http.client.ResponseHandler
receive(HttpResponseStatus, T) - Method in class com.mastfrog.netty.http.client.ResponseHandler
receive(T) - Method in class com.mastfrog.netty.http.client.ResponseHandler
Redirect - Enum constant in enum com.mastfrog.netty.http.client.StateType: The response was a 300-307 HTTP redirect and the redirect is being followed.
REDIRECT_LOOP - Enum constant in enum com.mastfrog.netty.http.client.RedirectException.Kind
RedirectException - Exception in com.mastfrog.netty.http.client: Exception passed to onError when a redirect loop is encountered, or the redirect URL cannot be parsed.
RedirectException.Kind - Enum in com.mastfrog.netty.http.client
remove(String) - Method in class com.mastfrog.netty.http.client.CookieStore
removeActivityMonitor(ActivityMonitor) - Method in class com.mastfrog.netty.http.client.HttpClient
request(Method) - Method in class com.mastfrog.netty.http.client.HttpClient
RequestInterceptor - Interface in com.mastfrog.netty.http.client: Object which can be attached to an HttpClient which intercept all requests and can modify them before they are sent
resolveAllHostsToLocalhost() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: For test environments using multiple host names - attaches a DNS resolver that will resolve all host name addresses to InetAddress.getLocalHost().
resolver(AddressResolver<T>) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the DNS resolver to use, bypassing the default one.the passed resolver will be used to resolve all host names by the resulting HttpClient.
resolver(AddressResolverGroup<? extends SocketAddress>) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the DNS resolver to use, bypassing the default one.the passed resolver will be used to resolve all host names by the resulting HttpClient.
ResponseFuture - Class in com.mastfrog.netty.http.client: Returned from launching an HTTP request; attach handlers using the on(Class<EventType>, Receiver<State<T>>)) method.
ResponseHandler<T> - Class in com.mastfrog.netty.http.client: Processes an HTTP response - can be passed to HttpRequestBuilder.execute().
ResponseHandler(Class<T>) - Constructor for class com.mastfrog.netty.http.client.ResponseHandler
ResponseHandler(Class<T>, ObjectMapper) - Constructor for class com.mastfrog.netty.http.client.ResponseHandler
ResponseHandler(Class<T>, NettyContentMarshallers) - Constructor for class com.mastfrog.netty.http.client.ResponseHandler

S

send100Continue() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Http requests will where appropriate set the Expect: 100-CONTINUE header
sendOn(StateType, Object) - Method in class com.mastfrog.netty.http.client.ResponseFuture: Send some objects through the channel once a given state is reached (if the state already has been, they will be sent immediately if the channel is not closed).
SendRequest - Enum constant in enum com.mastfrog.netty.http.client.StateType: About to send a request
setAnchor(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the anchor portion of the URL
setBody(Object, MimeType) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the request body.
setChannelOption(ChannelOption<T>, T) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set a low-level setting for the Netty pipeline.
setCookieStore(CookieStore) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set a cookie store which will be used for all HTTP requests on the resulting HttpClient (unless overriddeen in RequestBuilder).
setCookieStore(CookieStore) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set a cookie store which will be updated from Set-Cookie headers in the response, and which will decorate the request with any Cookies it has that match the request URL.
setEventLoopGroup(NioEventLoopGroup) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the thread pool used to perform network I/O.
setHost(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the host portion of the URL
setMaxRedirects(int) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the maximum number of redirects this client can encounter before it considers itself to be in a redirect loop and cancels the request, sending a cancelled event.
setObjectMapper(ObjectMapper) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the ObjectMapper used to read and write JSON.
setPassword(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the password that will be put in the URL - note this is distinct from basic authentication - it results in urls such as http://user:password@host/path
setPath(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the complete path of the URL (clobbering any earlier calls to add path elements)
setPort(int) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the port
setProtocol(Protocol) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the protocol.
setSslContext(SslContext) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the SSL context to use when accessing HTTPS addresses.
setTimeout(Duration) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the timeout for requests.
setTimeout(Duration) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder
setURL(URL) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the whole URL, clobbering any earlier settings
setURL(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the whole URL, clobbering any earlier settings
setUserAgent(String) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Set the user agent
setUserName(String) - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Set the user name that will be put in the URL - note this is distinct from basic authentication - it results in urls such as http://user:password@host/path
shutdown() - Method in class com.mastfrog.netty.http.client.HttpClient: Shut down any running connections
size() - Method in class com.mastfrog.netty.http.client.CookieStore
State<T> - Class in com.mastfrog.netty.http.client: Represents the current state of a request, used in notifications.
State.Connected - Class in com.mastfrog.netty.http.client: State event when a connection has been achieved; payload is the Channel; invoking close() on it will abort.
State.ContentReceived - Class in com.mastfrog.netty.http.client: State event triggered when one chunk of content has arrived; if the server is using chunked transfer encoding, this state will be fired once for each chunk; when the FullContentReceived event is fired, there will be no more ContentReceived events.
State.Error - Class in com.mastfrog.netty.http.client: State event triggered when an exception is thrown somewhere in processing of the request or response.
State.Finished - Class in com.mastfrog.netty.http.client: Convenience state event providing the entire response and its body as a FullHttpResponse.
State.FullContentReceived - Class in com.mastfrog.netty.http.client: State event triggered when the entire response body has arrived.
State.HeadersReceived - Class in com.mastfrog.netty.http.client: State event triggered when the response header has arrived, but not the response body.
State.Redirect - Class in com.mastfrog.netty.http.client: State event triggered when a redirect is followed.
State.SendRequest - Class in com.mastfrog.netty.http.client: State event when the HTTP request is about to be sent; payload is the HTTP request (you can still modify headers, etc at this point).
State.Timeout - Class in com.mastfrog.netty.http.client: State event triggered when a timeout occurs.
stateType() - Method in class com.mastfrog.netty.http.client.State
StateType - Enum in com.mastfrog.netty.http.client: Enumeration of states a request can be in.
stateValueType() - Method in enum com.mastfrog.netty.http.client.StateType: Get the type of the State object tied to this event
store(OutputStream) - Method in class com.mastfrog.netty.http.client.CookieStore

T

threadCount(int) - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: The number of worker threads for processing requests and responses.
throwIfError() - Method in class com.mastfrog.netty.http.client.ResponseFuture: If an error was encountered, throw it
Timeout - Enum constant in enum com.mastfrog.netty.http.client.StateType: Called when a timeout occurs.
toString() - Method in class com.mastfrog.netty.http.client.CookieStore
toString() - Method in class com.mastfrog.netty.http.client.State
toURL() - Method in interface com.mastfrog.netty.http.client.HttpRequestBuilder: Get the URL as it currently stands for this request
type() - Method in class com.mastfrog.netty.http.client.ResponseHandler
type() - Method in class com.mastfrog.netty.http.client.State
type() - Method in enum com.mastfrog.netty.http.client.StateType: Get the type of the data payload of this event

U

useCompression() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder: Turn on HTTP gzip or deflate compression

V

value() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder.ChannelOptionSetting
valueOf(String) - Static method in enum com.mastfrog.netty.http.client.RedirectException.Kind: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mastfrog.netty.http.client.StateType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mastfrog.netty.http.client.RedirectException.Kind: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mastfrog.netty.http.client.StateType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withWebsocketSupport() - Method in class com.mastfrog.netty.http.client.HttpClientBuilder

A B C D E F G H I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form