Index (ratpack-core 0.9.17 API)

A B C D E F G H I J L M N O P R S T U V W X Y

A

accept(ExecResult<? extends T>) - Method in interface ratpack.exec.Downstream: Signals this downstream, based on the given result.
accept(Result<? extends T>) - Method in interface ratpack.exec.Downstream: Signals this downstream, based on the given result.
accept(Result<? extends T>) - Method in interface ratpack.exec.Fulfiller: Fulfills via the given result.
accept(CompletableFuture<? extends T>) - Method in interface ratpack.exec.Fulfiller: Fulfills via the given completable future.
accepts(String...) - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request claims that it can accept one of the given types, otherwise raises a 406 client error.
Action<T> - Interface in ratpack.func: A generic type for an object that does some work with a thing.
add(ConfigSource) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source.
add(Class<? super O>, O) - Method in interface ratpack.exec.Execution: Adds a registry entry that is available by the given type.
add(TypeToken<? super O>, O) - Method in interface ratpack.exec.Execution: Adds a registry entry that is available by the given type.
add(Object) - Method in interface ratpack.exec.Execution: Adds a registry entry.
add(CharSequence, Object) - Method in interface ratpack.http.MutableHeaders: Adds a new header with the specified name and value.
add(Class<? super O>, O) - Method in interface ratpack.http.Request: Adds a registry entry that is available by the given type.
add(TypeToken<? super O>, O) - Method in interface ratpack.http.Request: Adds a registry entry that is available by the given type.
add(Object) - Method in interface ratpack.http.Request: Adds a registry entry.
add(Object) - Method in interface ratpack.registry.RegistryBuilder: Adds a registry entry.
add(Class<? super O>, O) - Method in interface ratpack.registry.RegistryBuilder: Adds a registry entry that is available by the given type.
add(TypeToken<? super O>, O) - Method in interface ratpack.registry.RegistryBuilder: Adds a registry entry that is available by the given type.
add(Class<? super O>, O) - Method in interface ratpack.registry.RegistrySpec: Adds a registry entry that is available by the given type.
add(TypeToken<? super O>, O) - Method in interface ratpack.registry.RegistrySpec: Adds a registry entry that is available by the given type.
add(Object) - Method in interface ratpack.registry.RegistrySpec: Adds a registry entry.
add(ConfigSource) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source.
addInterceptor(ExecInterceptor, Block) - Method in interface ratpack.exec.ExecControl: Adds an interceptor that wraps the rest of the current execution segment and all future segments of this execution.
addInterceptor(ExecInterceptor, Block) - Method in interface ratpack.handling.Context
addLazy(Class<O>, Supplier<? extends O>) - Method in interface ratpack.exec.Execution: Adds a lazily created entry to the registry.
addLazy(TypeToken<O>, Supplier<? extends O>) - Method in interface ratpack.exec.Execution: Adds a lazily created entry to the registry.
addLazy(Class<O>, Supplier<? extends O>) - Method in interface ratpack.http.Request: Adds a lazily created entry to the registry.
addLazy(TypeToken<O>, Supplier<? extends O>) - Method in interface ratpack.http.Request: Adds a lazily created entry to the registry.
addLazy(Class<O>, Supplier<? extends O>) - Method in interface ratpack.registry.RegistryBuilder: Adds a lazily created entry to the registry.
addLazy(TypeToken<O>, Supplier<? extends O>) - Method in interface ratpack.registry.RegistryBuilder: Adds a lazily created entry to the registry.
addLazy(Class<O>, Supplier<? extends O>) - Method in interface ratpack.registry.RegistrySpec: Adds a lazily created entry to the registry.
addLazy(TypeToken<O>, Supplier<? extends O>) - Method in interface ratpack.registry.RegistrySpec: Adds a lazily created entry to the registry.
addLazyAsync(Class<O>, Supplier<? extends Promise<? extends O>>) - Method in interface ratpack.registry.RegistrySpec
addLazyAsync(TypeToken<O>, Supplier<? extends Promise<? extends O>>) - Method in interface ratpack.registry.RegistrySpec
address(InetAddress) - Method in interface ratpack.server.ServerConfig.Builder: Sets the address to bind to.
adler32(ServerConfig, String, String...) - Static method in class ratpack.file.FileSystemChecksumServices: Get checksum service with Adler32 calculation method.
Adler32Checksummer - Class in ratpack.file.checksummer: Calculate checksum with Adler32 algorithm.
Adler32Checksummer() - Constructor for class ratpack.file.checksummer.Adler32Checksummer
andThen(Function<? super O, ? extends V>) - Method in interface ratpack.func.BiFunction
andThen(Function<? super O, ? extends T>) - Method in interface ratpack.func.Function: Joins this function with the given function.
APPLICATION_FORM - Static variable in interface ratpack.http.MediaType: "application/x-www-form-urlencoded".
APPLICATION_JSON - Static variable in interface ratpack.http.MediaType: "application/json".
apply(Function<? super Promise<T>, ? extends Promise<O>>) - Method in interface ratpack.exec.Promise: Applies the custom operation function to this promise.
apply(InputStream) - Method in class ratpack.file.checksummer.Adler32Checksummer: Algorythm implementation.
apply(InputStream) - Method in class ratpack.file.checksummer.MD5Checksummer: Algorythm implementation.
apply(I1, I2) - Method in interface ratpack.func.BiFunction
apply(I) - Method in interface ratpack.func.Function: The function implementation.
apply(T) - Method in interface ratpack.func.Predicate: Tests the given value.
asBool(K) - Method in interface ratpack.util.TypeCoercingMap: Convert the value with given key to a Boolean, using Boolean.valueOf(String).
asByte(K) - Method in interface ratpack.util.TypeCoercingMap: Convert the value with given key to a Byte, using Byte.valueOf(String).
asInt(K) - Method in interface ratpack.util.TypeCoercingMap: Convert the value with given key to a Integer, using Integer.valueOf(String).
asLong(K) - Method in interface ratpack.util.TypeCoercingMap: Convert the value with given key to a Long, using Long.valueOf(String).
asMultimap() - Method in interface ratpack.util.MultiValueMap
asMultiValueMap() - Method in interface ratpack.http.Headers
assets(String, String...) - Method in interface ratpack.handling.Chain: Adds a handler that serves static assets at the given file system path, relative to the contextual file system binding.
assets(ServerConfig, String, List<String>) - Static method in class ratpack.handling.Handlers: A handler that serves static assets at the given file system path, relative to the contextual file system binding.
asShort(K) - Method in interface ratpack.util.TypeCoercingMap: Convert the value with given key to a Short, using Short.valueOf(String).
AutoCloseWebSocketHandler<T extends AutoCloseable> - Class in ratpack.websocket
AutoCloseWebSocketHandler() - Constructor for class ratpack.websocket.AutoCloseWebSocketHandler

B

