H

H2Module - Class in ratpack.h2

 

H2Module() - Constructor for class ratpack.h2.H2Module

 

H2Module(String, String, String) - Constructor for class ratpack.h2.H2Module

 

handle(Context) - Method in interface ratpack.core.handling.Handler

Handles the context.

handle(Context) - Method in class ratpack.core.handling.InjectionHandler

Invokes the custom "handle" method, extracting necessary parameters from the context to satisfy the call.

handle(Context) - Method in interface ratpack.core.handling.RequestLogger

Adds RequestLogger.log(RequestOutcome) as a context close action, effectively logging the request.

handle(Context) - Method in class ratpack.core.handling.ResponseTimer

Adds the number of milliseconds of elapsed time between Request.getTimestamp() and when the response is ready to be sent.

handle(Context) - Method in class ratpack.core.health.HealthCheckHandler

Renders health checks.

handle(Context) - Method in class ratpack.dropwizard.metrics.MetricsPrometheusHandler

 

handle(Context) - Method in class ratpack.dropwizard.metrics.MetricsWebsocketBroadcastHandler

 

handle(Context) - Method in class ratpack.groovy.handling.GroovyHandler

Delegates to GroovyHandler.handle(GroovyContext).

handle(Handler) - Method in interface ratpack.test.handling.RequestFixture

Invokes the given handler with a newly created Context based on the state of this fixture.

handle(Handler, Closure<?>) - Static method in interface ratpack.groovy.test.handling.GroovyRequestFixture

Unit test a Handler.

handle(Handler, Action<? super RequestFixture>) - Static method in interface ratpack.test.handling.RequestFixture

Unit test a single Handler.

handle(Action<? super Chain>, Closure<?>) - Static method in interface ratpack.groovy.test.handling.GroovyRequestFixture

Unit test a chain of handlers.

handle(Action<? super Chain>, Action<? super RequestFixture>) - Static method in interface ratpack.test.handling.RequestFixture

Unit test a Handler chain.

handle(GroovyContext) - Method in class ratpack.groovy.handling.GroovyHandler

The handle method to implement.

HandlebarsModule - Class in ratpack.handlebars

An extension module that provides support for Handlebars.java templating engine.

HandlebarsModule() - Constructor for class ratpack.handlebars.HandlebarsModule

 

HandlebarsModule.Config - Class in ratpack.handlebars

The configuration object for HandlebarsModule.

handlebarsTemplate(String) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(String, Object) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(String, Object, String) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(String, String, Consumer<? super ImmutableMap.Builder<String, Object>>) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(String, Consumer<? super ImmutableMap.Builder<String, Object>>) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(Map<String, ?>, String) - Static method in class ratpack.handlebars.Template

 

handlebarsTemplate(Map<String, ?>, String, String) - Static method in class ratpack.handlebars.Template

 

handleChain(Action<? super Chain>) - Method in interface ratpack.test.handling.RequestFixture

Similar to RequestFixture.handle(Handler), but for testing a handler chain.

handler(Class<? extends Handler>) - Method in interface ratpack.core.server.RatpackServerSpec

Sets the root handler by getting a handler of the given type from the server registry.

handler(Function<? super Registry, ? extends Handler>) - Method in interface ratpack.core.server.RatpackServerSpec

Sets the root handler to the return of the given function.

handler(Function<? super Registry, ? extends Handler>) - Method in interface ratpack.groovy.server.GroovyRatpackServerSpec

 

Handler - Interface in ratpack.core.handling

A handler participates in the processing of a request/response pair, operating on a Context.

HandlerDecorator - Interface in ratpack.core.handling

Decorates a handler, effectively wrapping it.

HandlerExceptionNotThrownException - Exception in ratpack.test.handling

Exception thrown when the HandlingResult.exception(type) is called but no exception was thrown.

HandlerExceptionNotThrownException() - Constructor for exception ratpack.test.handling.HandlerExceptionNotThrownException

 

HandlerFactory - Interface in ratpack.test.handling

An interface for creating a Ratpack Handler based on the contents of the received Request.

handlers() - Static method in class ratpack.groovy.Groovy.Script

Creates a handler defining function from a "handlers.groovy" Groovy script.

handlers(boolean) - Static method in class ratpack.groovy.Groovy.Script

Creates a handler defining function from a "handlers.groovy" Groovy script.

handlers(boolean, String) - Static method in class ratpack.groovy.Groovy.Script

Creates a handler defining function from a Groovy script.

handlers(Closure<?>) - Method in interface ratpack.groovy.Groovy.Ratpack

Registers the closure used to build the handler chain of the application.

