C

cache() - Method in interface ratpack.exec.Promise

Caches the promised value (or error) and returns it to all subscribers.

cacheIf(Predicate<? super T>) - Method in interface ratpack.exec.Promise

Caches the promise value and provides it to all future subscribers, if it satisfies the predicate.

cacheResultFor(Function<? super ExecResult<T>, Duration>) - Method in interface ratpack.exec.Promise

Caches the promise result for a calculated amount of time.

cacheResultIf(Predicate<? super ExecResult<T>>) - Method in interface ratpack.exec.Promise

Caches the promise result eternally and provide it to all future subscribers, if it satisfies the predicate.

cacheSize(int) - Method in class ratpack.handlebars.HandlebarsModule.Config

 

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

 

capacity(int) - Method in class ratpack.core.bytebuf.ByteBufRef

 

cast(Object) - Static method in class ratpack.func.Types

Simply casts the argument to T.

cause(Call<?>, Response<?>) - Static method in exception ratpack.retrofit.RatpackRetrofitCallException

 

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

Creates a chain action implementation from the given closure.

chain(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

Creates a handler from the given closure.

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

 

chain(List<? extends Handler>) - Static method in class ratpack.core.handling.Handlers

Creates a handler chain from the given handlers.

chain(Chain, Closure<?>) - Static method in class ratpack.groovy.Groovy

Immediately executes the given closure against the given chain, as a GroovyChain.

chain(Handler...) - Static method in class ratpack.core.handling.Handlers

Creates a handler chain from the given handlers.

chain(ServerConfig, Closure<?>) - Static method in class ratpack.groovy.Groovy

Builds a handler chain, with no backing registry.

chain(ServerConfig, Registry, Closure<?>) - Static method in class ratpack.groovy.Groovy

Builds a chain, backed by the given registry.

chain(ServerConfig, Registry, Action<? super Chain>) - Static method in class ratpack.core.handling.Handlers

Builds a chain, backed by the given registry.

chain(ServerConfig, Action<? super Chain>) - Static method in class ratpack.core.handling.Handlers

Builds a handler chain, with no backing registry.

chain(Registry, Closure<?>) - Static method in class ratpack.groovy.Groovy

Builds a chain, backed by the given registry.

chain(Registry, Action<? super Chain>) - Static method in class ratpack.core.handling.Handlers

Builds a chain, backed by the given registry.

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

Constructs a handler using the given action to define a chain.

Chain - Interface in ratpack.core.handling

A chain is a write only builder for composing handlers.

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

Creates a chain action based on the given closure.

check(Registry) - Method in interface ratpack.core.health.HealthCheck

Checks the health of the component, providing a promise for the result.

check(Registry) - Method in class ratpack.hikari.HikariHealthCheck

 

checkAll(Registry, Iterable<? extends HealthCheck>) - Static method in interface ratpack.core.health.HealthCheck

Execute health checks.

checkAll(Registry, Throttle, Iterable<? extends HealthCheck>) - Static method in interface ratpack.core.health.HealthCheck

Execute health checks.

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

Asserts that the version of Groovy on the classpath meets the minimum requirement for Ratpack.

chunkedJsonList(ObjectWriter, Publisher<T>) - Static method in class ratpack.core.jackson.Jackson

Renders a data stream as a JSON list, directly streaming the JSON.

chunkedJsonList(Gson, Publisher<T>) - Static method in class ratpack.gson.Gson

Renders a data stream as a JSON list, directly streaming the JSON.

chunkedJsonList(Registry, Publisher<T>) - Static method in class ratpack.core.jackson.Jackson

Renders a data stream as a JSON list, directly streaming the JSON.

chunkedJsonList(Registry, Publisher<T>) - Static method in class ratpack.gson.Gson

Renders a data stream as a JSON list, directly streaming the JSON.

className - Variable in exception ratpack.session.NonAllowedSessionTypeException

The type that was not allowed.

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

 

clear() - Method in interface ratpack.core.http.MutableHeaders

Removes all headers from this message.

clear() - Method in interface ratpack.func.MultiValueMap

Throws UnsupportedOperationException.

clear() - Method in interface ratpack.session.Session

A convenience shorthand for SessionData.clear().

clear() - Method in interface ratpack.session.SessionData

Remove all entries from the session data.

client(String) - Static method in class ratpack.retrofit.RatpackRetrofit

Creates a new builder for creating Retrofit clients.

client(URI) - Static method in class ratpack.retrofit.RatpackRetrofit

Creates a new builder for creating Retrofit clients.

clientError(int) - Method in interface ratpack.core.handling.Context

Forwards the error to the ClientErrorHandler in this service.

clientError(int) - Static method in class ratpack.core.handling.Handlers

A handler that simply calls Context.clientError(int) with the given status code.

ClientErrorException - Exception in ratpack.core.http

Indicates that this exception represents a client error.

ClientErrorException(String) - Constructor for exception ratpack.core.http.ClientErrorException

 

ClientErrorException(String, Throwable) - Constructor for exception ratpack.core.http.ClientErrorException

 

ClientErrorHandler - Interface in ratpack.core.error

The client error handler deals with errors that are due to the client doing something wrong.

ClientSideSessionConfig - Class in ratpack.session.clientside

Client side session configuration.

ClientSideSessionConfig() - Constructor for class ratpack.session.clientside.ClientSideSessionConfig

 

ClientSideSessionModule - Class in ratpack.session.clientside

An extension module that provides a client side session store - cookie based.

ClientSideSessionModule() - Constructor for class ratpack.session.clientside.ClientSideSessionModule

 

clock(Clock) - Method in interface ratpack.exec.util.retry.DurationRetryPolicyBuilder

Clock used to determine current time.

close() - Method in interface ratpack.core.http.client.HttpClient

Closes any pooled connections.

close() - Method in interface ratpack.core.websocket.WebSocket

 

close() - Method in interface ratpack.exec.ExecController

Shuts down this controller, terminating the event loop and blocking threads.

close() - Method in interface ratpack.test.CloseableApplicationUnderTest

Shuts down the application under test.

close() - Method in interface ratpack.test.embed.EmbeddedApp

Stops the server returned by EmbeddedApp.getServer().

close() - Method in interface ratpack.test.embed.EphemeralBaseDir

Deletes the base dir from the file system.

close() - Method in interface ratpack.test.exec.ExecHarness

Shuts down the thread pool backing this harness.

close() - Method in class ratpack.test.ServerBackedApplicationUnderTest

Delegates to ServerBackedApplicationUnderTest.stop().

close(int, String) - Method in interface ratpack.core.websocket.WebSocket

 

close(AutoCloseable) - Method in interface ratpack.exec.Promise

Closes the given closeable when the value or error propagates to this point.

close(Operation) - Method in interface ratpack.exec.Promise

Like Promise.close(AutoCloseable), but allows async close operations.

CloseableApplicationUnderTest - Interface in ratpack.test

An ApplicationUnderTest that is able to be shut down.

closeOnExit() - Method in interface ratpack.test.embed.EphemeralBaseDir

Add's a JVM shutdown hook that will EphemeralBaseDir.close() this base dir.

comment(String) - Method in interface ratpack.core.sse.ServerSentEventBuilder

Specify a comment to include as part of this event.

commit() - Method in interface ratpack.jdbctx.Transaction

Commits the transaction, or pops the most recent savepoint off the stack.

compareTo(ByteBuf) - Method in class ratpack.core.bytebuf.ByteBufRef

 

complete() - Method in interface ratpack.exec.Downstream

Signals that the upstream will not be providing a value, as it has terminated.

complete() - Static method in interface ratpack.exec.ExecResult

Returns a complete exec result.

complete() - Method in interface ratpack.exec.stream.WriteStream

Signals that the stream has completed and that no more items (or errors) are to come.

complete() - Method in class ratpack.exec.util.Promised

Signals that the upstream will not be providing a value, as it has terminated.

complete(Operation) - Static method in class ratpack.rx2.RxRatpack

Converts a Operation into a Completable.

completionHandler() - Method in interface ratpack.exec.Downstream

Creates a JDK CompletionHandler that connects to this downstream.

compose(Publisher<? extends ByteBuf>) - Static method in class ratpack.exec.stream.bytebuf.ByteBufStreams

Reduces the stream to a single composite byte buf.

compose(Publisher<? extends ByteBuf>, ByteBufAllocator) - Static method in class ratpack.exec.stream.bytebuf.ByteBufStreams

Reduces the stream to a single composite byte buf.

compose(Function<? super T, ? extends I>) - Method in interface ratpack.func.Function

Joins the given function with this function.

computationScheduler() - Static method in class ratpack.reactor.ReactorRatpack

A scheduler that uses the application event loop and initialises each job as an Execution (via ExecController.fork()).

computationScheduler(ExecController) - Static method in class ratpack.reactor.ReactorRatpack

A scheduler that uses the application event loop and initialises each job as an Execution (via ExecController.fork()).

compute(Action<? super ExecControllerSpec.ComputeSpec>) - Method in interface ratpack.exec.ExecControllerSpec

Configures the default executor for computation (i.e.

COMPUTE - ratpack.exec.ExecInterceptor.ExecType

The execution segment is executing on a compute thread.

concat(Iterable<? extends Publisher<? extends T>>) - Static method in class ratpack.exec.stream.Streams

Similar to Streams.concat(Iterable, Action), but with a noop disposer.

concat(Iterable<? extends Publisher<? extends T>>, Action<? super T>) - Static method in class ratpack.exec.stream.Streams

Returns a publisher that aggregates the given publishers into a single stream of elements, without interleaving them.

conditional(Action<? super I>, Action<? super Action.ConditionalSpec<I>>) - Static method in interface ratpack.func.Action

Creates an action that delegates based on the specified conditions.

conditional(Action<? super Action.ConditionalSpec<I>>) - Static method in interface ratpack.func.Action

Creates an action that delegates based on the specified conditions.

conditional(Action<? super Function.ConditionalSpec<I, O>>) - Static method in interface ratpack.func.Function

Creates a function that delegates based on the specified conditions.

conditional(Function<? super I, ? extends O>, Action<? super Function.ConditionalSpec<I, O>>) - Static method in interface ratpack.func.Function

Creates a function that delegates based on the specified conditions.

Config() - Constructor for class ratpack.groovy.template.MarkupTemplateModule.Config

 

Config() - Constructor for class ratpack.groovy.template.TextTemplateModule.Config

 

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

 

Config() - Constructor for class ratpack.session.store.RedisSessionModule.Config

 

Config() - Constructor for class ratpack.thymeleaf3.ThymeleafModule.Config

 

Config(String, String, Integer) - Constructor for class ratpack.session.store.RedisSessionModule.Config

Convenience constructor most of the time not used if you are using Ratpack Config.

ConfigData - Interface in ratpack.config

Configuration data for the application, potentially built from many sources.

ConfigDataBuilder - Interface in ratpack.config

Configures how configuration data will be loaded and bound to objects.

ConfigObject<T> - Interface in ratpack.config

An object deserialized from config.

ConfigSource - Interface in ratpack.config

Allows providing custom sources of configuration data.

ConfigurableModule<T> - Class in ratpack.guice

Provides a standard approach for modules that require some parametrization / configuration.

ConfigurableModule() - Constructor for class ratpack.guice.ConfigurableModule

 

configure() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsModule

 

configure() - Method in class ratpack.groovy.sql.SqlModule

 

configure() - Method in class ratpack.groovy.template.MarkupTemplateModule

 

configure() - Method in class ratpack.groovy.template.TextTemplateModule

 

configure() - Method in class ratpack.gson.GsonModule

 

configure() - Method in class ratpack.h2.H2Module

 

configure() - Method in class ratpack.handlebars.HandlebarsModule

 

configure() - Method in class ratpack.hikari.HikariModule

 

configure() - Method in class ratpack.newrelic.NewRelicModule

 

configure() - Method in class ratpack.rocker.RockerModule

 

configure() - Method in class ratpack.session.clientside.ClientSideSessionModule

 

configure() - Method in class ratpack.session.SessionModule

 

configure() - Method in class ratpack.session.store.RedisSessionModule

 

configure() - Method in class ratpack.thymeleaf3.ThymeleafModule

 

configure(Action<? super Retrofit.Builder>) - Method in class ratpack.retrofit.RatpackRetrofit.Builder

Configure the underlying Retrofit.Builder instance.

configure(Action<? super T>) - Method in class ratpack.guice.ConfigurableModule

Registers the configuration action.

configureKryo(Kryo) - Method in class ratpack.session.serialization.kryo.KryoSessionSerializer

A hook for potential subclasses to configure Kryo instances used.

configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.config.ConfigDataBuilder

Configures the object mapper used for binding configuration data to arbitrary objects.

configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.core.server.ServerConfigBuilder

Configures the object mapper used for binding configuration data to arbitrary objects.

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

The 409 status code.

connect(Downstream<? super T>) - Method in interface ratpack.exec.Promise

A low level hook for consuming the promised value.

connect(Downstream<? super T>) - Method in interface ratpack.exec.Upstream

Connect the downstream.

connect(Action<? super WebSocketSpec<T>>) - Method in interface ratpack.core.websocket.WebSocketConnector

 

connection() - Static method in interface ratpack.jdbctx.Transaction

The connection of the current transaction if it is active.

ConnectionClosedException - Exception in ratpack.core.http

Thrown when an operation is attempted against a connection that is closed.

ConnectionClosedException(String) - Constructor for exception ratpack.core.http.ConnectionClosedException

 

connectQueueSize(int) - Method in interface ratpack.core.server.ServerConfigBuilder

The maximum amount of connections that may be waiting to be accepted at any time.

connectTimeout(Duration) - Method in interface ratpack.core.http.client.HttpClientSpec

The connect timeout value for requests.

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

Sets the socket connection timeout.

connectTimeoutMillis(int) - Method in interface ratpack.core.server.ServerConfigBuilder

The connect timeout of the channel.

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

 

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

Configure the console metrics publisher.

ConsoleConfig - Class in ratpack.dropwizard.metrics

 

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

 

constant(AsciiString) - Static method in interface ratpack.session.SessionId

A session ID that always returns the same value.

constant(T) - Static method in class ratpack.exec.stream.Streams

Creates a new publisher, that indefinitely streams the given object to all subscribers.

constant(T) - Static method in interface ratpack.func.Factory

Creates a factory that always returns the given item.

constant(T) - Static method in interface ratpack.func.Function

Returns a function that always returns the given argument.

contains(CharSequence) - Method in interface ratpack.core.http.Headers

Checks whether a header has been specified for the given value.

contains(String) - Method in interface ratpack.core.http.Headers

Checks whether a header has been specified for the given value.

contentType(CharSequence) - Method in interface ratpack.core.http.Response

Sets the response Content-Type header.

contentType(String) - Method in interface ratpack.test.http.MultipartFileSpec

Specify the content type

contentTypeIfNotSet(CharSequence) - Method in interface ratpack.core.http.Response

Sets the response Content-Type header, if it has not already been set.

contentTypeIfNotSet(Supplier<CharSequence>) - Method in interface ratpack.core.http.Response

 

contentTypes(String...) - Static method in class ratpack.core.handling.Handlers

A handler that delegates to the next handler if the content type of the request is one of the given types, otherwise raises a 415 client error.

Context - Interface in ratpack.core.handling

The context of an individual Handler invocation.

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

The 100 status code.

cookie(String, String) - Method in interface ratpack.core.http.Response

Creates a new cookie with the given name and value.

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

 

copy(int, int) - Method in class ratpack.core.bytebuf.ByteBufRef

 

copy(Headers) - Method in interface ratpack.core.http.MutableHeaders

 

copyWith(Action<? super HttpClientSpec>) - Method in interface ratpack.core.http.client.HttpClient

Create a new HttpClient by appending the provided configuration to this client.

create() - Method in interface ratpack.func.Factory

Creates a new object.

create() - Static method in interface ratpack.rocker.RockerRenderer

Creates a Renderer or RockerModel objects.

create(Duration) - Static method in interface ratpack.exec.util.ReadWriteAccess

Create a new read/write access object with the given default timeout.

create(Factory<? extends Connection>) - Static method in interface ratpack.jdbctx.Transaction

Creates a new transaction.

createConfig(ServerConfig) - Method in class ratpack.guice.ConfigurableModule

Creates the configuration object.

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

The 201 status code.

createDataSource() - Method in class ratpack.h2.H2Module

 

createImpositions() - Method in class ratpack.test.ServerBackedApplicationUnderTest

Creates the Impositions to impose on the server.

createServer() - Method in class ratpack.test.MainClassApplicationUnderTest

Starts the Ratpack server by invoking the public static void main(String[]) method of the “main class” backing this object.

createServer() - Method in class ratpack.test.ServerBackedApplicationUnderTest

Creates the server to be tested.

Crypto - Interface in ratpack.session.clientside

 

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

Configure the csv metrics publisher.

CsvConfig - Class in ratpack.dropwizard.metrics

 

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

 

current() - Static method in class ratpack.core.impose.Impositions

The cumulative currently imposed impositions, for the current thread.

current() - Static method in interface ratpack.exec.ExecController

Returns the execution controller bound to the current thread, if this is a Ratpack managed compute thread.

current() - Static method in interface ratpack.exec.Execution

Provides the currently executing execution.

current() - Static method in interface ratpack.jdbctx.Transaction

The current execution bound transaction, if any.

currentOpt() - Static method in interface ratpack.exec.Execution

Provides the currently executing execution, if any.

curry(T) - Method in interface ratpack.func.Action

Creates a block that executes this action with the given value when called.