backedRegistry(RegistryBacking) - Static method in class ratpack.registry.Registries: Creates a new registry instance that is backed by a RegistryBacking implementation.
base(URI) - Static method in interface ratpack.http.HttpUrlBuilder: Create a new builder, with the initial state of the given URI.
baseDir(Path) - Static method in interface ratpack.server.ServerConfig: Create a new builder, using the given file as the base dir.
baseDir(File) - Static method in interface ratpack.server.ServerConfig: Create a new builder, using the given file as the base dir.
BaseDirRequiredException - Exception in ratpack.file: Thrown when the base directory of the application has not been set but is required.
BaseDirRequiredException(String) - Constructor for exception ratpack.file.BaseDirRequiredException: Constructor.
beforeSend(Action<? super ResponseMetaData>) - Method in interface ratpack.http.Response: Register an action to execute upon the response immediately before sending it to the client.
BiAction<T,U> - Interface in ratpack.func: A generic type for an object that does some work with 2 input things.
BiFunction<I1,I2,O> - Interface in ratpack.func
bind() - Static method in interface ratpack.handling.RequestId: Creates a new request ID (using the RequestId.Generator from the context) and inserts it into the request registry.
bind(String, Optional<PathBinding>) - Method in interface ratpack.path.PathBinder: Creates a binding for the given path, if this binder can bind to this path.
bindAndLog() - Static method in interface ratpack.handling.RequestId
binding(String) - Method in interface ratpack.file.FileSystemBinding: Construct a new binding by using the given path as a relative path from this bind point.
block() - Method in interface ratpack.exec.Promise: Blocks execution waiting for this promise to complete and returns the promised value.
Block - Interface in ratpack.func: A block of code.
blocking(Callable<T>) - Method in interface ratpack.exec.ExecControl: Performs a blocking operation on a separate thread, returning a promise for its value.
blocking(Callable<T>) - Method in interface ratpack.handling.Context: Executes a blocking operation, returning a promise for its result.
blockingMap(Function<? super T, ? extends O>) - Method in interface ratpack.exec.Promise: Like Promise.map(Function), but performs the transformation on a blocking thread.
blockingOperation(Block) - Method in interface ratpack.exec.ExecControl
body(Action<? super RequestSpec.Body>) - Method in interface ratpack.http.client.RequestSpec: Executes the given action with the request body.
buffer(ByteBuf) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body as a byte buffer.
buffer(Publisher<T>) - Static method in class ratpack.stream.Streams: Returns a publisher that allows the given publisher to emit as fast as it can, while applying flow control downstream.
buffer() - Method in interface ratpack.stream.TransformablePublisher: See Streams.buffer(Publisher).
bufferChunks(CharSequence, Publisher<? extends ByteBuf>) - Static method in class ratpack.http.ResponseChunks: Transmit each set of bytes emitted by the publisher as a chunk.
build() - Method in interface ratpack.config.ConfigDataSpec: Builds the configuration data from this specification.
build() - Method in interface ratpack.http.HttpUrlBuilder: Builds the URI based on this builder's current state.
build(boolean) - Method in interface ratpack.path.PathBinderBuilder: Generate a PathBinder from the contents of the builder.
build() - Method in interface ratpack.registry.RegistryBuilder: Builds the registry.
build() - Method in interface ratpack.server.ServerConfig.Builder: Builds the server config.
builder() - Static method in class ratpack.path.PathBinders
byContent(Action<? super ByContentSpec>) - Method in interface ratpack.handling.Context: Respond to the request based on the requested content type (i.e.
ByContentSpec - Interface in ratpack.handling: A specification of how to respond to a request, based on the requested content type (i.e.
byMethod(Action<? super ByMethodSpec>) - Method in interface ratpack.handling.Context: Respond to the request based on the request method.
ByMethodSpec - Interface in ratpack.handling: A specification of how to respond to a request, based on the requested method.
bytes(byte[]) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body as a byte array.

C

cache() - Method in interface ratpack.exec.Promise: Caches the promised value (or error) and returns it to all subscribers.
CachingFileSystemChecksumService - Class in ratpack.file
CachingFileSystemChecksumService(FileSystemChecksumService) - Constructor for class ratpack.file.CachingFileSystemChecksumService
cast(Object) - Static method in class ratpack.util.Types: Simply casts the argument to T.
Chain - Interface in ratpack.handling: A chain can be used to build a linked series of handlers.
chain(Action<? super Chain>) - Method in interface ratpack.handling.Chain: Constructs a handler using the given action to define a chain.
chain(Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
chain(ServerConfig, Action<? super Chain>) - Static method in class ratpack.handling.Handlers: Builds a handler chain, with no backing registry.
chain(ServerConfig, Registry, Action<? super Chain>) - Static method in class ratpack.handling.Handlers: Builds a chain, backed by the given registry.
chain(Registry, Action<? super Chain>) - Static method in class ratpack.handling.Handlers: Builds a chain, backed by the given registry.
chain(List<? extends Handler>) - Static method in class ratpack.handling.Handlers: Creates a handler chain from the given handlers.
chain(Handler...) - Static method in class ratpack.handling.Handlers: Creates a handler chain from the given handlers.
check(ExecControl, Registry) - Method in interface ratpack.health.HealthCheck: Checks the health of the component, providing a promise for the result.
checksum(String) - Method in class ratpack.file.CachingFileSystemChecksumService
checksum(String) - Method in interface ratpack.file.FileSystemChecksumService: Calculate checksum for file given by path relative to server's baseDir.
childPath(String) - Method in interface ratpack.path.PathBinding: Constructs a new path using the PathBinding.getBoundTo() value of this binding and the given path.
clear() - Method in interface ratpack.http.MutableHeaders: Removes all headers from this message.
clear() - Method in interface ratpack.util.MultiValueMap: Throws UnsupportedOperationException.
clientError(int) - Method in interface ratpack.handling.Context: Forwards the error to the ClientErrorHandler in this service.
clientError(int) - Static method in class ratpack.handling.Handlers: A handler that simply calls Context.clientError(int) with the given status code.
ClientErrorHandler - Interface in ratpack.error: The client error handler deals with errors that are due to the client doing something wrong.
close() - Method in interface ratpack.exec.ExecController: Shuts down this controller, terminating the event loop and blocking threads.
close() - Method in interface ratpack.websocket.WebSocket
close(int, String) - Method in interface ratpack.websocket.WebSocket
complete() - Method in interface ratpack.exec.Downstream: Signals that the upstream will not be providing a value, as it has terminated.
complete() - Method in interface ratpack.stream.WriteStream: Signals that the stream has completed and that no more items (or errors) are to come.
compose(Function<? super T, ? extends I>) - Method in interface ratpack.func.Function: Joins the given function with this function.
ConfigData - Interface in ratpack.config: Configuration data for the application, potentially built from many sources.
ConfigDataSpec - Interface in ratpack.config: Configures how configuration data will be loaded and bound to objects.
ConfigObject<T> - Interface in ratpack.config
ConfigSource - Interface in ratpack.config: Allows providing custom sources of configuration data.
configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.config.ConfigDataSpec: Configures the object mapper used for binding configuration data to arbitrary objects.
configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.server.ServerConfig.Builder: Configures the object mapper used for binding configuration data to arbitrary objects.
connect(Downstream<? super T>) - Method in interface ratpack.exec.Upstream: Connect the downstream.
connect(Action<? super WebSocketSpec<T>>) - Method in interface ratpack.websocket.WebSocketConnector
constant(T) - Static method in interface ratpack.func.Function
constant(T) - Static method in class ratpack.stream.Streams: Creates a new publisher, that indefinitely streams the given object to all subscribers.
contains(CharSequence) - Method in interface ratpack.http.Headers: Checks whether a header has been specified for the given value.
contains(String) - Method in interface ratpack.http.Headers: Checks whether a header has been specified for the given value.
contentType(CharSequence) - Method in interface ratpack.http.Response
contentType(CharSequence) - Method in interface ratpack.http.ResponseMetaData: Sets the response Content-Type header.
contentTypeIfNotSet(Supplier<CharSequence>) - Method in interface ratpack.http.Response
contentTypeIfNotSet(CharSequence) - Method in interface ratpack.http.Response
contentTypeIfNotSet(CharSequence) - Method in interface ratpack.http.ResponseMetaData: Sets the response Content-Type header, if it has not already been set.
contentTypes(String...) - Static method in class ratpack.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.handling: The context of an individual Handler invocation.
ContextualException - Interface in ratpack.error: A marker interface to indicate that if an exception has a cause, it is merely providing service.
cookie(String, String) - Method in interface ratpack.http.ResponseMetaData: Creates a new cookie with the given name and value.
copy(Headers) - Method in interface ratpack.http.MutableHeaders
create() - Method in interface ratpack.func.Factory: Creates a new object.
create(Registry) - Method in interface ratpack.launch.HandlerFactory: Creates a handler from the given launch config.
current() - Static method in interface ratpack.exec.ExecControl: Provides the execution control bound to 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.

D

data(Function<? super T, String>) - Method in interface ratpack.sse.Event: Sets the “data” value of the event to the return value of the given function.
data(String) - Method in interface ratpack.sse.Event: Specify the event data for the server sent event.
decorate(Registry, Handler) - Method in interface ratpack.handling.HandlerDecorator: Creates a new handler that decorates the application handlers, given as the rest argument.
decorate(Context, T) - Method in interface ratpack.render.RenderableDecorator: Decorates the given object on its way to being rendered.
decorator() - Static method in class ratpack.handling.ResponseTimer: Creates a handler decorator that prepends a response timer to the rest of the handlers.
DEFAULT_BASE_DIR_MARKER_FILE_PATH - Static variable in interface ratpack.server.ServerConfig.Builder: The default name for the base dir sentinel properties file.
DEFAULT_ENV_PREFIX - Static variable in interface ratpack.server.ServerConfig.Builder
DEFAULT_MAX_CONTENT_LENGTH - Static variable in interface ratpack.server.ServerConfig: The default max content length.
DEFAULT_NAME_TOKEN - Static variable in class ratpack.health.HealthCheckHandler: The default path token name that indicates the individual health check to run.
DEFAULT_PORT - Static variable in interface ratpack.server.ServerConfig: The default port for Ratpack applications, 5050.
DEFAULT_PROP_PREFIX - Static variable in interface ratpack.server.ServerConfig.Builder
DEFAULT_THREADS - Static variable in interface ratpack.server.ServerConfig: The default number of threads an application should use.
defer(Action<? super Runnable>) - Method in interface ratpack.exec.Promise: Allows the execution of the promise to be deferred to a later time.
delete(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of DELETE.
delete(Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of DELETE.
delete(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is DELETE.
delete(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
delete(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is DELETE and the path is at the current root.
delete(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
delete() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is DELETE, otherwise raises a 405 client error.
development(boolean) - Method in interface ratpack.server.ServerConfig.Builder: Whether or not the application is "development".
DirectChannelAccess - Interface in ratpack.handling.direct: Provides direct access to the underlying Netty Channel.
DoubleTransmissionException - Exception in ratpack.handling
DoubleTransmissionException(String) - Constructor for exception ratpack.handling.DoubleTransmissionException
Downstream<T> - Interface in ratpack.exec: A consumer of a single asynchronous value.

E

embedded() - Static method in interface ratpack.server.ServerConfig: Creates a builder configured to use no base dir, development mode and an ephemeral port.
embedded(Path) - Static method in interface ratpack.server.ServerConfig: Creates a builder configured to use the given base dir, development mode and an ephemeral port.
empty() - Static method in class ratpack.registry.Registries: Returns an empty registry.
env() - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for environment variables starting with the prefix "RATPACK_".
env(String) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for environment variables starting with the specified prefix.
env(String, Function<String, String>) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for environment variables starting with the specified prefix.
env(EnvironmentParser) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for environment variables using custom parsing logic.
env() - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for environment variables starting with the prefix "RATPACK_".
env(String) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for environment variables starting with the specified prefix.
env(String, Function<String, String>) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for environment variables starting with the specified prefix.
env(EnvironmentParser) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for environment variables using custom parsing logic.
EnvironmentParser - Interface in ratpack.config: Strategy for parsing a set of environment variables into a form appropriate for use in a ConfigSource.
equals(Object) - Method in class ratpack.func.Pair: A pair is equal if its left and right items are equal to the left and right items of this respectively.
error(Context, int) - Method in interface ratpack.error.ClientErrorHandler: Handle a client error.
error(Context, Throwable) - Method in interface ratpack.error.ServerErrorHandler: Processes the given exception that occurred processing the given context.
error(Throwable) - Method in interface ratpack.exec.Downstream: Signals the unsuccessful production of the upstream value.
error(Throwable) - Method in interface ratpack.exec.Fulfiller: Fulfills the promise with an error result.
error(Throwable) - Static method in interface ratpack.exec.Result: Creates a new error result.
error(Throwable) - Method in interface ratpack.handling.Context: Forwards the exception to the ServerErrorHandler in this service.
error(Throwable) - Method in interface ratpack.stream.WriteStream: Signals a stream error.
Event<T> - Interface in ratpack.sse: An individual event in a server sent event stream.
event(Function<? super T, String>) - Method in interface ratpack.sse.Event: Sets the “event” value of the event to the return value of the given function.
event(String) - Method in interface ratpack.sse.Event: Specify the event type for the server sent event.
eventLoop(EventLoop) - Method in interface ratpack.exec.ExecBuilder: Specifies that the execution must run on the given event loop.
Exceptions - Class in ratpack.util: Utility methods for dealing with exceptions.
Exceptions() - Constructor for class ratpack.util.Exceptions
ExecBuilder - Interface in ratpack.exec: Builds, and initiates, a new execution.
ExecControl - Interface in ratpack.exec: Provides methods for controlling execution(i.e.
execControl() - Static method in interface ratpack.exec.ExecControl: An exec control that binds to the thread's execution on demand.
ExecController - Interface in ratpack.exec: The exec controller manages the execution of operations.
ExecInterceptor - Interface in ratpack.exec: Intercepts execution, primarily for traceability and recording metrics.
ExecInterceptor.ExecType - Enum in ratpack.exec: The execution type (i.e.
ExecResult<T> - Interface in ratpack.exec: The result of an execution.
execute(T) - Method in interface ratpack.func.Action: Executes the action against the given thing.
execute(T, U) - Method in interface ratpack.func.BiAction: Executes the action against the given thing.
execute() - Method in interface ratpack.func.Block: Execute the action.
Execution - Interface in ratpack.exec: A logical stream of execution, which is potentially serialized over many threads.
execution() - Static method in interface ratpack.exec.Execution: Provides the currently execution execution.
ExecutionException - Exception in ratpack.exec: Thrown when an execution sequence is invalid.
ExecutionException(String) - Constructor for exception ratpack.exec.ExecutionException: Constructor.
expireCookie(String) - Method in interface ratpack.http.ResponseMetaData: Adds a cookie to the response with a 0 max-age, forcing the client to expire it.

F

Factory<T> - Interface in ratpack.func: An object that creates another.
failedPromise(Throwable) - Method in interface ratpack.exec.ExecControl: Creates a failed promise with the given error.
fanOut(Publisher<? extends Iterable<T>>) - Static method in class ratpack.stream.Streams: Returns a publisher that publishes each element from Collections that are produced from the given input publisher.
file(String) - Method in interface ratpack.file.FileSystemBinding: Creates a file reference relative to the bind point denoted by the given relative path.
file(String) - Method in interface ratpack.form.Form: Return the first uploaded file with the given name.
file(String) - Method in interface ratpack.handling.Context: Gets the file relative to the contextual FileSystemBinding.
files(String) - Method in interface ratpack.form.Form: Return all of the uploaded files with the given name.
files() - Method in interface ratpack.form.Form: Returns all of the uploaded files.
fileSystem(String, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Adds a handler to this chain that changes the FileSystemBinding for the given handler chain.
fileSystem(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
fileSystem(ServerConfig, String, Handler) - Static method in class ratpack.handling.Handlers: A handlers that changes the FileSystemBinding for the given handlers.
FileSystemBinding - Interface in ratpack.file: A file system binding represents a file system location that is used to resolve relative paths.
FileSystemChecksumService - Interface in ratpack.file
FileSystemChecksumServices - Class in ratpack.file: Factory methods for creating FileSystemChecksumService.
filter(Pair<String, String>) - Method in interface ratpack.config.EnvironmentParser: Provides an opportunity to remove environment variables from parsing by the remainder of the pipeline.
filter(Publisher<T>, Predicate<T>) - Static method in class ratpack.stream.Streams: Returns a publisher that filters items from the given input stream by applying the given filter predicate.
filter(Predicate<T>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.filter(Publisher, Predicate).
findBaseDir() - Static method in interface ratpack.server.ServerConfig: Creates a server config builder with the base dir as the “directory” on the classpath that contains a file called .ratpack.
findBaseDir(String) - Static method in interface ratpack.server.ServerConfig: Creates a server config builder with the base dir as the “directory” on the classpath that contains the marker file at the given path.
first(TypeToken<T>, Function<? super T, ? extends O>) - Method in interface ratpack.registry.Registry: Find and transform an item.
first(Class<T>, Function<? super T, ? extends O>) - Method in interface ratpack.registry.Registry
flatMap(Factory<? extends Promise<T>>) - Method in interface ratpack.exec.Operation
flatMap(Promise<T>) - Method in interface ratpack.exec.Operation
flatMap(Function<? super T, ? extends Promise<O>>) - Method in interface ratpack.exec.Promise: Transforms the promised value by applying the given function to it that returns a promise for the transformed value.
flatMap(Publisher<I>, Function<? super I, ? extends Promise<? extends O>>) - Static method in class ratpack.stream.Streams: Returns a publisher that publishes items from the given input publisher after transforming each item via the given, promise returning, function.
flatMap(Function<? super T, ? extends Promise<? extends O>>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.flatMap(Publisher, Function).
flatYield(Function<? super YieldRequest, ? extends Promise<? extends T>>) - Static method in class ratpack.stream.Streams: Creates a new publisher, backed by the given asynchronous data producing function.
fork() - Method in interface ratpack.exec.ExecControl: Initiates a new execution.
fork() - Method in interface ratpack.handling.Context: Forks a new execution, detached from the current.
Form - Interface in ratpack.form: An uploaded form.
form() - Static method in interface ratpack.form.Form: Creates a parseable object to parse a request body into a Form.
form(boolean) - Static method in interface ratpack.form.Form: Creates a parseable object to parse a request body into a Form.
FormParseOpts - Interface in ratpack.form: Options for parsing a Form.
from(Consumer<T>) - Static method in interface ratpack.func.Action: Creates an action from a JDK consumer.
from(BiConsumer<T, U>) - Static method in interface ratpack.func.BiAction: Creates an bi-action from a JDK bi-consumer.
from(Function<I, O>) - Static method in interface ratpack.func.Function: Creates a function of this type from a JDK style function.
from(Predicate<T>) - Static method in interface ratpack.func.Predicate: Creates a predicate from a JDK predicate.
fromGuava(Function<I, O>) - Static method in interface ratpack.func.Function: Creates a function of this type from a Guava style function.
fromGuava(Predicate<T>) - Static method in interface ratpack.func.Predicate: Creates a predicate from a Guava predicate.
Fulfiller<T> - Interface in ratpack.exec: A fulfiller of an asynchronous promise.
Fulfillment<T> - Interface in ratpack.exec: Convenience type for Action<Fulfiller<T>> implementations.
Function<I,O> - Interface in ratpack.func: A single argument function.

G

gate(Publisher<T>, Action<? super Runnable>) - Static method in class ratpack.stream.Streams: Allows requests from the subscriber of the return publisher to be withheld from the given publisher until an externally defined moment.
gate(Action<? super Runnable>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.gate(Publisher, Action).
generate(Context) - Method in interface ratpack.handling.RequestId.Generator: Generate a request ID with a “unique” ID value.
get(String, Class<O>) - Method in interface ratpack.config.ConfigData: Binds a segment of the configuration data to the specified type.
get(Class<O>) - Method in interface ratpack.config.ConfigData: Binds the root of the configuration data to the specified type.
get(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of GET.
get(Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of GET.
get(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is GET.
get(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
get(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is GET and the path is at the current root.
get(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
get() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is GET, otherwise raises a 405 client error.
get(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient: An asynchronous method to do a GET HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a GET.
get(URI) - Method in interface ratpack.http.client.HttpClient
get(CharSequence) - Method in interface ratpack.http.Headers: Returns the header value with the specified header name.
get(String) - Method in interface ratpack.http.Headers: Returns the header value with the specified header name.
get(Class<O>) - Method in interface ratpack.registry.Registry: Provides an object of the specified type, or throws an exception if no object of that type is available.
get(TypeToken<O>) - Method in interface ratpack.registry.Registry: Provides an object of the specified type, or throws an exception if no object of that type is available.
get(Object) - Method in interface ratpack.util.MultiValueMap: Get the first value for the key, or null if there are no values for the key.
getActive() - Method in interface ratpack.exec.Throttle: How many throttled promises are currently executing.
getAddress(Context) - Method in interface ratpack.server.PublicAddress: The advertised public address.
getAddress() - Method in interface ratpack.server.ServerConfig: The address of the interface that the application should bind to.
getAll(CharSequence) - Method in interface ratpack.http.Headers: Returns all of the header values with the specified header name.
getAll(String) - Method in interface ratpack.http.Headers: Returns all of the header values with the specified header name.
getAll(Class<O>) - Method in interface ratpack.registry.Registry: Returns all of the objects whose declared type is assignment compatible with the given type.
getAll(TypeToken<O>) - Method in interface ratpack.registry.Registry: Returns all of the objects whose declared type is assignment compatible with the given type.
getAll(K) - Method in interface ratpack.util.MultiValueMap: All of the values for the given key.
getAll() - Method in interface ratpack.util.MultiValueMap: Returns a new view of the map where each map value is a list of all the values for the given key (i.e.
getAllPathTokens() - Method in interface ratpack.handling.Context: The contextual path tokens of the current PathBinding.
getAllTokens() - Method in interface ratpack.path.PathBinding: Similar to PathBinding.getTokens() except that tokens of all parent bindings are included.
getAsConfigObject(String, Class<O>) - Method in interface ratpack.config.ConfigData: Binds a segment of the configuration data to the specified type.
getBaseDir() - Method in interface ratpack.server.ServerConfig: The base dir of the application, which is also the initial FileSystemBinding.
getBindHost() - Method in interface ratpack.server.RatpackServer: The actual host/ip that the application is bound to.
getBindPort() - Method in interface ratpack.server.RatpackServer: The actual port that the application is bound to.
getBlockingExecutor() - Method in interface ratpack.exec.ExecController
getBody() - Method in interface ratpack.http.client.ReceivedResponse
getBody() - Method in interface ratpack.http.client.RequestSpec: The body of the request, used for specifying the body content.
getBody() - Method in interface ratpack.http.client.StreamedResponse
getBody() - Method in interface ratpack.http.Request: The body of the request.
getBoundTo() - Method in interface ratpack.path.PathBinding: The path of the request path that was bound to.
getBuffer() - Method in interface ratpack.http.TypedData: The raw data as a (unmodifiable) buffer.
getBytes() - Method in interface ratpack.http.TypedData: The raw data as bytes.
getChannel() - Method in interface ratpack.handling.direct.DirectChannelAccess: The channel.
getCharset() - Method in interface ratpack.http.MediaType: The value of the "charset" parameter.
getCharset(String) - Method in interface ratpack.http.MediaType: The value of the "charset" parameter, or the given default value of no charset was specified.
getClosedAt() - Method in interface ratpack.handling.RequestOutcome: The time at when this request was dealt with from the application's point of view.
getCode() - Method in interface ratpack.http.Status: The status code.
getConfigSources() - Method in interface ratpack.config.ConfigDataSpec: Returns the config sources used for configuration binding.
getConnection() - Method in interface ratpack.websocket.WebSocketMessage
getContentType(String) - Method in interface ratpack.file.MimeTypes: Calculate the mime type for the given file.
getContentType() - Method in class ratpack.http.ResponseChunks: The intended value of the content-type header.
getContentType() - Method in interface ratpack.http.TypedData: The type of the data.
getContentType() - Method in exception ratpack.parse.NoSuchParserException: The content type of the request.
getContentType() - Method in interface ratpack.parse.Parser: The content type that this parser knows how to deserialize.
getContentType() - Method in class ratpack.parse.ParserSupport: The content type that this parser knows how to deserialize.
getContext() - Method in interface ratpack.handling.Context: Returns this.
getControl() - Method in interface ratpack.exec.ExecController: A singleton that can be used from any managed thread to perform asynchronous or blocking operations.
getControl() - Method in interface ratpack.exec.Execution
getController() - Method in interface ratpack.exec.ExecControl
getController() - Method in interface ratpack.exec.Execution: The execution controller that this execution is associated with.
getController() - Method in interface ratpack.handling.Context
getCookies() - Method in interface ratpack.http.Request: The cookies that were sent with the request.
getCookies() - Method in interface ratpack.http.ResponseMetaData: The cookies that are to be part of the response.
getData() - Method in interface ratpack.sse.Event: The “data” value of the event.
getDate(CharSequence) - Method in interface ratpack.http.Headers: Returns the header value as a date with the specified header name.
getDate(String) - Method in interface ratpack.http.Headers: Returns the header value as a date with the specified header name.
getDirectChannelAccess() - Method in interface ratpack.handling.Context: Provides direct access to the backing Netty channel.
getError() - Method in class ratpack.health.HealthCheck.Result: The exception representing an unhealthy check, may be null.
getEvent() - Method in interface ratpack.sse.Event: The “event” value of the event.
getEventLoop() - Method in interface ratpack.exec.Execution
getEventLoopGroup() - Method in interface ratpack.exec.ExecController: The event loop group used by Netty for this application.
getExecControl() - Method in interface ratpack.server.StartEvent: An execution control.
getExecControl() - Method in interface ratpack.server.StopEvent: An execution control.
getExecution() - Method in interface ratpack.exec.ExecControl
getExecution() - Method in interface ratpack.handling.Context: The execution of handling this request.
getExecutor() - Method in interface ratpack.exec.ExecController: The event loop (i.e.
getFile() - Method in interface ratpack.file.FileSystemBinding: The actual point on the filesystem that this binding is bound to.
getFileName() - Method in interface ratpack.form.UploadedFile: The name given for the file.
getHeaders() - Method in interface ratpack.http.client.ReceivedResponse
getHeaders() - Method in interface ratpack.http.client.RequestSpec
getHeaders() - Method in interface ratpack.http.client.StreamedResponse
getHeaders() - Method in interface ratpack.http.Request: The request headers.
getHeaders() - Method in interface ratpack.http.ResponseMetaData: The response headers.
getHeaders() - Method in interface ratpack.http.SentResponse: The headers that were sent in the response.
getId() - Method in interface ratpack.handling.RequestId: The of the request.
getId() - Method in interface ratpack.sse.Event: The “id” value of the event.
getInputStream() - Method in interface ratpack.http.TypedData: An input stream of the data.
getItem() - Method in interface ratpack.sse.Event: The stream item that this event
getItem() - Method in interface ratpack.stream.StreamEvent: The data, if this event represents an emission of data.
getLeft() - Method in class ratpack.func.Pair: The left item of the pair.
getLocalAddress() - Method in interface ratpack.http.Request: The address of the local network interface that received the request.
getMaxContentLength() - Method in interface ratpack.server.ServerConfig: The max content length to use for the HttpObjectAggregator.
getMessage() - Method in class ratpack.health.HealthCheck.Result: Any message provided as part of the check, may be null.
getMessage() - Method in interface ratpack.http.Status: The message of the status.
getMethod() - Method in interface ratpack.http.Request: The method of the request.
getName() - Method in interface ratpack.health.HealthCheck: The unique name of the health check.
getName() - Method in class ratpack.health.HealthCheckHandler: The name of the path token that may indicate a particular health check to execute.
getName() - Method in interface ratpack.http.HttpMethod: The name of the method, always in upper case.
getName() - Method in interface ratpack.server.Service: The name of this service, used for display purposes.
getNames() - Method in interface ratpack.http.Headers: All header names.
getNettyHeaders() - Method in interface ratpack.http.Headers: Returns the headers in their Netty compliant form.
getNettyStatus() - Method in interface ratpack.http.Status: The status as Netty's type.
getNumThreads() - Method in interface ratpack.exec.ExecController: The number of threads that will be used for computation.
getObject() - Method in interface ratpack.config.ConfigObject
getObjectMapper() - Method in interface ratpack.config.ConfigDataSpec: Returns the object mapper used for configuration binding.
getOpenResult() - Method in interface ratpack.websocket.WebSocketClose
getOpenResult() - Method in interface ratpack.websocket.WebSocketMessage
getOpts() - Method in exception ratpack.parse.NoSuchParserException: The parse opts.
getOpts() - Method in class ratpack.parse.Parse: The type of object that provides options/configuration for the parsing.
getOptsType() - Method in interface ratpack.parse.Parser: The type of option object that this parser accepts.
getOptsType() - Method in class ratpack.parse.ParserSupport: The type of option object that this parser accepts.
getParams() - Method in interface ratpack.http.MediaType: The parameters of the mime type.
getPastBinding() - Method in interface ratpack.path.PathBinding: The section of the path that is "past" where the binding bound to.
getPath() - Method in interface ratpack.config.ConfigObject
getPath() - Method in interface ratpack.http.Request: The URI without the query string and leading forward slash.
getPathTokens() - Method in interface ratpack.handling.Context: The contextual path tokens of the current PathBinding.
getPort() - Method in interface ratpack.server.ServerConfig: The port that the application should listen to requests on.
getPublicAddress() - Method in interface ratpack.server.ServerConfig: The public address of the site used for redirects.
getPublisher() - Method in class ratpack.sse.ServerSentEvents: The stream of events.
getQuery() - Method in interface ratpack.http.Request: The query string component of the request URI, without the "?".
getQueryParams() - Method in interface ratpack.http.Request: TBD.
getRawUri() - Method in interface ratpack.http.Request: The raw URI of the request.
getRegistry() - Method in interface ratpack.exec.ExecResult: The execution registry.
getRegistry() - Method in interface ratpack.handling.Chain: The registry that backs this chain.
getRegistry() - Method in interface ratpack.server.StartEvent: The server registry.
getRegistry() - Method in interface ratpack.server.StopEvent: The server registry.
getRemoteAddress() - Method in interface ratpack.http.Request: The address of the client that initiated the request.
getRequest() - Method in interface ratpack.handling.Context: The HTTP request.
getRequest() - Method in interface ratpack.handling.RequestOutcome: The request.
getRequestAmount() - Method in interface ratpack.stream.StreamEvent: The request amount, if this event represents a request.
getRequestNum() - Method in interface ratpack.stream.YieldRequest
getRequiredConfig() - Method in interface ratpack.server.ServerConfig: The config objects that were declared as required when this server config was built.
getResponse() - Method in interface ratpack.handling.Context: The HTTP response.
getResponse() - Method in interface ratpack.handling.RequestOutcome: The response.
getResults() - Method in class ratpack.health.HealthCheckResults: The results.
getRight() - Method in class ratpack.func.Pair: The right item of the pair.
getScheme() - Method in interface ratpack.server.RatpackServer: The URL scheme the server uses.
getServerConfig() - Method in interface ratpack.handling.Chain: The server config of the application that this chain is being created for.
getServerConfig() - Method in interface ratpack.handling.Context: The server configuration for the application.
getSize() - Method in interface ratpack.exec.Throttle: The size of this throttle.
getSSLContext() - Method in interface ratpack.server.ServerConfig: The SSL context to use if the application will serve content over HTTPS.
getStatus() - Method in interface ratpack.http.client.ReceivedResponse
getStatus() - Method in interface ratpack.http.client.StreamedResponse
getStatus() - Method in interface ratpack.http.ResponseMetaData: The status that will be part of the response when sent.
getStatus() - Method in interface ratpack.http.SentResponse: The status line of the response.
getStatusCode() - Method in interface ratpack.http.client.ReceivedResponse
getStatusCode() - Method in interface ratpack.http.client.StreamedResponse
getSubscriberNum() - Method in interface ratpack.stream.YieldRequest
getSubscriptionId() - Method in interface ratpack.stream.StreamEvent: The opaque id of the subscription that this event relates to.
getText() - Method in interface ratpack.http.TypedData: The data as text.
getText(Charset) - Method in interface ratpack.http.TypedData
getText() - Method in interface ratpack.websocket.WebSocketMessage
getThreads() - Method in interface ratpack.server.ServerConfig: The number of threads for handling application requests.
getThrottle() - Method in class ratpack.health.HealthCheckHandler: The throttle for executing health checks.
getThrowable() - Method in interface ratpack.exec.Result: The error exception.
getThrowable() - Method in interface ratpack.stream.StreamEvent: The error, if this event represents an error.
getTokens() - Method in interface ratpack.path.PathBinding: Any tokens that the binding has extracted from the path.
getType() - Method in interface ratpack.config.ConfigObject
getType() - Method in interface ratpack.http.MediaType: The type without parameters.
getType() - Method in exception ratpack.parse.NoSuchParserException: The target type.
getType() - Method in class ratpack.parse.Parse: The type of object to construct from the request body.
getType() - Method in interface ratpack.render.RenderableDecorator: The type of objects that this decorator decorates.
getType() - Method in class ratpack.render.RenderableDecoratorSupport: The type of objects that this decorator decorates.
getType() - Method in interface ratpack.render.Renderer: The type of object that this renderer can render.
getType() - Method in class ratpack.render.RendererSupport: The type of object that this renderer can render (the type for T).
getUri() - Method in interface ratpack.http.Request: The complete URI of the request (path + query string).
getUrl() - Method in interface ratpack.http.client.RequestSpec
getValue() - Method in interface ratpack.exec.Result: The result value.
getValueOrThrow() - Method in interface ratpack.exec.Result: Returns the value if this is a success result, or throws the exception if it's an error.
getVersion() - Static method in class ratpack.util.RatpackVersion: The version of Ratpack.
getWaiting() - Method in interface ratpack.exec.Throttle: The number of throttled promises that are waiting to execute (that is, the queue size).

H

handle(Context) - Method in interface ratpack.handling.Handler: Handles the context.
handle(Context) - Method in class ratpack.handling.InjectionHandler: Invokes the custom "handle" method, extracting necessary parameters from the context to satisfy the call.
handle(Context) - Method in class ratpack.handling.ResponseTimer: Adds the number of milliseconds of elapsed time between the invocation of this method and when the response is ready to be sent.
handle(Context) - Method in class ratpack.health.HealthCheckHandler: Renders health checks.
handler(Handler) - Method in interface ratpack.handling.Chain: Adds the given handler to this.
handler(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
handler(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path exactly.
handler(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
Handler - Interface in ratpack.handling: A handler participates in the processing of a request/response pair, operating on a Context.
handler(Class<? extends Handler>) - Method in interface ratpack.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.server.RatpackServerSpec: Sets the root handler to the return of the given function.
HandlerDecorator - Interface in ratpack.handling: Decorates a handler, effectively wrapping it.
HandlerFactory - Interface in ratpack.launch: A factory contract for creating handlers, typically the root handler of the application.
Handlers - Class in ratpack.handling: Factory methods for handler decorations.
handlers(Action<? super Chain>) - Method in interface ratpack.server.RatpackServerSpec: Sets the root handler to the chain specified by the given action.
hashCode() - Method in class ratpack.func.Pair: Hash code.
header(String, String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler to the chain that delegates to the given handler if the request has a header with the given name and a its value matches the given value exactly.
header(String, String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
header(String, String, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handler if the request has a HTTPHeader with the given name and a it's value matches the given value exactly.
HEADER_NAME - Static variable in class ratpack.handling.ResponseTimer: The name of the header with the time value: "X-Response-Time".
headers(Action<? super MutableHeaders>) - Method in interface ratpack.http.client.RequestSpec: This method can be used to compose changes to the headers.
Headers - Interface in ratpack.http: An immutable set of HTTP headers.
HealthCheck - Interface in ratpack.health: Reports on the health of some aspect of the system.
HealthCheck.Result - Class in ratpack.health: The result of a health check.
HealthCheckHandler - Class in ratpack.health: A handler that executes health checks and renders the results.
HealthCheckHandler() - Constructor for class ratpack.health.HealthCheckHandler: Uses the default values of HealthCheckHandler.DEFAULT_NAME_TOKEN and an unlimited throttle.
HealthCheckHandler(String) - Constructor for class ratpack.health.HealthCheckHandler: Uses an unlimited throttle and the given name for the health check identifying path token.
HealthCheckHandler(Throttle) - Constructor for class ratpack.health.HealthCheckHandler: Uses the HealthCheckHandler.DEFAULT_NAME_TOKEN and the given throttle.
HealthCheckHandler(String, Throttle) - Constructor for class ratpack.health.HealthCheckHandler: Constructor.
HealthCheckResults - Class in ratpack.health: A value type representing the result of running multiple health checks.
HealthCheckResults(ImmutableSortedMap<String, HealthCheck.Result>) - Constructor for class ratpack.health.HealthCheckResults: Constructor.
healthy() - Static method in class ratpack.health.HealthCheck.Result: Creates a healthy result, with no message.
healthy(String) - Static method in class ratpack.health.HealthCheck.Result: Creates a healthy result, with the given message.
healthy(String, Object...) - Static method in class ratpack.health.HealthCheck.Result: Creates a healthy result, with the given message.
host(String, Action<? super Chain>) - Method in interface ratpack.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, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
host(String, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handler if the request has a HTTPHost with the given name that matches the given value exactly.
host(String) - Method in interface ratpack.http.HttpUrlBuilder: Sets the host to the given value.
html(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/html".
html(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/html".
http() - Static method in interface ratpack.http.HttpUrlBuilder: Create a new HTTP URL builder.
HttpClient - Interface in ratpack.http.client: A http client that makes all HTTP requests asynchronously and returns a Promise.
httpClient(ServerConfig, Registry) - Static method in interface ratpack.http.client.HttpClient: A method to create an instance of the default implementation of HttpClient.
httpClient(ExecController, ByteBufAllocator, int) - Static method in interface ratpack.http.client.HttpClient: A method to create an instance of the default implementation of HttpClient.
HttpMethod - Interface in ratpack.http: The method of a HTTP request.
https() - Static method in interface ratpack.http.HttpUrlBuilder: Create a new HTTPS URL builder.
HttpUrlBuilder - Interface in ratpack.http: Builds a HTTP URL, safely.

I

id(Function<? super T, String>) - Method in interface ratpack.sse.Event: Sets the “id” value of the event to the return value of the given function.
id(String) - Method in interface ratpack.sse.Event: Specify the event id for the server sent event.
identity() - Static method in interface ratpack.func.Function: Returns an identity function (return value always same as input).
ignoreArg(Block) - Static method in interface ratpack.func.Action
InjectionHandler - Class in ratpack.handling: A super class that removes the boiler plate of retrieving objects from the context registry by injecting them based on a method signature.
InjectionHandler() - Constructor for class ratpack.handling.InjectionHandler: Constructor.
InjectionHandler.NoSuitableHandleMethodException - Exception in ratpack.handling: Exception thrown if the subclass doesn't provide a valid handle method.
insert(Action<? super Chain>) - Method in interface ratpack.handling.Chain: Inserts the given nested handler chain.
insert(Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
insert(Handler...) - Method in interface ratpack.handling.Context: Inserts some handlers into the pipeline, then delegates to the first.
insert(Registry, Handler...) - Method in interface ratpack.handling.Context: Inserts some handlers into the pipeline to execute with the given registry, then delegates to the first.
instance() - Static method in class ratpack.logging.MDCInterceptor
intercept(Execution, ExecInterceptor.ExecType, Block) - Method in interface ratpack.exec.ExecInterceptor: Intercepts the “rest” of the execution on the current thread.
intercept(Execution, ExecInterceptor.ExecType, Block) - Method in class ratpack.logging.MDCInterceptor
isAjaxRequest() - Method in interface ratpack.http.Request: A flag representing whether or not the request originated via AJAX.
isCancel() - Method in interface ratpack.stream.StreamEvent: Whether or not this event represents cancellation of the stream.
isComplete() - Method in interface ratpack.exec.ExecResult: Is the result that the execution completed without a value being returned.
isComplete() - Method in interface ratpack.stream.StreamEvent: Whether or not this event represents the completion of the stream.
isData() - Method in interface ratpack.stream.StreamEvent: Whether or not this event represents an emission of data.
isDelete() - Method in interface ratpack.http.HttpMethod: True if the method is DELETE.
isDevelopment() - Method in interface ratpack.server.ServerConfig: Whether or not the server is in "development" mode.
isEmpty() - Method in interface ratpack.http.MediaType: True if this represents the absence of a value (i.e.
isError() - Method in interface ratpack.exec.Result: True if this was an error result.
isError() - Method in interface ratpack.stream.StreamEvent: Whether or not this event represents an error.
isForm() - Method in interface ratpack.http.MediaType: True if this type equals "application/x-www-form-urlencoded".
isFromClient() - Method in interface ratpack.websocket.WebSocketClose
isFromServer() - Method in interface ratpack.websocket.WebSocketClose
isGet() - Method in interface ratpack.http.HttpMethod: True if the method is GET or HEAD.
isHasBaseDir() - Method in interface ratpack.server.ServerConfig: Whether or not the base dir of the application has been set.
isHead() - Method in interface ratpack.http.HttpMethod: True if the method is HEAD.
isHealthy() - Method in class ratpack.health.HealthCheck.Result: Was the component being checked healthy?
isHtml() - Method in interface ratpack.http.MediaType: True if this type equals "text/html".
isIncludeQueryParams() - Method in interface ratpack.form.FormParseOpts: Whether to include the query parameters from the request in the parsed form.
isJson() - Method in interface ratpack.http.MediaType: True if this type equals "application/json".
isManagedThread() - Method in interface ratpack.exec.ExecController: Indicates whether the current thread is managed by this execution controller.
isOpen() - Method in interface ratpack.websocket.WebSocket
isOptions() - Method in interface ratpack.http.HttpMethod: True if the method is OPTIONS.
isPatch() - Method in interface ratpack.http.HttpMethod: True if the method is PATCH.
isPost() - Method in interface ratpack.http.HttpMethod: True if the method is POST.
isPut() - Method in interface ratpack.http.HttpMethod: True if the method is PUT.
isReload() - Method in interface ratpack.server.StartEvent: If the server is starting in response to a reload (during development), as opposed to for the first time.
isReload() - Method in interface ratpack.server.StopEvent: If the server is stopping in response to a reload (during development), as opposed to for the first time.
isRequest() - Method in interface ratpack.stream.StreamEvent: Whether or not this event represents a request for more data.
isRunning() - Method in interface ratpack.server.RatpackServer: Returns true if the server is running.
isSuccess() - Method in interface ratpack.exec.Result: True if this was a success result.
isText() - Method in interface ratpack.http.MediaType: True if this type starts with "text/".
item(T) - Method in interface ratpack.stream.WriteStream: Emit an item.
itemMap(Action<? super O>) - Method in interface ratpack.stream.WriteStream: Creates a new write stream that passes error and complete signals on to this stream, but passes items to the given action.

J

join(Action<? super T>...) - Static method in interface ratpack.func.Action: Returns a new action that executes the given actions in order.
join(Registry) - Method in interface ratpack.registry.Registry: Creates a new registry by joining this registry with the given registry
json(ByteSource) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a JSON file.
json(Path) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a JSON file.
json(String) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a JSON file.
json(URL) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a JSON file.
json(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "application/json".
json(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "application/json".
json(ByteSource) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a JSON file.
json(Path) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a JSON file.
json(String) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a JSON file.
json(URL) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a JSON file.
just(Class<T>, Supplier<? extends T>) - Static method in class ratpack.registry.Registries: Creates a single lazily created entry registry, using RegistryBuilder.addLazy(Class, Supplier).
just(Object) - Static method in class ratpack.registry.Registries: Creates a single entry registry, using RegistryBuilder.add(Object).
just(Class<? super T>, T) - Static method in class ratpack.registry.Registries: Creates a single entry registry, using RegistryBuilder.add(Class, Object).

L

lastModified(Date, Runnable) - Method in interface ratpack.handling.Context: Convenience method for handling last-modified based HTTP caching.
left(Promise<O>) - Method in interface ratpack.exec.Promise
left - Variable in class ratpack.func.Pair: The left item of the pair.
left() - Method in class ratpack.func.Pair: The left item of the pair.
left(T) - Method in class ratpack.func.Pair: Replaces the left item with the given item.
listOf(Class<T>) - Static method in class ratpack.util.Types: Creates a type token for a list of of the given type.
literal(String) - Method in interface ratpack.path.PathBinderBuilder: Add a literal to the path.
literalPattern(String) - Method in interface ratpack.path.PathBinderBuilder: Add a regular expression parameterized literal element to the path.
loadConfigData(ObjectMapper) - Method in interface ratpack.config.ConfigSource: Loads the configuration data from this data source.

M

map(String) - Method in interface ratpack.config.EnvironmentParser: Transforms a segment.
map(Factory<? extends T>) - Method in interface ratpack.exec.Operation
map(Function<? super T, ? extends O>) - Method in interface ratpack.exec.Promise: Transforms the promised value by applying the given function to it.
map(Function<? super Pair<L, R>, ? extends T>) - Method in class ratpack.func.Pair: Applies the given function to this, returning the result.
map(Publisher<I>, Function<? super I, ? extends O>) - Static method in class ratpack.stream.Streams: Returns a publisher that publishes items from the given input publisher after transforming each item via the given function.
map(Function<? super T, ? extends O>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.map(Publisher, Function).
mapError(Function<? super Throwable, ? extends T>) - Method in interface ratpack.exec.Promise: Transforms the promise failure (potentially into a value) by applying the given function to it.
mapLeft(Function<? super L, ? extends T>) - Method in class ratpack.func.Pair: Creates a new pair, with the left item being the result of applying the given function to the left item of this.
mapRight(Function<? super R, ? extends T>) - Method in class ratpack.func.Pair: Creates a new pair, with the right item being the result of applying the given function to the right item of this.
maxContentLength(int) - Method in interface ratpack.server.ServerConfig.Builder: The max number of bytes a request body can be.
maxLength(int) - Method in interface ratpack.websocket.WebSocketSpec
maybeGet(Class<O>) - Method in interface ratpack.registry.Registry: Does the same thing as Registry.get(Class), except returns null instead of throwing an exception.
maybeGet(TypeToken<O>) - Method in interface ratpack.registry.Registry: Does the same thing as Registry.get(Class), except returns null instead of throwing an exception.
md5(ServerConfig, String, String...) - Static method in class ratpack.file.FileSystemChecksumServices: Get checksum service with MD5 calculation method.
MD5Checksummer - Class in ratpack.file.checksummer: Calculate checksum with MD5 algorithm.
MD5Checksummer() - Constructor for class ratpack.file.checksummer.MD5Checksummer
MDCInterceptor - Class in ratpack.logging: An execution interceptor that adds support for SLF4J's Mapped Diagnostic Context (MDC) feature.
MDCInterceptor() - Constructor for class ratpack.logging.MDCInterceptor
MediaType - Interface in ratpack.http: A structured value for a Content-Type header value.
merge(Publisher<? extends T>...) - Static method in class ratpack.stream.Streams: Returns a publisher that merges the given input publishers into a single stream of elements.
method(String) - Method in interface ratpack.http.client.RequestSpec: Set the HTTP verb to use.
MimeTypes - Interface in ratpack.file: A registry for mime types.
multicast(Publisher<T>) - Static method in class ratpack.stream.Streams: Returns a publisher that will stream events emitted from the given publisher to all of its subscribers.
multicast() - Method in interface ratpack.stream.TransformablePublisher: See Streams.multicast(Publisher).
MultiValueMap<K,V> - Interface in ratpack.util: A map that may contain multiple values for a given key, but typically only one value.
MutableHeaders - Interface in ratpack.http: A set of HTTP headers that can be changed.
MutableRegistry - Interface in ratpack.registry: A Registry that is also mutable.

N

name(String) - Method in interface ratpack.http.HttpMethod: Returns true if the method has the given name, insensitive to case.
named(String, Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of methodName.
named(String, Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of methodName.
nest(Block, Block) - Method in interface ratpack.exec.ExecControl
nest(Block, Block, Action<? super Throwable>) - Method in interface ratpack.exec.ExecControl
nestLeft(T) - Method in class ratpack.func.Pair: Creates a new pair, with pair(t, this.left) as the left item and the the right value of this as the right.
nestRight(T) - Method in class ratpack.func.Pair: Creates a new pair, with pair(t, this.right) as the right item and the the left value of this as the left.
next(Operation) - Method in interface ratpack.exec.Operation
next(Block) - Method in interface ratpack.exec.Operation
next(Promise<O>) - Method in interface ratpack.exec.Promise
next() - Method in interface ratpack.handling.Context: Delegate handling to the next handler in line.
next(Registry) - Method in interface ratpack.handling.Context: Invokes the next handler, after adding the given registry.
next() - Static method in class ratpack.handling.Handlers: A handler that simply delegates to the next handler.
noBaseDir() - Static method in interface ratpack.server.ServerConfig: Creates a builder configured to use no base dir.
NoBaseDirException - Exception in ratpack.server: Thrown when a request is made for the base directory of the application in an application launch config where no base directory has been set.
NoBaseDirException(String) - Constructor for exception ratpack.server.NoBaseDirException: Constructor.
noCompress() - Method in interface ratpack.http.Response: Prevents the response from being compressed.
noCompress() - Method in interface ratpack.http.ResponseMetaData
noMatch(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client's requested content type cannot be matched with any of the other handlers.
noMatch(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client's requested content type cannot be matched with any of the other handlers.
noMatch(String) - Method in interface ratpack.handling.ByContentSpec: Specifies that the handler for the specified content type should be used if the client's requested content type cannot be matched with any of the other handlers.
NonBlocking - Annotation Type in ratpack.api: Declares that a method is non blocking, making no guarantees about when it will return.
noop() - Static method in interface ratpack.exec.Operation
noop() - Static method in interface ratpack.func.Action: Returns an action that does precisely nothing.
noop() - Static method in interface ratpack.func.Block
noopIfNull(Action<T>) - Static method in interface ratpack.func.Action: If the given action is null, returns Action.noop(), otherwise returns the given action.
NoOptParserSupport - Class in ratpack.parse: A convenience base for parsers that don't require options.
NoOptParserSupport(String) - Constructor for class ratpack.parse.NoOptParserSupport: Constructor.
NoSuchParserException - Exception in ratpack.parse: Thrown when a request is made to parse the request, but no suitable parser was found that matched the content type and parse object.
NoSuchParserException(TypeToken<?>, Object, String) - Constructor for exception ratpack.parse.NoSuchParserException: Constructor.
NoSuchRendererException - Exception in ratpack.render: Thrown when a request is made to render an object, but no suitable renderer can be found.
NoSuchRendererException(Object) - Constructor for exception ratpack.render.NoSuchRendererException: Constructor.
NoSuitableHandleMethodException(Class<?>, SecurityException) - Constructor for exception ratpack.handling.InjectionHandler.NoSuitableHandleMethodException
notFound() - Static method in class ratpack.handling.Handlers: Convenience for clientError(404).
NotInRegistryException - Exception in ratpack.registry: Thrown when a request is made for an object that a registry cannot provide.
NotInRegistryException(TypeToken<?>) - Constructor for exception ratpack.registry.NotInRegistryException: Constructs the exception.
NotInRegistryException(String) - Constructor for exception ratpack.registry.NotInRegistryException: Constructor.
Nullable - Annotation Type in ratpack.api: Denotes that something may be null.
NullParseOpts - Class in ratpack.parse: A generic parse type that can be used when parsers do not need any extra information from parse objects other than type.

O

of() - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a default object mapper.
of(Action<? super ConfigDataSpec>) - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a default object mapper, from the given definition.
of(Module...) - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a default object mapper with the supplied modules registered.
of(List<Module>, Action<? super ConfigDataSpec>) - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a default object mapper with the supplied modules registered, from the given definition.
of(ObjectMapper) - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a specified object mapper.
of(ObjectMapper, Action<? super ConfigDataSpec>) - Static method in interface ratpack.config.ConfigData: Begins building a new application configuration using a specified object mapper, from the given definition.
of(Block) - Static method in interface ratpack.exec.Operation
of(L, R) - Static method in class ratpack.func.Pair: Creates a new pair.
of(String, BiFunction<? super ExecControl, ? super Registry, ? extends Promise<HealthCheck.Result>>) - Static method in interface ratpack.health.HealthCheck: Convenience factory for health check implementations.
of(int, String) - Static method in interface ratpack.http.Status: Creates a new status object.
of(int) - Static method in interface ratpack.http.Status: Creates a new status object.
of(TypeToken<T>, O) - Static method in class ratpack.parse.Parse: Creates a parse object.
of(TypeToken<T>) - Static method in class ratpack.parse.Parse: Creates a parse object, with a NullParseOpts options object.
of(Class<T>, O) - Static method in class ratpack.parse.Parse: Creates a parse object.
of(Class<T>) - Static method in class ratpack.parse.Parse: Creates a parse object, with a NullParseOpts options object.
of(Class<T>, BiFunction<? super Context, ? super T, ? extends T>) - Static method in interface ratpack.render.RenderableDecorator: Creates a renderable decorator implementation for the given type that uses the function as decorator.
of(Class<T>, BiConsumer<? super Context, ? super T>) - Static method in interface ratpack.render.Renderer: Creates a renderer implementation from the given arguments.
of(Action<? super RatpackServerSpec>) - Static method in interface ratpack.server.RatpackServer: Creates a new, unstarted, Ratpack server from the given definition.
ofAsync(Class<T>, BiFunction<? super Context, ? super T, ? extends Promise<T>>) - Static method in interface ratpack.render.RenderableDecorator: Creates a renderable decorator implementation for the given type that uses the function as decorator.
ofSize(int) - Static method in interface ratpack.exec.Throttle: Create a new throttle of the given size.
OK - Static variable in interface ratpack.http.Status
onCleanup(AutoCloseable) - Method in interface ratpack.exec.Execution
onClose(Action<? super RequestOutcome>) - Method in interface ratpack.handling.Context: Registers a callback to be notified when the request for this context is “closed” (i.e.
onClose(WebSocketClose<T>) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onClose(WebSocketClose<T>) - Method in interface ratpack.websocket.WebSocketHandler
onClose(Action<WebSocketClose<T>>) - Method in interface ratpack.websocket.WebSocketSpec
onComplete(Block) - Method in interface ratpack.exec.Downstream: Wrap this downstream, using the given action as the implementation of the Downstream.complete() method.
onComplete(Action<? super Execution>) - Method in interface ratpack.exec.ExecBuilder: Specifies the completion callback for the execution.
oneCookie(String) - Method in interface ratpack.http.Request: Returns the value of the cookie with the specified name if it was sent.
onError(Action<? super Throwable>) - Method in interface ratpack.config.ConfigDataSpec: Sets the error handler that will be used for added configuration sources.
onError(Action<? super Throwable>) - Method in interface ratpack.exec.Downstream: Wrap this downstream, using the given action as the implementation of the Downstream.error(Throwable) method.
onError(Action<? super Throwable>) - Method in interface ratpack.exec.ExecBuilder: Specify the top level error handler for the execution.
onError(BiAction<? super Execution, ? super Throwable>) - Method in interface ratpack.exec.ExecBuilder: Specify the top level error handler for the execution.
onError(Action<? super Throwable>) - Method in interface ratpack.exec.Operation
onError(Action<? super Throwable>) - Method in interface ratpack.exec.Promise: Specifies the action to take if the an error occurs trying to produce the promised value.
onError(Action<? super Throwable>) - Method in interface ratpack.server.ServerConfig.Builder: Sets the error handler that will be used for added configuration sources.
onMessage(WebSocketMessage<T>) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onMessage(WebSocketMessage<T>) - Method in interface ratpack.websocket.WebSocketHandler
onMessage(Action<WebSocketMessage<T>>) - Method in interface ratpack.websocket.WebSocketSpec
onNull(Block) - Method in interface ratpack.exec.Promise: A convenience shorthand for routing null values.
onOpen(WebSocket) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onOpen(WebSocket) - Method in interface ratpack.websocket.WebSocketHandler
onStart(StartEvent) - Method in interface ratpack.server.Service: Server startup event.
onStop(StopEvent) - Method in interface ratpack.server.Service: Server stop event.
onSuccess(Action<? super O>) - Method in interface ratpack.exec.Downstream: Wrap this downstream, using the given action as the implementation of the Downstream.success(T) method.
onYield(Runnable) - Method in interface ratpack.exec.Promise: Registers a listener that is invoked when this promise is initiated.
operation(Block) - Method in interface ratpack.exec.ExecControl
Operation - Interface in ratpack.exec: A logical operation.
operation() - Method in interface ratpack.exec.Promise
operation(Action<? super T>) - Method in interface ratpack.exec.Promise
optionalToken(String) - Method in interface ratpack.path.PathBinderBuilder: Add an optional token to the path.
optionalTokenWithPattern(String, String) - Method in interface ratpack.path.PathBinderBuilder: Add a regular expression parameterized named optional token to the path.
OverlappingExecutionException - Exception in ratpack.exec: An instance of this exception will be logged when execution overlaps.
OverlappingExecutionException(String) - Constructor for exception ratpack.exec.OverlappingExecutionException: Constructor.
OverlappingExecutionException(String, Throwable) - Constructor for exception ratpack.exec.OverlappingExecutionException: Constructor.

P

Pair<L,R> - Class in ratpack.func: A generic pair implementation that can be used to cumulatively aggregate a data structure during a promise pipeline.
pair(L, R) - Static method in class ratpack.func.Pair: Creates a new pair.
params(String...) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
params(Action<? super ImmutableMultimap.Builder<String, Object>>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
params(Map<String, ?>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
params(Multimap<String, ?>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
parse(Class<T>) - Method in interface ratpack.handling.Context: Parse the request into the given type, using no options (or more specifically an instance of NullParseOpts as the options).
parse(TypeToken<T>) - Method in interface ratpack.handling.Context: Parse the request into the given type, using no options (or more specifically an instance of NullParseOpts as the options).
parse(Class<T>, O) - Method in interface ratpack.handling.Context: Constructs a Parse from the given args and delegates to Context.parse(Parse).
parse(TypeToken<T>, O) - Method in interface ratpack.handling.Context: Constructs a Parse from the given args and delegates to Context.parse(Parse).
parse(Parse<T, O>) - Method in interface ratpack.handling.Context: Parses the request body into an object.
parse(Context, TypedData, Parse<T, NullParseOpts>) - Method in class ratpack.parse.NoOptParserSupport: Delegates to NoOptParserSupport.parse(ratpack.handling.Context, ratpack.http.TypedData, TypeToken), discarding the opts object of the given parse.
parse(Context, TypedData, TypeToken<T>) - Method in class ratpack.parse.NoOptParserSupport: The parser implementation.
Parse<T,O> - Class in ratpack.parse: The specification of a particular parse.
parse(Context, TypedData, Parse<T, O>) - Method in interface ratpack.parse.Parser: Deserializes the request body of the context into an object.
parse(String, boolean) - Static method in class ratpack.path.PathBinders
ParseException - Exception in ratpack.parse: A generic super type for exceptions indicate something when wrong for a parse operation.
ParseException(String) - Constructor for exception ratpack.parse.ParseException: Constructor.
ParseException(String, Throwable) - Constructor for exception ratpack.parse.ParseException: Constructor.
Parser<O> - Interface in ratpack.parse: A parser converts a request body into an object.
ParserException - Exception in ratpack.parse: Wraps an exception thrown by a parser while parsing.
ParserException(Parser<?>, Throwable) - Constructor for exception ratpack.parse.ParserException: Constructor.
ParserSupport<O> - Class in ratpack.parse: A convenience superclass for Parser implementations.
ParserSupport(String) - Constructor for class ratpack.parse.ParserSupport: Constructor.
patch(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of PATCH.
patch(Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of PATCH.
patch(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is PATCH.
patch(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
patch(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is PATCH and the path is at the current root.
patch(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
patch() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is PATCH, otherwise raises a 405 client error.
path(String, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handlers if the request matches the given path exactly.
path(PathBinder, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handlers if the request can be bound by the given path binder.
path(String) - Method in interface ratpack.http.HttpUrlBuilder: Appends some path to the URL.
path(String) - Method in interface ratpack.websocket.WebSocketSpec
PathBinder - Interface in ratpack.path: A path binder binds to a request path, extracting information from it.
PathBinderBuilder - Interface in ratpack.path: A builder to generate a PathBinder from a list of tokens and literals.
PathBinders - Class in ratpack.path
PathBinding - Interface in ratpack.path: A path binding represents some kind of "match" on the path of a request.
PathTokens - Interface in ratpack.path: A marker interface for the contextual object that represents the tokens extracted from the request path.
periodically(ScheduledExecutorService, Duration, Function<Integer, T>) - Static method in class ratpack.stream.Streams: Executes the given function periodically, publishing the return value to the subscriber.
periodically(Registry, Duration, Function<Integer, T>) - Static method in class ratpack.stream.Streams
PLAIN_TEXT_UTF8 - Static variable in interface ratpack.http.MediaType: "text/plain;charset=utf-8".
plainText(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/plain".
plainText(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/plain".
port(int) - Method in interface ratpack.http.HttpUrlBuilder: Sets the port to the given value.
port(int) - Method in interface ratpack.server.ServerConfig.Builder: Sets the port to listen for requests on.
post(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of POST.
post(Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of POST.
post(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is POST.
post(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
post(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is POST and the path is at the current root.
post(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
post() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is POST, otherwise raises a 405 client error.
post(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient: An asynchronous method to do a POST HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a POST.
Predicate<T> - Interface in ratpack.func: A function that returns true or false for a value.
prefix(String, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handlers if the relative path starts with the given prefix.
prefix(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
prefix(String, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handlers if the request path starts with the given prefix.
prepend(Handler) - Static method in interface ratpack.handling.HandlerDecorator: A factory for decorator impls that effectively inserts the given handler before the “rest” of the handlers.
promise(Action<? super Fulfiller<T>>) - Method in interface ratpack.exec.ExecControl: Creates a promise for an asynchronously created value.
promise() - Method in interface ratpack.exec.Operation
Promise<T> - Interface in ratpack.exec: A promise for a single value.
promise(Action<? super Fulfiller<T>>) - Method in interface ratpack.handling.Context: Creates a promise of a value that will made available asynchronously.
promiseFrom(Factory<? extends T>) - Method in interface ratpack.exec.ExecControl
promiseOf(T) - Method in interface ratpack.exec.ExecControl: Creates a promise for the given value.
promiseOf(Class<T>) - Static method in class ratpack.util.Types: Creates a type token for a promise of of the given type.
promiseOf(TypeToken<T>) - Static method in class ratpack.util.Types: Creates a type token for a promise of of the given type.
props(ByteSource) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a properties file.
props(Path) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a properties file.
props(Properties) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a properties object.
props(Map<String, String>) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a Map (flat key-value pairs).
props(String) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a properties file.
props(URL) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a properties file.
props(ByteSource) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a properties file.
props(String) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a properties file.
props(Path) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a properties file.
props(Properties) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a properties object.
props(Map<String, String>) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a Map (flat key-value pairs).
props(URL) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a properties file.
provide(TypeToken<T>) - Method in interface ratpack.registry.RegistryBacking: Provides instances to the Registry implementation which uses this method for looking up an iterable result of Supplier instances for the given type.
PublicAddress - Interface in ratpack.server: The advertised public address.
publicAddress(URI) - Method in interface ratpack.server.ServerConfig.Builder: The public address of the application.
publish(Iterable<T>) - Static method in class ratpack.stream.Streams: Converts an iterable to a publishable.
publisher(ByteBufAllocator) - Method in class ratpack.http.ResponseChunks: Returns the chunk publisher.
pushLeft(T) - Method in class ratpack.func.Pair: Creates a new pair, with this as the right item and the given value as the left.
pushRight(T) - Method in class ratpack.func.Pair: Creates a new pair, with this as the left item and the given value as the right.
put(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of PUT.
put(Handler) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of PUT.
put(String, Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is PUT.
put(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
put(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is PUT and the path is at the current root.
put(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
put() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is PUT, otherwise raises a 405 client error.
put(K, V) - Method in interface ratpack.util.MultiValueMap: Throws UnsupportedOperationException.
putAll(Map<? extends K, ? extends V>) - Method in interface ratpack.util.MultiValueMap: Throws UnsupportedOperationException.

R

ratpack.api - package ratpack.api: Annotations that are used to further specify API contracts.
ratpack.config - package ratpack.config: Provides the ability to access configuration data from a variety of sources, such as YAML, JSON, properties files, system properties, and environment variables.
ratpack.error - package ratpack.error: Types that deal with handling application errors.
ratpack.exec - package ratpack.exec: The execution management.
ratpack.file - package ratpack.file: Types for dealing with the file system and serving files.
ratpack.file.checksummer - package ratpack.file.checksummer
ratpack.form - package ratpack.form: Support for handling uploaded forms, including file uploads.
ratpack.func - package ratpack.func: General functional (i.e. Single Abstract Method) types.
ratpack.handling - package ratpack.handling: The handling of application requests.
ratpack.handling.direct - package ratpack.handling.direct: Low level direct access to the underlying Netty internals.
ratpack.health - package ratpack.health: Health checks report on the status of key components in the system and are generally used for monitoring and reporting.
ratpack.http - package ratpack.http: The HTTP protocol.
ratpack.http.client - package ratpack.http.client: The HTTP client.
ratpack.launch - package ratpack.launch: Classes used to bootstrap a Ratpack application.
ratpack.logging - package ratpack.logging
ratpack.parse - package ratpack.parse: Parsing in Ratpack refers to deserializing a request body into a Java object of some type.
ratpack.path - package ratpack.path: Types for managing the paths of requests inside the application.
ratpack.registry - package ratpack.registry: Registries hold objects that can be retrieved via type, and are a key aspect of Ratpack applications.
ratpack.render - package ratpack.render: The renderer framework provides a pluggable mechanism for serializing objects to the response.
ratpack.server - package ratpack.server: Objects used to start a ratpack application.
ratpack.sse - package ratpack.sse: Support for Server Sent Events.
ratpack.ssl - package ratpack.ssl: Convenience utitilities for dealing with SSL.
ratpack.stream - package ratpack.stream: Support for reactive streams.
ratpack.util - package ratpack.util: General purpose types and utilities.
ratpack.websocket - package ratpack.websocket: Support for Websockets.
RatpackServer - Interface in ratpack.server: The entry point for creating and starting a Ratpack application.
RatpackServerSpec - Interface in ratpack.server: A buildable specification of a Ratpack server.
RatpackVersion - Class in ratpack.util: Provides the version of the Ratpack core at runtime.
readTimeout(Duration) - Method in interface ratpack.http.client.RequestSpec
readTimeoutSeconds(int) - Method in interface ratpack.http.client.RequestSpec
ReceivedResponse - Interface in ratpack.http.client
redirect(int, String) - Method in interface ratpack.handling.Chain: Sends an HTTP redirect to the specified location.
redirect(String) - Method in interface ratpack.handling.Context: Sends a temporary redirect response (i.e.
redirect(int, String) - Method in interface ratpack.handling.Context: Sends a redirect response location URL and status code (which should be in the 3xx range).
redirect(int, String) - Static method in class ratpack.handling.Handlers: Creates a handler that always issues a redirect using Context.redirect(int, String) with exactly the given code and location.
redirect(Context, String, int) - Method in interface ratpack.handling.Redirector: Issue a redirect to the client.
Redirector - Interface in ratpack.handling: Contextual strategy for issuing redirects.
redirects(int) - Method in interface ratpack.http.client.RequestSpec
register(Action<? super RegistrySpec>) - Method in interface ratpack.exec.ExecBuilder: Populates the execution's registry.
register(Registry) - Method in interface ratpack.handling.Chain: Makes the contents of the given registry available for downstream handlers of the same nesting level.
register(Action<? super RegistrySpec>) - Method in interface ratpack.handling.Chain: Builds a new registry via the given action, then registers it via Chain.register(Registry).
register(Registry, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Adds a handler that inserts the given handler chain with the given registry via Context.insert(ratpack.registry.Registry, Handler...).
register(Registry, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
register(Action<? super RegistrySpec>, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Adds a handler that inserts the given handler chain with a registry built by the given action via Context.insert(ratpack.registry.Registry, Handler...).
register(Action<? super RegistrySpec>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
register(Registry, Handler) - Static method in class ratpack.handling.Handlers: A handler that simply calls Context.insert(Registry, Handler...) with the given registry and handler.
register(Registry) - Static method in class ratpack.handling.Handlers: A handler that simply calls Context.next(Registry) with the given registry.
register() - Method in interface ratpack.render.RenderableDecorator: A registration action, typically used with RegistrySpec.with(Action).
register() - Method in interface ratpack.render.Renderer: An action that registers this renderer with a registry.
Registries - Class in ratpack.registry: Static methods for creating and building registries.
registry() - Static method in class ratpack.registry.Registries: Creates a new registry builder.
registry(Action<? super RegistrySpec>) - Static method in class ratpack.registry.Registries: Builds a registry from the given action.
Registry - Interface in ratpack.registry: An object registry.
registry(Registry) - Method in interface ratpack.server.RatpackServerSpec: Sets the user registry to exactly the given registry.
registry(Function<? super Registry, ? extends Registry>) - Method in interface ratpack.server.RatpackServerSpec: Sets the user registry as the return value of the given function.
RegistryBacking - Interface in ratpack.registry: Provides instances to the Registry implementation which uses an implementation of this interface for backing the instances that the Registry contains or returns.
RegistryBuilder - Interface in ratpack.registry: A builder of registries.
registryOf(Action<? super RegistrySpec>) - Method in interface ratpack.server.RatpackServerSpec: Builds the user registry via the given spec action.
RegistrySpec - Interface in ratpack.registry: An additive specification of a registry.
reload() - Method in interface ratpack.server.RatpackServer: Reloads the server from its definition function.
ReloadInformant - Interface in ratpack.server: Informs when the server should be reloaded, during development.
remove(CharSequence) - Method in interface ratpack.http.MutableHeaders: Removes the header with the specified name.
remove(Class<T>) - Method in interface ratpack.registry.MutableRegistry: Remove the registration for the given type.
remove(TypeToken<T>) - Method in interface ratpack.registry.MutableRegistry: Remove the registration for the given type.
remove(Object) - Method in interface ratpack.util.MultiValueMap: Throws UnsupportedOperationException.
render(Object) - Method in interface ratpack.handling.Context: Render the given object, using the rendering framework.
render(Context) - Method in class ratpack.http.ResponseChunks: Render this object to the response.
render(Context) - Method in interface ratpack.render.Renderable: Render this object to the response.
render(Context, T) - Method in interface ratpack.render.Renderer: Render the given object to the response.
render(Context, T) - Method in class ratpack.render.RendererSupport: Render the given object to the response.
render(Context) - Method in class ratpack.sse.ServerSentEvents: Render this object to the response.
Renderable - Interface in ratpack.render: A renderable object, that can be given to Context.render(Object).
RenderableDecorator<T> - Interface in ratpack.render: Decorates an object before it is rendered.
RenderableDecoratorSupport<T> - Class in ratpack.render: A convenience base class for RenderableDecorator implementations.
RenderableDecoratorSupport() - Constructor for class ratpack.render.RenderableDecoratorSupport
Renderer<T> - Interface in ratpack.render: A renderer is responsible for rendering an object to the response.
RendererException - Exception in ratpack.render: Wraps an exception thrown by a renderer while rendering.
RendererException(Renderer<?>, Object, Throwable) - Constructor for exception ratpack.render.RendererException: Constructor.
RendererSupport<T> - Class in ratpack.render: A Renderer super class that provides a RendererSupport.getType() implementation based on the generic type of the impl.
RendererSupport() - Constructor for class ratpack.render.RendererSupport
RenderException - Exception in ratpack.render: A generic super type for exceptions indicate something when wrong for a render operation.
RenderException(String) - Constructor for exception ratpack.render.RenderException: Constructor.
RenderException(String, Throwable) - Constructor for exception ratpack.render.RenderException: Constructor.
request(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient: An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec.
Request - Interface in ratpack.http: A request to be handled.
request(URI, Action<? super RequestSpec>) - Method in interface ratpack.sse.ServerSentEventStreamClient
request(URI) - Method in interface ratpack.sse.ServerSentEventStreamClient
RequestId - Interface in ratpack.handling: An opaque identifier for the request.
RequestId.Generator - Interface in ratpack.handling: Generates a unique request ID.
RequestOutcome - Interface in ratpack.handling: The outcome of processing a request.
RequestSpec - Interface in ratpack.http.client
RequestSpec.Body - Interface in ratpack.http.client: The request body.
requestStream(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient: An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, the received response content will be streamed.
require() - Static method in interface ratpack.exec.ExecController: Returns the execution controller bound to the current thread, or throws an exception if called on a non Ratpack managed compute thread.
require(String, Class<?>) - Method in interface ratpack.server.ServerConfig.Builder: Declares that it is required that the server config provide an object of the given type at the given path.
Response - Interface in ratpack.http: A response to a request.
ResponseChunks - Class in ratpack.http: A renderable object for streaming data with HTTP chunked transfer-encoding.
ResponseMetaData - Interface in ratpack.http: The metadata associated with a response.
ResponseTimer - Class in ratpack.handling: A handler, that adds a "X-Response-Time" header to all requests indicating how long it took to start sending a response in milliseconds.
ResponseTimer() - Constructor for class ratpack.handling.ResponseTimer
result(Action<? super Result<T>>) - Method in interface ratpack.exec.Promise: Consume the promised value as a Result.
Result<T> - Interface in ratpack.exec: The result of an asynchronous operation, which may be an error.
right(Promise<O>) - Method in interface ratpack.exec.Promise
right - Variable in class ratpack.func.Pair: The right item of the pair.
right() - Method in class ratpack.func.Pair: The right item of the pair.
right(T) - Method in class ratpack.func.Pair: Replaces the right item with the given item.
route(Predicate<? super T>, Action<? super T>) - Method in interface ratpack.exec.Promise: Allows the promised value to be handled specially if it meets the given predicate, instead of being handled by the promise subscriber.

S

secure() - Method in interface ratpack.http.HttpUrlBuilder: Sets the protocol to be HTTPS.
segment(String, Object...) - Method in interface ratpack.http.HttpUrlBuilder: Appends one path segment to the URL.
send(Response) - Method in interface ratpack.http.client.ReceivedResponse
send(Response) - Method in interface ratpack.http.client.StreamedResponse: Stream this received response out to the given server response.
send(Response, Action<? super MutableHeaders>) - Method in interface ratpack.http.client.StreamedResponse: Stream this received response out to the given server response.
send() - Method in interface ratpack.http.Response: Sends the response back to the client, with no body.
send(String) - Method in interface ratpack.http.Response: Sends the response, using "text/plain" as the content type and the given string as the response body.
send(CharSequence, String) - Method in interface ratpack.http.Response: Sends the response, using the given content type and string as the response body.
send(byte[]) - Method in interface ratpack.http.Response: Sends the response, using "application/octet-stream" as the content type (if a content type hasn't already been set) and the given byte array as the response body.
send(CharSequence, byte[]) - Method in interface ratpack.http.Response: Sends the response, using the given content type and byte array as the response body.
send(ByteBuf) - Method in interface ratpack.http.Response: Sends the response, using "application/octet-stream" as the content type (if a content type hasn't already been set) and the given bytes as the response body.
send(CharSequence, ByteBuf) - Method in interface ratpack.http.Response: Sends the response, using the given content type and bytes as the response body.
send(String) - Method in interface ratpack.websocket.WebSocket
send(ByteBuf) - Method in interface ratpack.websocket.WebSocket
sendFile(Path) - Method in interface ratpack.http.Response: Sends the response, using the file as the response body.
sendStream(Publisher<? extends ByteBuf>) - Method in interface ratpack.http.Response: Sends the response, streaming the bytes emitted by the given publisher.
SentResponse - Interface in ratpack.http: Represents a response that has been committed.
serverConfig(ServerConfig.Builder) - Method in interface ratpack.server.RatpackServerSpec: Convenience function that builds the config from the given builder and delegates to RatpackServerSpec.serverConfig(ServerConfig).
serverConfig(ServerConfig) - Method in interface ratpack.server.RatpackServerSpec: Sets the server configuration for the application.
ServerConfig - Interface in ratpack.server: The configuration of the server.
ServerConfig.Builder - Interface in ratpack.server
ServerErrorHandler - Interface in ratpack.error: An object that can deal with errors that occur during the processing of an exchange.
ServerSentEvents - Class in ratpack.sse: A renderable object for streaming server side events.
serverSentEvents(Publisher<T>, Action<? super Event<T>>) - Static method in class ratpack.sse.ServerSentEvents: Creates a new renderable object wrapping the event stream.
ServerSentEventStreamClient - Interface in ratpack.sse
service(ServerConfig) - Static method in class ratpack.file.FileSystemChecksumServices: Get checksum service that is backward compatible - calculates file checksum with Adler32 method.
service(ServerConfig, Function<? super InputStream, ? extends String>) - Static method in class ratpack.file.FileSystemChecksumServices: Get checksum service with calculation method given as checksummer function.
service(ServerConfig, Function<? super InputStream, ? extends String>, String, String...) - Static method in class ratpack.file.FileSystemChecksumServices: Get checksum service for additional path related to server's base dir and calculation method as checksummer function.
Service - Interface in ratpack.server: A service participates in the application lifecycle.
set(CharSequence, Object) - Method in interface ratpack.http.MutableHeaders: Sets the (only) value for the header with the specified name.
set(CharSequence, Iterable<?>) - Method in interface ratpack.http.MutableHeaders: Sets a new header with the specified name and values.
setDate(CharSequence, Date) - Method in interface ratpack.http.MutableHeaders: Set a header with the given date as the value.
shouldReload(Registry) - Method in interface ratpack.server.ReloadInformant: Whether the server should reload.
size() - Method in interface ratpack.registry.RegistryBuilder: How many entries have been added so far.
sseStreamClient(ExecController, ByteBufAllocator) - Static method in interface ratpack.sse.ServerSentEventStreamClient
ssl(SSLContext) - Method in interface ratpack.server.ServerConfig.Builder: The SSL context to use if the application serves content over HTTPS.
sslContext(URL, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(File, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(Path, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(InputStream, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
SSLContexts - Class in ratpack.ssl: Factory methods for initializing an SSLContext.
start(Action<? super Execution>) - Method in interface ratpack.exec.ExecBuilder: Initiate the new execution.
start(Action<? super RatpackServerSpec>) - Static method in interface ratpack.server.RatpackServer: Convenience method to define and RatpackServer.start() the server in one go.
start() - Method in interface ratpack.server.RatpackServer: Starts the server, returning as soon as the server is up and ready to receive requests.
StartEvent - Interface in ratpack.server: A start event.
StartupFailureException - Exception in ratpack.server: Thrown when a server fails to start.
StartupFailureException(String) - Constructor for exception ratpack.server.StartupFailureException: Constructor.
StartupFailureException(String, Throwable) - Constructor for exception ratpack.server.StartupFailureException: Constructor.
status(int) - Method in interface ratpack.http.Response
status(Status) - Method in interface ratpack.http.Response
status(int) - Method in interface ratpack.http.ResponseMetaData: Sets the status line of the response.
status(Status) - Method in interface ratpack.http.ResponseMetaData: Sets the status line of the response.
Status - Interface in ratpack.http: A status line of a HTTP response.
stop() - Method in interface ratpack.server.RatpackServer: Stops the server, returning as soon as the server has stopped receiving requests.
stop() - Method in interface ratpack.server.Stopper: Initiates the shutdown process for the running application.
StopEvent - Interface in ratpack.server: A stop event.
Stopper - Interface in ratpack.server: The mechanism for stopping the application from within the application.
stream(Publisher<T>) - Method in interface ratpack.exec.ExecControl: Process streams of data asynchronously with non-blocking back pressure.
stream(Publisher<T>) - Method in interface ratpack.handling.Context
stream(Action<? super OutputStream>) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body by writing to an output stream.
StreamedResponse - Interface in ratpack.http.client: A received response to a http client request with streamed response content.
StreamEvent<T> - Interface in ratpack.stream: Represents an event emitted by a publisher.
streamMap(Publisher<I>, Function<? super WriteStream<O>, ? extends WriteStream<I>>) - Static method in class ratpack.stream.Streams: Allows transforming a stream into an entirely different stream.
streamMap(Function<? super WriteStream<O>, ? extends WriteStream<T>>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.streamMap(org.reactivestreams.Publisher, ratpack.func.Function).
Streams - Class in ratpack.stream: Some lightweight utilities for working with reactive streams.
Streams() - Constructor for class ratpack.stream.Streams
stringChunks(Publisher<? extends CharSequence>) - Static method in class ratpack.http.ResponseChunks: Transmit each string emitted by the publisher as a chunk.
stringChunks(CharSequence, Publisher<? extends CharSequence>) - Static method in class ratpack.http.ResponseChunks: Transmit each string emitted by the publisher as a chunk.
stringChunks(CharSequence, Charset, Publisher<? extends CharSequence>) - Static method in class ratpack.http.ResponseChunks: Transmit each string emitted by the publisher as a chunk.
success(T) - Method in interface ratpack.exec.Downstream: Signals the successful production of the upstream value.
success(T) - Method in interface ratpack.exec.Fulfiller: Fulfills the promise with the given value.
success(T) - Static method in interface ratpack.exec.Result: Creates a new successful result.
sysProps() - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for system properties starting with the prefix "ratpack.".
sysProps(String) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for system properties starting with the specified prefix.
sysProps() - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for system properties starting with the prefix "ratpack.".
sysProps(String) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for system properties starting with the specified prefix.

T

takeOwnership(Action<Object>) - Method in interface ratpack.handling.direct.DirectChannelAccess: Signals that Ratpack should no longer manage this channel.
text(CharSequence) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body as a UTF-8 char sequence.
text(CharSequence, Charset) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body as a char sequence of the given charset.
TEXT_HTML - Static variable in interface ratpack.http.MediaType: "text/html".
then(Block) - Method in interface ratpack.exec.Operation
then() - Method in interface ratpack.exec.Operation
then(Action<? super T>) - Method in interface ratpack.exec.Promise: Specifies what should be done with the promised object when it becomes available.
threads(int) - Method in interface ratpack.server.ServerConfig.Builder: The number of threads to use.
Throttle - Interface in ratpack.exec: Limits the concurrency of operations, typically access to an external resource.
throttle(Promise<T>) - Method in interface ratpack.exec.Throttle: Throttles the given promise.
throttled(Throttle) - Method in interface ratpack.exec.Promise: Throttles this promise, using the given throttle.
throwException() - Static method in interface ratpack.func.Action: Returns an action that receives a throwable and immediately throws it.
throwException(Throwable) - Static method in interface ratpack.func.Action: Returns an action that immediately throws the given exception.
throwException(Throwable) - Static method in interface ratpack.func.Block: Returns an action that immediately throws the given exception.
throwIfError(Throwable) - Static method in class ratpack.util.Exceptions: Throws the given throwable if it is an Error, otherwise does nothing.
to(Function<? super Promise<T>, ? extends O>) - Method in interface ratpack.exec.Promise: Applies the given function to this and returns the result.
toBiConsumer() - Method in interface ratpack.func.BiAction: Creates a JDK BiConsumer from this action.
toConsumer() - Method in interface ratpack.func.Action: Creates a JDK Consumer from this action.
toException(Throwable) - Static method in class ratpack.util.Exceptions: Converts the given throwable to an Exception if necessary.
toFunction() - Method in interface ratpack.func.Function: Converts this function into the equivalent JDK type.
toGuavaFunction() - Method in interface ratpack.func.Function: Converts this function into the equivalent Guava type.
toGuavaPredicate() - Method in interface ratpack.func.Predicate: Creates a Guava Predicate from this predicate.
token(String) - Method in interface ratpack.path.PathBinderBuilder: Add a token to the path.
tokenize(String) - Method in interface ratpack.config.EnvironmentParser: Splits the name of an environment variable into per-object segments.
tokenWithPattern(String, String) - Method in interface ratpack.path.PathBinderBuilder: Add a regular expression parameterized named token to the path.
toList(Publisher<T>) - Static method in class ratpack.stream.Streams: Delegates to Streams.toList(ExecControl, Publisher), using ExecControl.current() as the exec control.
toList(ExecControl, Publisher<T>) - Static method in class ratpack.stream.Streams: Creates a promise for the given publisher's items as a List.
toList() - Method in interface ratpack.stream.TransformablePublisher: Consumes the given publisher's items to a list.
toList(ExecControl) - Method in interface ratpack.stream.TransformablePublisher: See TransformablePublisher.toList().
toPredicate() - Method in interface ratpack.func.Predicate: Creates a JDK Predicate from this predicate.
toPromise(Publisher<T>) - Static method in class ratpack.stream.Streams: Calls Streams.toPromise(ExecControl, Publisher) with ExecControl.current() and the given publisher.
toPromise(ExecControl, Publisher<T>) - Static method in class ratpack.stream.Streams: Creates a promise for the given publisher's single item.
toPromise() - Method in interface ratpack.stream.TransformablePublisher: See Streams.toPromise(Publisher).
toPromise(ExecControl) - Method in interface ratpack.stream.TransformablePublisher: See Streams.toPromise(ExecControl, Publisher).
toRunnable() - Method in interface ratpack.func.Block: Converts this action to a runnable.
toString() - Method in class ratpack.func.Pair: Returns "Pair[«left.toString()»,«right.toString()»]
toString() - Method in class ratpack.parse.NullParseOpts
toString() - Method in interface ratpack.server.ReloadInformant: The description of this reload informant.
transform(Function<? super Upstream<? extends T>, ? extends Upstream<O>>) - Method in interface ratpack.exec.Promise: Apply a custom transform to this promise.
transform(Function<? super TransformablePublisher<T>, ? extends Publisher<O>>) - Method in interface ratpack.stream.TransformablePublisher: Convenience method to allow a non Ratpack publisher transform method to be hooked in.
transformable(Publisher<T>) - Static method in class ratpack.stream.Streams: Wraps the publisher in Ratpack's TransformablePublisher to make composing a pipeline easier.
TransformablePublisher<T> - Interface in ratpack.stream: A wrapper over a Publisher that makes it more convenient to chain transformations of different kinds.
type(String, Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of the given MIME type.
type(String, Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of the given MIME type.
type(String) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the "Content-Type" of the request.
TypeCoercingMap<K> - Interface in ratpack.util: A string valued map that can do simple type conversions from the string values to primitive types.
typeCompatibleOf(T) - Static method in interface ratpack.render.Renderer: Creates a type token for a compatible renderer of the given type of object.
TypedData - Interface in ratpack.http: Data that potentially has a content type.
typeOf(Class<T>) - Static method in interface ratpack.render.RenderableDecorator: Creates a type token for a decorator of objects of the given type.
typeOf(Class<T>) - Static method in interface ratpack.render.Renderer: Creates a type token for a renderer of the given type of object.
Types - Class in ratpack.util: Static utility methods for dealing with types.

U

uncheck(Throwable) - Static method in class ratpack.util.Exceptions: Converts the given throwable to a RuntimeException if necessary.
uncheck(Factory<T>) - Static method in class ratpack.util.Exceptions: Executes the given factory, returning its result and unchecking any exceptions it throws.
uncheck(Block) - Static method in class ratpack.util.Exceptions
uncheck(T, Action<T>) - Static method in class ratpack.util.Exceptions: Executes the given action with the provided input argument, unchecking any exceptions it throws.
uncheck(T, U, BiAction<T, U>) - Static method in class ratpack.util.Exceptions: Executes the given action with the provided input arguments, unchecking any exceptions it throws.
UncheckedException - Exception in ratpack.api: Used to wrap a checked exception to be thrown where a checked exception cannot be thrown.
UncheckedException(Throwable) - Constructor for exception ratpack.api.UncheckedException: Constructor.
uncheckedWith(T, Action<? super T>) - Static method in interface ratpack.func.Action: Like Action.with(Object, Action), but unchecks any exceptions thrown by the action via Exceptions.uncheck(Throwable).
uncheckedWith(O) - Method in interface ratpack.func.Action: Like Action.with(Object), but unchecks any exceptions thrown by the action via Exceptions.uncheck(Throwable).
unhealthy(String) - Static method in class ratpack.health.HealthCheck.Result: Creates an unhealthy result, with the given message.
unhealthy(String, Object...) - Static method in class ratpack.health.HealthCheck.Result: Creates an unhealthy result, with the given message.
unhealthy(Throwable) - Static method in class ratpack.health.HealthCheck.Result: Creates an unhealthy result, with the given exception.
unlimited() - Static method in interface ratpack.exec.Throttle: Create a new throttle that does not limit concurrency.
UnmanagedThreadException - Exception in ratpack.exec: Thrown when something is attempted outside of a Ratpack execution, that can only succeed during a Ratpack execution.
UnmanagedThreadException() - Constructor for exception ratpack.exec.UnmanagedThreadException: Constructor.
unpackLeft() - Static method in class ratpack.func.Pair: Convenience function for returning the left item of a pair.
unpackRight() - Static method in class ratpack.func.Pair: Convenience function for returning the right item of a pair.
UploadedFile - Interface in ratpack.form: A file that was uploaded via a form.
Upstream<T> - Interface in ratpack.exec: An upstream asynchronous data source.

V

valueOf(String) - Static method in enum ratpack.exec.ExecInterceptor.ExecType: Returns the enum constant of this type with the specified name.
values() - Static method in enum ratpack.exec.ExecInterceptor.ExecType: Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocket - Interface in ratpack.websocket
websocket(Context, Function<WebSocket, T>) - Static method in class ratpack.websocket.WebSockets
websocket(Context, WebSocketHandler<?>) - Static method in class ratpack.websocket.WebSockets
websocketBroadcast(Context, Publisher<String>) - Static method in class ratpack.websocket.WebSockets: Sets up a websocket that sends the published Strings to a client.
websocketByteBufBroadcast(Context, Publisher<ByteBuf>) - Static method in class ratpack.websocket.WebSockets: Sets up a websocket that sends the published byte buffers to a client.
WebSocketClose<T> - Interface in ratpack.websocket
WebSocketConnector<T> - Interface in ratpack.websocket
WebSocketHandler<T> - Interface in ratpack.websocket
WebSocketMessage<T> - Interface in ratpack.websocket
WebSockets - Class in ratpack.websocket: WebSockets support for Ratpack.
WebSockets() - Constructor for class ratpack.websocket.WebSockets
WebSocketSpec<T> - Interface in ratpack.websocket
wiretap(Action<? super Result<T>>) - Method in interface ratpack.exec.Promise: Registers a listener for the promise outcome.
wiretap(Publisher<T>, Action<? super StreamEvent<? super T>>) - Static method in class ratpack.stream.Streams: Allows listening to the events of the given publisher as they flow to subscribers.
wiretap(Action<? super StreamEvent<? super T>>) - Method in interface ratpack.stream.TransformablePublisher: See Streams.wiretap(Publisher, Action).
with(T, Action<? super T>) - Static method in interface ratpack.func.Action: Executes the action with the given argument, then returns the argument.
with(O) - Method in interface ratpack.func.Action: Executes with the given argument, then returns the argument.
with(Action<? super RegistrySpec>) - Method in interface ratpack.registry.RegistryBuilder
with(Action<? super RegistrySpec>) - Method in interface ratpack.registry.RegistrySpec: Executes the given action with this.
wrap(Factory<? extends Promise<T>>) - Method in interface ratpack.exec.ExecControl: Executes the given promise producing factory, converting any thrown exception into a failed promise.
WriteStream<T> - Interface in ratpack.stream: The write end of a data stream.
writeTo(OutputStream) - Method in interface ratpack.http.TypedData: Writes the data to the given output stream.

X

xml(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "application/xml".
xml(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "application/xml".

Y

yaml(ByteSource) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a YAML file.
yaml(Path) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a YAML file.
yaml(String) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a YAML file.
yaml(URL) - Method in interface ratpack.config.ConfigDataSpec: Adds a configuration source for a YAML file.
yaml(ByteSource) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a YAML file.
yaml(Path) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a YAML file.
yaml(String) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a YAML file.
yaml(URL) - Method in interface ratpack.server.ServerConfig.Builder: Adds a configuration source for a YAML file.
yield(Function<? super YieldRequest, T>) - Static method in class ratpack.stream.Streams: Creates a new publisher, backed by the given data producing function.
YieldRequest - Interface in ratpack.stream

A B C D E F G H I J L M N O P R S T U V W X Y