handlers(Closure<?>) - Method in interface ratpack.groovy.server.GroovyRatpackServerSpec

 

handlers(Action<? super Chain>) - Method in interface ratpack.core.server.RatpackServerSpec

Sets the root handler to the chain specified by the given action.

Handlers - Class in ratpack.core.handling

Factory methods for handler decorations.

handlersWithArgs(boolean, String, String...) - Static method in class ratpack.groovy.Groovy.Script

Creates a handler defining function from a Groovy script.

HandlerTimeoutException - Exception in ratpack.test.handling

Thrown when a handler under test takes too long to produce a result.

HandlerTimeoutException(HandlingResult, int) - Constructor for exception ratpack.test.handling.HandlerTimeoutException

Constructor.

HandlingResult - Interface in ratpack.test.handling

Represents the result of testing one or more handlers.

harness() - Static method in interface ratpack.test.exec.ExecHarness

Creates a new execution harness.

harness(int) - Static method in interface ratpack.test.exec.ExecHarness

Create a harness with the provided number of computation threads.

harness(Action<? super ExecControllerSpec>) - Static method in interface ratpack.test.exec.ExecHarness

Create a harness that is backed by an execution controller with the provided configuration

hasArray() - Method in class ratpack.core.bytebuf.ByteBufRef

 

hashCode() - Method in class ratpack.core.bytebuf.ByteBufRef

 

hashCode() - Method in class ratpack.func.Pair

Hash code.

hasMemoryAddress() - Method in class ratpack.core.bytebuf.ByteBufRef

 

head() - Method in interface ratpack.core.http.client.RequestSpec

Specifies to use the HEAD request method.

head() - Method in interface ratpack.test.http.TestHttpClient

Make a HEAD request with a path of "" this is the same as calling head("").

head(String) - Method in interface ratpack.test.http.TestHttpClient

Make a HEAD request to the specified path.

HEAD - Static variable in interface ratpack.core.http.HttpMethod

The HEAD method.

header(CharSequence) - Method in interface ratpack.core.handling.Context

Returns the request header with the specified name.

header(CharSequence) - Static method in interface ratpack.core.handling.RequestId.Generator

Creates a generator that uses the value for the given header, falling back to a RequestId.Generator.randomUuid() generator if the header is not present.

header(CharSequence, Object...) - Method in interface ratpack.core.handling.Context

Sets a response header.

header(CharSequence, Object...) - Method in interface ratpack.groovy.handling.GroovyContext

Sets a response header.

header(CharSequence, String) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture

Set a request header value.

header(CharSequence, String) - Method in interface ratpack.test.handling.RequestFixture

Set a request header value.

header(CharSequence, RequestId.Generator) - Static method in interface ratpack.core.handling.RequestId.Generator

Creates a generator that uses the value for the given header, using the given fallback generator if the header is not present.

HEADER_FIELDS_TOO_LARGE - Static variable in interface ratpack.core.http.Status

The 431 status code.

HEADER_NAME - Static variable in class ratpack.core.handling.ResponseTimer

The name of the header with the time value: "X-Response-Time".

headers(Action<? super MutableHeaders>) - Method in interface ratpack.core.http.client.RequestSpec

This method can be used to buffer changes to the headers.

Headers - Interface in ratpack.core.http

An immutable set of HTTP headers.

HealthCheck - Interface in ratpack.core.health

Reports on the health of some aspect of the system.

HealthCheck.Result - Class in ratpack.core.health

The result of a health check.

HealthCheckHandler - Class in ratpack.core.health

A handler that executes health checks and renders the results.

HealthCheckHandler() - Constructor for class ratpack.core.health.HealthCheckHandler

Uses the default values of HealthCheckHandler.DEFAULT_NAME_TOKEN and an unlimited throttle.

HealthCheckHandler(String) - Constructor for class ratpack.core.health.HealthCheckHandler

Uses an unlimited throttle and the given name for the health check identifying path token.

HealthCheckHandler(String, Throttle) - Constructor for class ratpack.core.health.HealthCheckHandler

Constructor.

HealthCheckHandler(Throttle) - Constructor for class ratpack.core.health.HealthCheckHandler

Uses the HealthCheckHandler.DEFAULT_NAME_TOKEN and the given throttle.

HealthCheckResults - Class in ratpack.core.health

A value type representing the result of running multiple health checks.

HealthCheckResults(ImmutableSortedMap<String, HealthCheck.Result>) - Constructor for class ratpack.core.health.HealthCheckResults

Constructor.

healthy() - Static method in class ratpack.core.health.HealthCheck.Result

Creates a healthy result, with no message.

healthy(String) - Static method in class ratpack.core.health.HealthCheck.Result

Creates a healthy result, with the given message.

healthy(String, Object...) - Static method in class ratpack.core.health.HealthCheck.Result

Creates a healthy result, with the given message.

hikariDataSource(HikariConfig) - Method in class ratpack.hikari.HikariModule

 

HikariHealthCheck - Class in ratpack.hikari

Reports on the health of HikariCP JDBC connection pool.

HikariHealthCheck() - Constructor for class ratpack.hikari.HikariHealthCheck

 

HikariModule - Class in ratpack.hikari

An extension module that provides a DataSource from a HikariCP JDBC connection pool.

HikariModule() - Constructor for class ratpack.hikari.HikariModule

 

hikariPool(HikariDataSource) - Method in class ratpack.hikari.HikariModule

 

hikariService(HikariDataSource) - Method in class ratpack.hikari.HikariModule

 

HikariService - Class in ratpack.hikari

 

HikariService(HikariDataSource) - Constructor for class ratpack.hikari.HikariService

 

host(String) - Method in interface ratpack.core.http.client.ProxySpec

Configure the host that will proxy outbound HTTP requests.

host(String) - Method in interface ratpack.core.http.HttpUrlBuilder

Sets the host to the given value.

host(String, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

If the request has a Host header that matches the given host name exactly, handling will be delegated to the chain defined by the given closure.

host(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.core.handling.Chain

 

host(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.groovy.handling.GroovyChain

host(String, Action<? super Chain>) - Method in interface ratpack.core.handling.Chain

Adds a handler to the chain that delegates to the given handler chain if the request has a Host header that matches the given value exactly.

host(String, Action<? super Chain>) - Method in interface ratpack.groovy.handling.GroovyChain

Adds a handler to the chain that delegates to the given handler chain if the request has a Host header that matches the given value exactly.

html(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Class<? extends Handler>) - Method in interface ratpack.core.handling.ByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Class<? extends Handler>) - Method in class ratpack.groovy.handling.DefaultGroovyByContentSpec

 

html(Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Object) - Method in interface ratpack.groovy.template.TextTemplateScript

Escapes the toString() value of the given object, by way of HtmlEscapers.

html(Handler) - Method in interface ratpack.core.handling.ByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Handler) - Method in class ratpack.groovy.handling.DefaultGroovyByContentSpec

 

html(Handler) - Method in interface ratpack.groovy.handling.GroovyByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Block) - Method in interface ratpack.core.handling.ByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

html(Block) - Method in class ratpack.groovy.handling.DefaultGroovyByContentSpec

 

html(Block) - Method in interface ratpack.groovy.handling.GroovyByContentSpec

Specifies that the given handler should be used if the client wants content of type "text/html".

htmlBuilder(Closure<?>) - Static method in class ratpack.groovy.Groovy

Shorthand for Groovy.markupBuilder(CharSequence, Charset, Closure) with a content type of "text/html" and "UTF-8" encoding.

http() - Static method in interface ratpack.core.http.HttpUrlBuilder

Create a new HTTP URL builder.

HTTP_VER_NOT_SUPPORTED - Static variable in interface ratpack.core.http.Status

The 505 status code.

httpClient() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig

 

httpClient(Action<? super HttpClientConfig>) - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig

Configure the http client metric set.

httpClient(Factory<? extends HttpClient>) - Method in class ratpack.retrofit.RatpackRetrofit.Builder

Configures a Factory that supplies the underlying HttpClient to back client interfaces generated from the return of RatpackRetrofit.Builder.retrofit()

HttpClient - Interface in ratpack.core.http.client

An asynchronous HTTP client.

HttpClientConfig - Class in ratpack.dropwizard.metrics

 

HttpClientConfig() - Constructor for class ratpack.dropwizard.metrics.HttpClientConfig

 

HttpClientReadTimeoutException - Exception in ratpack.core.http.client

Thrown when the read timeout duration for a request is reached.

HttpClientReadTimeoutException(String) - Constructor for exception ratpack.core.http.client.HttpClientReadTimeoutException

Constructor.

HttpClientSpec - Interface in ratpack.core.http.client

An additive specification of a HTTP client.

HttpMethod - Interface in ratpack.core.http

The method of a HTTP request.

httpOnly(boolean) - Method in class ratpack.session.SessionCookieConfig

Set session cookies attribute HttpOnly.

HttpResponse - Interface in ratpack.core.http.client

Base type of responses from HttpClient regardless of if the request is streaming or not.

https() - Static method in interface ratpack.core.http.HttpUrlBuilder

Create a new HTTPS URL builder.

HttpUrlBuilder - Interface in ratpack.core.http

Builds a HTTP URL, safely.