Index (ratpack-core 1.9.0-rc-1 API)

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

A

ACCEPTED - Static variable in interface ratpack.http.Status: The 202 status code.
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.
add(TypeToken<O>, O) - Method in interface ratpack.http.Request
add(CharSequence, Object) - Method in interface ratpack.http.MutableHeaders: Adds a new header with the specified name and value.
add(Class<O>, O) - Method in interface ratpack.http.Request
add(Object) - Method in interface ratpack.http.Request
add(ConfigSource) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source.
add(ConfigSource) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source.
add(Imposition) - Method in interface ratpack.impose.ImpositionsSpec: Adds the imposition, replacing any previous imposition of the exact same type.
addLazy(TypeToken<O>, Supplier<? extends O>) - Method in interface ratpack.http.Request
addLazy(Class<O>, Supplier<? extends O>) - Method in interface ratpack.http.Request
address(InetAddress) - Method in interface ratpack.server.ServerConfigBuilder: Sets the address to bind to.
addressResolver(AddressResolverGroup<?>) - Method in interface ratpack.http.client.HttpClientSpec: Specifies a custom name resolver to use.
addressResolver(Action<? super DnsNameResolverBuilder>) - Method in interface ratpack.http.client.HttpClientSpec: Specifies a custom name resolver to use.
all(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
all(Handler) - Method in interface ratpack.handling.Chain: Adds the given handler to this.
alloc() - Method in class ratpack.bytebuf.ByteBufRef
ALREADY_REPORTED - Static variable in interface ratpack.http.Status: The 208 status code.
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(ServerConfigBuilder) - Method in class ratpack.impose.ServerConfigImposition: Applies the overrides to the given builder.
args(String[]) - Method in interface ratpack.config.ConfigDataBuilder: Invokes ConfigDataBuilder.args(String, String, String[]), with no prefix and "=" as the separator.
args(String[]) - Method in interface ratpack.server.ServerConfigBuilder: Adds the given args as a config source.
args(String, String[]) - Method in interface ratpack.config.ConfigDataBuilder: Invokes ConfigDataBuilder.args(String, String, String[]), with no prefix.
args(String, String[]) - Method in interface ratpack.server.ServerConfigBuilder: Invokes ServerConfigBuilder.args(String, String, String[]), with no prefix.
args(String, String, String[]) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for the given string args.
args(String, String, String[]) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for the given string args.
array() - Method in class ratpack.bytebuf.ByteBufRef
arrayOffset() - Method in class ratpack.bytebuf.ByteBufRef
asMultiValueMap() - Method in interface ratpack.http.Headers
asReadOnly() - Method in class ratpack.bytebuf.ByteBufRef
AutoCloseWebSocketHandler<T extends java.lang.AutoCloseable> - Class in ratpack.websocket
AutoCloseWebSocketHandler() - Constructor for class ratpack.websocket.AutoCloseWebSocketHandler

B

BAD_GATEWAY - Static variable in interface ratpack.http.Status: The 502 status code.
BAD_REQUEST - Static variable in interface ratpack.http.Status: The 400 status code.
base(URI) - Static method in interface ratpack.http.HttpUrlBuilder: Create a new builder, with the initial state of the given URI.
baseDir(File) - Method in interface ratpack.server.ServerConfigBuilder: Calls ServerConfigBuilder.baseDir(Path) after converting the given File to a Path using File.toPath().
baseDir(Path) - Method in interface ratpack.server.ServerConfigBuilder: Sets the root of the filesystem for the application.
BaseDir - Class in ratpack.server
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.
basicAuth(String, String) - Method in interface ratpack.http.client.RequestSpec: Adds the appropriate header for HTTP Basic authentication with the given username and password.
beforeSend(Action<? super Response>) - Method in interface ratpack.http.Response: Register a callback to execute with the response immediately before sending it to the client.
bind(PathBinding) - Method in interface ratpack.path.PathBinder: Attempts to bind in the context of the given parent binding.
bindAddress(RatpackServer) - Static method in interface ratpack.server.PublicAddress: Uses the serves bind address as the current address.
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.
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.
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.ConfigDataBuilder: Creates the config data, based on the state of this builder.
build() - Method in interface ratpack.http.HttpUrlBuilder: Builds the URI based on this builder's current state.
build() - Method in interface ratpack.server.ServerConfigBuilder: Builds the server config.
build(boolean) - Method in interface ratpack.path.PathBinderBuilder: Generate a PathBinder from the contents of the builder.
build(Registry) - Method in class ratpack.impose.UserRegistryImposition: Returns the registry of additions, taking the original user registry as the argument
builder() - Static method in interface ratpack.config.ConfigData
builder() - Static method in interface ratpack.path.PathBinder: Creates a new path binder builder.
builder() - Method in interface ratpack.server.PublicAddress: Creates a URL builder using the public address as the base.
builder() - Static method in interface ratpack.server.ServerConfig
builder(ObjectMapper) - Static method in interface ratpack.config.ConfigData
builder(Context) - Method in interface ratpack.server.PublicAddress: Deprecated.
since 1.2, use PublicAddress.builder()
byContent(Action<? super ByContentSpec>) - Method in interface ratpack.handling.Context: Respond to the request based on the requested content type (i.e.
byContent(Registry, Action<? super ByContentSpec>) - Static method in class ratpack.handling.Handlers: Builds a content negotiating handler.
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.
byMethod(Registry, Action<? super ByMethodSpec>) - Static method in class ratpack.handling.Handlers: Builds a multi method handler.
ByMethodSpec - Interface in ratpack.handling: A specification of how to respond to a request, based on the requested method.
byteBufAllocator(ByteBufAllocator) - Method in interface ratpack.http.client.HttpClientSpec: The buffer allocator to use.
ByteBufRef - Class in ratpack.bytebuf: A byte buf that is backed by another, but has its own ref count lifecycle.
ByteBufRef(ByteBuf) - Constructor for class ratpack.bytebuf.ByteBufRef
bytes(byte[]) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the request body as a byte array.
bytesBefore(byte) - Method in class ratpack.bytebuf.ByteBufRef
bytesBefore(int, byte) - Method in class ratpack.bytebuf.ByteBufRef
bytesBefore(int, int, byte) - Method in class ratpack.bytebuf.ByteBufRef

C

capacity() - Method in class ratpack.bytebuf.ByteBufRef
capacity(int) - Method in class ratpack.bytebuf.ByteBufRef
chain(Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
chain(List<? extends Handler>) - Static method in class ratpack.handling.Handlers: Creates a handler chain from the given handlers.
chain(Action<? super Chain>) - Method in interface ratpack.handling.Chain: Constructs a handler using the given action to define a chain.
chain(Handler...) - Static method in class ratpack.handling.Handlers: Creates a handler chain from the given handlers.
chain(Registry, Action<? super Chain>) - Static method in class ratpack.handling.Handlers: Builds a chain, backed by the given registry.
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 - Interface in ratpack.handling: A chain is a write only builder for composing handlers.
check(Registry) - Method in interface ratpack.health.HealthCheck: Checks the health of the component, providing a promise for the result.
checkAll(Registry, Iterable<? extends HealthCheck>) - Static method in interface ratpack.health.HealthCheck: Execute health checks.
checkAll(Registry, Throttle, Iterable<? extends HealthCheck>) - Static method in interface ratpack.health.HealthCheck: Execute health checks.
chunkedJsonList(ObjectWriter, Publisher<T>) - Static method in class ratpack.jackson.Jackson: Renders a data stream as a JSON list, directly streaming the JSON.
chunkedJsonList(Registry, Publisher<T>) - Static method in class ratpack.jackson.Jackson: Renders a data stream as a JSON list, directly streaming the JSON.
clear() - Method in class ratpack.bytebuf.ByteBufRef
clear() - Method in interface ratpack.http.MutableHeaders: Removes all headers from this message.
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.
ClientErrorException - Exception in ratpack.http: Indicates that this exception represents a client error.
ClientErrorException(String) - Constructor for exception ratpack.http.ClientErrorException
ClientErrorException(String, Throwable) - Constructor for exception ratpack.http.ClientErrorException
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.http.client.HttpClient: Closes any pooled connections.
close() - Method in interface ratpack.websocket.WebSocket
close(int, String) - Method in interface ratpack.websocket.WebSocket
comment(String) - Method in interface ratpack.sse.Event: Specify a comment to include as part of this event.
compareTo(ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
ConfigData - Interface in ratpack.config: Configuration data for the application, potentially built from many sources.
ConfigDataBuilder - Interface in ratpack.config: Configures how configuration data will be loaded and bound to objects.
ConfigObject<T> - Interface in ratpack.config: An object deserialized from config.
ConfigSource - Interface in ratpack.config: Allows providing custom sources of configuration data.
configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.config.ConfigDataBuilder: Configures the object mapper used for binding configuration data to arbitrary objects.
configureObjectMapper(Action<ObjectMapper>) - Method in interface ratpack.server.ServerConfigBuilder: Configures the object mapper used for binding configuration data to arbitrary objects.
CONFLICT - Static variable in interface ratpack.http.Status: The 409 status code.
connect(Action<? super WebSocketSpec<T>>) - Method in interface ratpack.websocket.WebSocketConnector
ConnectionClosedException - Exception in ratpack.http: Thrown when an operation is attempted against a connection that is closed.
ConnectionClosedException(String) - Constructor for exception ratpack.http.ConnectionClosedException
connectQueueSize(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum amount of connections that may be waiting to be accepted at any time.
connectTimeout(Duration) - Method in interface ratpack.http.client.HttpClientSpec: The connect timeout value for requests.
connectTimeout(Duration) - Method in interface ratpack.http.client.RequestSpec: Sets the socket connection timeout.
connectTimeoutMillis(int) - Method in interface ratpack.server.ServerConfigBuilder: The connect timeout of the channel.
connectTimeoutSeconds(int) - Method in interface ratpack.http.client.RequestSpec: Deprecated.
since 1.4, use RequestSpec.connectTimeout(Duration)
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: Sets the response Content-Type header.
contentTypeIfNotSet(CharSequence) - Method in interface ratpack.http.Response: Sets the response Content-Type header, if it has not already been set.
contentTypeIfNotSet(Supplier<CharSequence>) - Method in interface ratpack.http.Response
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.
CONTINUE - Static variable in interface ratpack.http.Status: The 100 status code.
cookie(String, String) - Method in interface ratpack.http.Response: Creates a new cookie with the given name and value.
copy() - Method in class ratpack.bytebuf.ByteBufRef
copy(int, int) - Method in class ratpack.bytebuf.ByteBufRef
copy(Headers) - Method in interface ratpack.http.MutableHeaders
copyWith(Action<? super HttpClientSpec>) - Method in interface ratpack.http.client.HttpClient: Create a new HttpClient by appending the provided configuration to this client.
CREATED - Static variable in interface ratpack.http.Status: The 201 status code.
current() - Static method in class ratpack.impose.Impositions: The currently imposed impositions.

D

data(String) - Method in interface ratpack.sse.Event: Specify the event data for the server sent event.
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.
decompressResponse(boolean) - Method in interface ratpack.http.client.RequestSpec: Enables automatic decompression of the response.
decorate(Context, T) - Method in interface ratpack.render.RenderableDecorator: Decorates the given object on its way to being rendered.
decorate(Registry, Handler) - Method in interface ratpack.handling.HandlerDecorator: Creates a new handler that decorates the application handlers, given as the rest argument.
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 class ratpack.server.BaseDir: The default name for the base dir sentinel properties file.
DEFAULT_ENV_PREFIX - Static variable in interface ratpack.config.ConfigDataBuilder
DEFAULT_MAX_CHUNK_SIZE - Static variable in interface ratpack.server.ServerConfig: The default maximum chunk size to use when reading request/response bodies.
DEFAULT_MAX_CONTENT_LENGTH - Static variable in interface ratpack.server.ServerConfig: The default max content length.
DEFAULT_MAX_HEADER_SIZE - Static variable in interface ratpack.server.ServerConfig: The default maximum header size to use when reading requests.
DEFAULT_MAX_INITIAL_LINE_LENGTH - Static variable in interface ratpack.server.ServerConfig: The default maximum initial line length to use when reading requests.
DEFAULT_MAX_REDIRECTS - Static variable in interface ratpack.http.client.RequestSpec: The default number of redirects to follow automatically.
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.config.ConfigDataBuilder
DEFAULT_THREADS - Static variable in interface ratpack.server.ServerConfig: The default number of threads an application should use.
define(ServiceDependenciesSpec) - Method in interface ratpack.service.ServiceDependencies: Declares service depenencies via the given spec.
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.
delete() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the DELETE request method.
delete(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of DELETE.
delete(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
delete(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
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(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: Inserts the handler to chain if the request has a HTTP method of DELETE.
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 - Static variable in interface ratpack.http.HttpMethod: The DELETE method.
dependsOn(Class<?>, Class<?>) - Method in interface ratpack.service.ServiceDependenciesSpec: A convenience form of ServiceDependenciesSpec.dependsOn(Predicate, Predicate) where the predicates are based on compatibility with the given types.
dependsOn(Class<T1>, Predicate<? super T1>, Class<T2>, Predicate<? super T2>) - Method in interface ratpack.service.ServiceDependenciesSpec: Specifies that all services that are of the given dependentsType that match the dependents predicate are dependent on all services that are of the dependenciesType that match the dependencies predicate.
dependsOn(Predicate<? super Service>, Predicate<? super Service>) - Method in interface ratpack.service.ServiceDependenciesSpec: Specifies that all services that match the dependents predicate are dependent on all services that match the dependencies predicate.
DependsOn - Annotation Type in ratpack.service: Declares the other service types that services of the annotated type depend on.
development(boolean) - Method in interface ratpack.server.ServerConfigBuilder: Whether or not the application is "development".
dir(String) - Method in interface ratpack.file.FileHandlerSpec: Specifies the file system path to the files.
DirectChannelAccess - Interface in ratpack.handling.direct: Provides direct access to the underlying Netty Channel.
discardReadBytes() - Method in class ratpack.bytebuf.ByteBufRef
discardSomeReadBytes() - Method in class ratpack.bytebuf.ByteBufRef
duplicate() - Method in class ratpack.bytebuf.ByteBufRef

E

EARLY_HINTS - Static variable in interface ratpack.http.Status: The 103 status code.
embedded() - Static method in interface ratpack.server.ServerConfig: Creates a builder configured for development mode and an ephemeral port.
empty() - Static method in class ratpack.health.HealthCheckResults: Empty results.
enableMetricsCollection(boolean) - Method in interface ratpack.http.client.HttpClientSpec: Enable metric collection on HTTP Client.
encodedPath(String) - Method in interface ratpack.http.HttpUrlBuilder: Appends the path to the URL, without escaping any meta characters.
ensureWritable(int) - Method in class ratpack.bytebuf.ByteBufRef
ensureWritable(int, boolean) - Method in class ratpack.bytebuf.ByteBufRef
env() - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for environment variables starting with the prefix "RATPACK_".
env() - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for environment variables starting with the prefix "RATPACK_".
env(String) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for environment variables starting with the specified prefix.
env(String) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for environment variables starting with the specified prefix.
env(String, Function<String, String>) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for environment variables starting with the specified prefix.
env(String, Function<String, String>) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for environment variables starting with the specified prefix.
env(EnvironmentParser) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for environment variables using custom parsing logic.
env(EnvironmentParser) - Method in interface ratpack.server.ServerConfigBuilder: 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.
ephemeral() - Static method in class ratpack.impose.ForceServerListenPortImposition: Creates an imposition that forces the use of an ephemeral port.
equals(Object) - Method in class ratpack.bytebuf.ByteBufRef
error(Throwable) - Method in interface ratpack.handling.Context: Handles any error thrown during request handling.
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(Context, InvalidPathEncodingException) - Method in interface ratpack.error.ServerErrorHandler: Processes the given request path encoding error that occurred processing the given context.
errorIntercept(Action<? super Throwable>) - Method in interface ratpack.http.client.HttpClientSpec: Add an interceptor for errors thrown by this client (eg.
event(String) - Method in interface ratpack.sse.Event: Specify the event type for the server sent event.
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<T> - Interface in ratpack.sse: An individual event in a server sent event stream.
execController(ExecController) - Method in interface ratpack.http.client.HttpClientSpec: The exec controller to associate with.
EXPECTATION_FAILED - Static variable in interface ratpack.http.Status: The 417 status code.
expireCookie(String) - Method in interface ratpack.http.Response: Adds a cookie to the response with a 0 max-age, forcing the client to expire it.

F

FAILED_DEPENDENCY - Static variable in interface ratpack.http.Status: The 424 status code.
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.
FileHandlerSpec - Interface in ratpack.file: A specification for a handler that serves files from the file system.
FileIo - Class in ratpack.file: Utilities for streaming to and from files.
files() - Method in interface ratpack.form.Form: Returns all of the uploaded files.
files() - Method in interface ratpack.handling.Chain: Chain.files(Action), using the default config.
files(String) - Method in interface ratpack.file.FileHandlerSpec: A convenience method that specifies both request path and file system path bindings for serving files.
files(String) - Method in interface ratpack.form.Form: Return all of the uploaded files with the given name.
files(Action<? super FileHandlerSpec>) - Method in interface ratpack.handling.Chain: Adds a handler that serves files from the file system.
files(ServerConfig, Action<? super FileHandlerSpec>) - Static method in class ratpack.handling.Handlers: Creates a handler that serves files from the file system.
fileSystem(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
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(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.
fillInStackTrace() - Method in exception ratpack.http.ConnectionClosedException
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.
find() - Static method in class ratpack.server.BaseDir: Finds the “directory” on the classpath that contains a file called .ratpack.
find(String) - Static method in class ratpack.server.BaseDir: Finds the “directory” on the classpath that contains the marker file at the given path.
findBaseDir() - Method in interface ratpack.server.ServerConfigBuilder: Sets the base dir using BaseDir.find().
findBaseDir(String) - Method in interface ratpack.server.ServerConfigBuilder: Sets the base dir using BaseDir.find(String).
FORBIDDEN - Static variable in interface ratpack.http.Status: The 403 status code.
forceCloseConnection() - Method in interface ratpack.http.Response: Forces the closing of the current connection, even if the client requested it to be kept alive.
ForceDevelopmentImposition - Class in ratpack.impose: Forces whether to start the application in ServerConfig.isDevelopment() mode or not.
ForceServerListenPortImposition - Class in ratpack.impose: Forces the port that the server should use to listen for requests.
forEachByte(int, int, ByteProcessor) - Method in class ratpack.bytebuf.ByteBufRef
forEachByte(ByteProcessor) - Method in class ratpack.bytebuf.ByteBufRef
forEachByteDesc(int, int, ByteProcessor) - Method in class ratpack.bytebuf.ByteBufRef
forEachByteDesc(ByteProcessor) - Method in class ratpack.bytebuf.ByteBufRef
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.
Form - Interface in ratpack.form: An uploaded form.
FormParseOpts - Interface in ratpack.form: Options for parsing a Form.
forwardTo(Response) - Method in interface ratpack.http.client.ReceivedResponse
forwardTo(Response) - Method in interface ratpack.http.client.StreamedResponse: Stream this received response out to the given server response.
forwardTo(Response, Action<? super MutableHeaders>) - Method in interface ratpack.http.client.StreamedResponse: Stream this received response out to the given server response.
FOUND - Static variable in interface ratpack.http.Status: The 302 status code.
fragment(String) - Method in interface ratpack.http.HttpUrlBuilder: Add a fragment to the URL
fromJson(TypeToken<T>) - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into the given type.
fromJson(TypeToken<T>, ObjectMapper) - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into the given type.
fromJson(Class<T>) - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into the given type.
fromJson(Class<T>, ObjectMapper) - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into the given type.

G

GATEWAY_TIMEOUT - Static variable in interface ratpack.http.Status: The 504 status code.
generate(Request) - Method in interface ratpack.handling.RequestId.Generator: Generate the ID for the request.
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() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the GET request method.
get() - Method in interface ratpack.server.PublicAddress: Returns the public address.
get(CharSequence) - Method in interface ratpack.http.Headers: Returns the header value with the specified header name.
get(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of GET.
get(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
get(Class<O>) - Method in interface ratpack.config.ConfigData: Binds the root of the configuration data to the specified type.
get(Class<T>) - Method in class ratpack.impose.Impositions: Return an imposition of the given type, if one is currently imposed.
get(String) - Method in interface ratpack.http.Headers: Returns the header value with the specified header name.
get(String) - Method in interface ratpack.server.PublicAddress: Creates a URL by appending the given path to the public address
get(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
get(String, Class<O>) - Method in interface ratpack.config.ConfigData: Binds a segment of the configuration data to the specified type.
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(URI) - Method in interface ratpack.http.client.HttpClient
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(Action<? super HttpUrlBuilder>) - Method in interface ratpack.server.PublicAddress: Creates a URL by building a URL based on the public address.
get(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of GET.
get(Context) - Method in interface ratpack.server.PublicAddress: Deprecated.
since 1.2
get(Context, String) - Method in interface ratpack.server.PublicAddress: Deprecated.
since 1.2, use PublicAddress.get(String)
get(Context, Action<? super HttpUrlBuilder>) - Method in interface ratpack.server.PublicAddress: Deprecated.
since 1.2, use PublicAddress.get(Action)
get(Handler) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of GET.
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 - Static variable in interface ratpack.http.HttpMethod: The GET method.
getAdapted() - Method in interface ratpack.service.LegacyServiceAdapter: Deprecated.

The legacy service being adapted.
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.
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, TypeToken<O>) - Method in interface ratpack.config.ConfigData: Binds a segment of the configuration data to the specified type.
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.
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.
getBody(long) - Method in interface ratpack.http.Request: The body of the request allowing up to the provided size for the content.
getBody(long, Block) - Method in interface ratpack.http.Request: The body of the request allowing up to the provided size for the content.
getBody(Block) - Method in interface ratpack.http.Request: The body of the request.
getBodyStream() - Method in interface ratpack.http.Request: Allows reading the body as a stream, with back pressure.
getBodyStream(long) - Method in interface ratpack.http.Request: Allows reading the body as a stream, with back pressure.
getBoolean(int) - Method in class ratpack.bytebuf.ByteBufRef
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.
getByte(int) - Method in class ratpack.bytebuf.ByteBufRef
getByteBufAllocator() - Method in interface ratpack.http.client.HttpClient: The buffer allocator used by the client.
getBytes() - Method in interface ratpack.http.TypedData: The raw data as bytes.
getBytes(int, byte[]) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, byte[], int, int) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, ByteBuf, int) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, ByteBuf, int, int) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, OutputStream, int) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, ByteBuffer) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, FileChannel, long, int) - Method in class ratpack.bytebuf.ByteBufRef
getBytes(int, GatheringByteChannel, int) - Method in class ratpack.bytebuf.ByteBufRef
getChannel() - Method in interface ratpack.handling.direct.DirectChannelAccess: The channel.
getChar(int) - Method in class ratpack.bytebuf.ByteBufRef
getCharSequence(int, int, Charset) - Method in class ratpack.bytebuf.ByteBufRef
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.
getClientCertificate() - Method in interface ratpack.http.Request: The client's verified certificate if the connection was made with HTTPS and client authentication is enabled.
getClientErrorCode() - Method in exception ratpack.http.ClientErrorException
getClientErrorCode() - Method in exception ratpack.http.RequestBodyTooLargeException
getCode() - Method in interface ratpack.http.Status: The status code.
getComment() - Method in interface ratpack.sse.Event: The comment for this event.
getConfigSources() - Method in interface ratpack.config.ConfigDataBuilder: Returns the config sources used for configuration binding.
getConnection() - Method in interface ratpack.websocket.WebSocketMessage
getConnectQueueSize() - Method in interface ratpack.server.ServerConfig: The maximum amount of connections that may be waiting to be accepted at any time.
getConnectTimeout() - Method in interface ratpack.http.client.HttpClient: The default read timeout value.
getConnectTimeout() - Method in interface ratpack.http.client.RequestSpec: Gets the configured socket connection timeout.
getConnectTimeoutMillis() - Method in interface ratpack.server.ServerConfig: The connect timeout of the channel.
getContentLength() - Method in interface ratpack.http.Request: The advertised content length of the request body.
getContentType() - Method in interface ratpack.http.Request: The type of the data as specified in the "content-type" header.
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(String) - Method in interface ratpack.file.MimeTypes: Calculate the mime type for the given file.
getContext() - Method in interface ratpack.handling.Context: Returns this.
getCookies() - Method in interface ratpack.http.Request: The cookies that were sent with the request.
getCookies() - Method in interface ratpack.http.Response: 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.
getDecompressResponse() - Method in interface ratpack.http.client.RequestSpec: Gets if responses are automatically decompressed.
getDescription() - Method in interface ratpack.path.PathBinding: Describes the kind of path that this binder binds to.
getDirectChannelAccess() - Method in interface ratpack.handling.Context: Provides direct access to the backing Netty channel.
getDouble(int) - Method in class ratpack.bytebuf.ByteBufRef
getDoubleLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getDuration() - Method in interface ratpack.handling.RequestOutcome: The amount of elapsed time between Request.getTimestamp() and RequestOutcome.getSentAt().
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.
getExecution() - Method in interface ratpack.handling.Context: The execution of handling this request.
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.
getFileSystemBinding() - Method in interface ratpack.handling.Context: Returns the current filesystem binding from the context registry.
getFloat(int) - Method in class ratpack.bytebuf.ByteBufRef
getFloatLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getHeaders() - Method in interface ratpack.http.client.HttpResponse
getHeaders() - Method in interface ratpack.http.client.RequestSpec
getHeaders() - Method in interface ratpack.http.Request: The request headers.
getHeaders() - Method in interface ratpack.http.Response: The response headers.
getHeaders() - Method in interface ratpack.http.SentResponse: The headers that were sent in the response.
getHost() - Method in interface ratpack.http.client.Proxy: The host that proxied requests will be sent.
getId() - Method in interface ratpack.sse.Event: The “id” value of the event.
getIdleTimeout() - Method in interface ratpack.http.client.HttpClient: The idle connect timeout for connections in the connection pool, after which the the offending channel will be closed.
getIdleTimeout() - Method in interface ratpack.server.ServerConfig: The default amount of time to allow a connection to remain open without any traffic.
getInputStream() - Method in interface ratpack.http.TypedData: An input stream of the data.
getInstant(CharSequence) - Method in interface ratpack.http.Headers: Returns the header value as an instant with the specified header name.
getInt(int) - Method in class ratpack.bytebuf.ByteBufRef
getIntLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getItem() - Method in interface ratpack.sse.Event: The stream item that this event.
getLocalAddress() - Method in interface ratpack.http.Request: The address of the local network interface that received the request.
getLong(int) - Method in class ratpack.bytebuf.ByteBufRef
getLongLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getMaxChunkSize() - Method in interface ratpack.server.ServerConfig: The maximum chunk size to use when reading request (server) or response (client) bodies.
getMaxContentLength() - Method in interface ratpack.http.client.HttpClient: The maximum response length accepted by the client.
getMaxContentLength() - Method in interface ratpack.http.client.RequestSpec: Get the configured maximum response length.
getMaxContentLength() - Method in interface ratpack.http.Request: The max allowed content length for the request body.
getMaxContentLength() - Method in exception ratpack.http.RequestBodyTooLargeException
getMaxContentLength() - Method in interface ratpack.server.ServerConfig: The max content length to use for the HttpObjectAggregator.
getMaxHeaderSize() - Method in interface ratpack.server.ServerConfig: The maximum size of all headers allowed for reading http requests.
getMaxInitialLineLength() - Method in interface ratpack.server.ServerConfig: The maximum initial line length allowed for reading http requests.
getMaxMessagesPerRead() - Method in interface ratpack.server.ServerConfig: The maximum number of messages to read per read loop.
getMaxResponseChunkSize() - Method in interface ratpack.http.client.HttpClient: The max size of the chunks to emit when reading a response as a stream.
getMedium(int) - Method in class ratpack.bytebuf.ByteBufRef
getMediumLE(int) - Method in class ratpack.bytebuf.ByteBufRef
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.client.RequestSpec: Get the configured request method.
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: Deprecated.

See Service.getName().
getName() - Method in interface ratpack.service.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.
getNettyMethod() - Method in interface ratpack.http.HttpMethod: Returns the method in the underlying Netty form.
getNettySslContext() - Method in interface ratpack.server.ServerConfig: The SSL context to use if the application will serve content over HTTPS.
getNettyStatus() - Method in interface ratpack.http.Status: The status as Netty's type.
getNonProxyHosts() - Method in interface ratpack.http.client.Proxy: A collection of patterns which if any or matched, the outgoing request will bypass the HTTP proxy.
getObject() - Method in interface ratpack.config.ConfigObject: The bound object.
getObject() - Method in interface ratpack.jackson.JsonRender: The underlying object to be rendered.
getObjectMapper() - Method in interface ratpack.config.ConfigDataBuilder: Returns the object mapper used for configuration binding.
getObjectMapper() - Method in interface ratpack.jackson.JsonParseOpts
getObjectWriter() - Method in interface ratpack.jackson.JsonRender: The object writer to use to render the object as JSON.
getObjectWriter(Registry) - Static method in class ratpack.jackson.Jackson
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 multimap containing 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: The path to the config item.
getPath() - Method in interface ratpack.http.Request: The URI without the query string and leading forward slash.
getPathBinding() - Method in interface ratpack.handling.Context: The current request path binding.
getPathTokens() - Method in interface ratpack.handling.Context: The contextual path tokens of the current PathBinding.
getPoolQueueSize() - Method in interface ratpack.http.client.HttpClient: The number of connections that the client will queue if pool was depleted for any given server.
getPoolSize() - Method in interface ratpack.http.client.HttpClient: The number of connections that the client will pool for any given server.
getPort() - Method in interface ratpack.http.client.Proxy: The port on the proxy where proxied requests will be sent.
getPort() - Method in class ratpack.impose.ForceServerListenPortImposition: The port to be forced.
getPort() - Method in interface ratpack.server.ServerConfig: The port that the application should listen to requests on.
getPortFile() - Method in interface ratpack.server.ServerConfig: The path to write the port that the application is listening on.
getProtocol() - Method in interface ratpack.http.Request: The HTTP protocol of the request.
getProxy() - Method in interface ratpack.http.client.HttpClient: The configured proxy instance for the client.
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.
getReadTimeout() - Method in interface ratpack.http.client.HttpClient: The default read timeout value.
getReadTimeout() - Method in interface ratpack.http.client.RequestSpec: Gets the configured socket read timeout.
getReceiveBufferSize() - Method in interface ratpack.server.ServerConfig: The StandardSocketOptions.SO_RCVBUF option.
getReceivedContentLength() - Method in exception ratpack.http.RequestBodyTooLargeException
getRedirects() - Method in interface ratpack.http.client.RequestSpec: Get the configured maximum number of redirects.
getRegistry() - Method in interface ratpack.handling.Chain: The registry that backs this chain.
getRegistry() - Method in interface ratpack.server.RatpackServer: Convenience method to provide easy access to the application registry via a server reference
getRegistry() - Method in interface ratpack.server.StartEvent: Deprecated.

The server registry.
getRegistry() - Method in interface ratpack.server.StopEvent: Deprecated.

The server registry.
getRegistry() - Method in interface ratpack.service.StartEvent: The server registry.
getRegistry() - Method in interface ratpack.service.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.
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.
getRootNode() - Method in interface ratpack.config.ConfigData
getScheme() - Method in interface ratpack.server.RatpackServer: The URL scheme the server uses.
getSentAt() - Method in interface ratpack.handling.RequestOutcome: The time at when this request was dealt with from the application's point of view.
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.
getShort(int) - Method in class ratpack.bytebuf.ByteBufRef
getShortLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getSslContext() - Method in interface ratpack.http.client.RequestSpec: Get the configured SslContext used for client and server SSL authentication.
getSslContext() - Method in interface ratpack.server.ServerConfig: Deprecated.
since 1.5, prefer ServerConfig.getNettySslContext()
getStatus() - Method in interface ratpack.http.client.HttpResponse
getStatus() - Method in interface ratpack.http.Response: 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.HttpResponse
getText() - Method in interface ratpack.http.TypedData: The data as text.
getText() - Method in interface ratpack.websocket.WebSocketMessage
getText(Charset) - Method in interface ratpack.http.TypedData
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.
getTimestamp() - Method in interface ratpack.http.Request: The timestamp for when this request was received.
getTokens() - Method in interface ratpack.path.PathBinding: Any tokens that the binding has extracted from the path.
getType() - Method in interface ratpack.config.ConfigObject: The raw type of the config item.
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).
getTypeToken() - Method in interface ratpack.config.ConfigObject: The complete type of the config item.
getUnsignedByte(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedInt(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedIntLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedMedium(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedMediumLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedShort(int) - Method in class ratpack.bytebuf.ByteBufRef
getUnsignedShortLE(int) - Method in class ratpack.bytebuf.ByteBufRef
getUri() - Method in interface ratpack.http.client.RequestSpec: The request URI.
getUri() - Method in interface ratpack.http.Request: The complete URI of the request (path + query string).
getUrl() - Method in interface ratpack.http.client.RequestSpec: Deprecated.
since 1.4, use RequestSpec.getUri()
getViewClass() - Method in interface ratpack.jackson.JsonRender: The view class to use when rendering the object.
getWriteSpinCount() - Method in interface ratpack.server.ServerConfig: The maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
GONE - Static variable in interface ratpack.http.Status: The 410 status code.

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 interface ratpack.handling.RequestLogger: Adds RequestLogger.log(RequestOutcome) as a context close action, effectively logging the request.
handle(Context) - Method in class ratpack.handling.ResponseTimer: Adds the number of milliseconds of elapsed time between Request.getTimestamp() and when the response is ready to be sent.
handle(Context) - Method in class ratpack.health.HealthCheckHandler: Renders health checks.
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.
Handler - Interface in ratpack.handling: A handler participates in the processing of a request/response pair, operating on a Context.
HandlerDecorator - Interface in ratpack.handling: Decorates a handler, effectively wrapping it.
handlers(Action<? super Chain>) - Method in interface ratpack.server.RatpackServerSpec: Sets the root handler to the chain specified by the given action.
Handlers - Class in ratpack.handling: Factory methods for handler decorations.
hasArray() - Method in class ratpack.bytebuf.ByteBufRef
hashCode() - Method in class ratpack.bytebuf.ByteBufRef
hasMemoryAddress() - Method in class ratpack.bytebuf.ByteBufRef
head() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the HEAD request method.
HEAD - Static variable in interface ratpack.http.HttpMethod: The HEAD method.
header(CharSequence) - Method in interface ratpack.handling.Context: Returns the request header with the specified name.
header(CharSequence) - Static method in interface ratpack.handling.RequestId.Generator: Creates a generator that uses the value for the given header, falling back to a RequestId.Generator.randomUuid() generator if the header is not present.
header(CharSequence, Object...) - Method in interface ratpack.handling.Context: Sets a response header.
header(CharSequence, RequestId.Generator) - Static method in interface ratpack.handling.RequestId.Generator: Creates a generator that uses the value for the given header, using the given fallback generator if the header is not present.
HEADER_FIELDS_TOO_LARGE - Static variable in interface ratpack.http.Status: The 431 status code.
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 buffer 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(String, Throttle) - Constructor for class ratpack.health.HealthCheckHandler: Constructor.
HealthCheckHandler(Throttle) - Constructor for class ratpack.health.HealthCheckHandler: Uses the HealthCheckHandler.DEFAULT_NAME_TOKEN and the given throttle.
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) - Method in interface ratpack.http.client.ProxySpec: Configure the host that will proxy outbound HTTP requests.
host(String) - Method in interface ratpack.http.HttpUrlBuilder: Sets the host to the given value.
host(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
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.
html(Class<? extends Handler>) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/html".
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.
HTTP_VER_NOT_SUPPORTED - Static variable in interface ratpack.http.Status: The 505 status code.
httpClient(ByteBufAllocator, int) - Static method in interface ratpack.http.client.HttpClient: Deprecated.
since 1.4, use HttpClient.of(Action)
httpClient(ServerConfig, Registry) - Static method in interface ratpack.http.client.HttpClient: Deprecated.
since 1.4, use HttpClient.of(Action)
HttpClient - Interface in ratpack.http.client: An asynchronous HTTP client.
HttpClientReadTimeoutException - Exception in ratpack.http.client: Thrown when the read timeout duration for a request is reached.
HttpClientReadTimeoutException(String) - Constructor for exception ratpack.http.client.HttpClientReadTimeoutException: Constructor.
HttpClientSpec - Interface in ratpack.http.client: An additive specification of a HTTP client.
HttpMethod - Interface in ratpack.http: The method of a HTTP request.
HttpResponse - Interface in ratpack.http.client: Base type of responses from HttpClient regardless of if the request is streaming or not.
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(String) - Method in interface ratpack.sse.Event: Specify the event id for the server sent event.
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.
idleTimeout(Duration) - Method in interface ratpack.http.client.HttpClientSpec: The default amount of time to allow a connection to remain idle in the connection pool.
idleTimeout(Duration) - Method in interface ratpack.server.ServerConfigBuilder: The default read timeout of the channel.
IM_A_TEAPOT - Static variable in interface ratpack.http.Status: The 418 status code.
IM_USED - Static variable in interface ratpack.http.Status: The 226 status code.
impose(Factory<? extends T>) - Method in class ratpack.impose.Impositions: Delegates to Impositions.impose(Impositions, Factory), with this as the impositions.
impose(Impositions, Factory<? extends T>) - Static method in class ratpack.impose.Impositions: Sets impositions that will be available during execution of the given function, from this thread.
Imposition - Interface in ratpack.impose: A marker interface for all types used as an imposition.
Impositions - Class in ratpack.impose: A mechanism for imposing things on an application from the outside and typically during testing.
ImpositionsSpec - Interface in ratpack.impose: Used to specify a set of impositions.
indexFiles(String...) - Method in interface ratpack.file.FileHandlerSpec: The files that should be used when a request is made for a directory.
indexOf(int, int, byte) - Method in class ratpack.bytebuf.ByteBufRef
inferred(String) - Static method in interface ratpack.server.PublicAddress: An implementation that infers the public address from the current request.
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(Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
insert(Action<? super Chain>) - Method in interface ratpack.handling.Chain: Inserts the given nested handler 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: Creates an interceptor with no initialisation action.
INSUFFICIENT_STORAGE - Static variable in interface ratpack.http.Status: The 507 status code.
intercept(Execution, ExecInterceptor.ExecType, Block) - Method in class ratpack.logging.MDCInterceptor
INTERNAL_SERVER_ERROR - Static variable in interface ratpack.http.Status: The 500 status code.
internalNioBuffer(int, int) - Method in class ratpack.bytebuf.ByteBufRef
InvalidPathEncodingException - Exception in ratpack.path: Thrown when a request is made for a path that is not correctly encoded.
InvalidPathEncodingException(Throwable) - Constructor for exception ratpack.path.InvalidPathEncodingException: Constructs the exception.
is1xx() - Method in interface ratpack.http.Status: If Status.getCode() is >= 100 and < 200.
is2xx() - Method in interface ratpack.http.Status: If Status.getCode() is >= 200 and < 300.
is3xx() - Method in interface ratpack.http.Status: If Status.getCode() is >= 300 and < 400.
is4xx() - Method in interface ratpack.http.Status: If Status.getCode() is >= 400 and < 500.
is5xx() - Method in interface ratpack.http.Status: If Status.getCode() is >= 500 and < 600.
isAjaxRequest() - Method in interface ratpack.http.Request: A flag representing whether or not the request originated via AJAX.
isChunkedTransfer() - Method in interface ratpack.http.Request: Whether this request contains a Transfer-Encoding: chunked header.
isDelete() - Method in interface ratpack.http.HttpMethod: True if the method is DELETE.
isDevelopment() - Method in class ratpack.impose.ForceDevelopmentImposition: The value to impose.
isDevelopment() - Method in interface ratpack.server.ServerConfig: Whether or not the server is in "development" mode.
isDirect() - Method in class ratpack.bytebuf.ByteBufRef
isEmpty() - Method in interface ratpack.http.MediaType: True if this represents the absence of a value (i.e.
isExpectsContinue() - Method in interface ratpack.http.Request: Whether this request contains a Expect: 100-Continue header.
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", or ends with "+json".
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.
isReadable() - Method in class ratpack.bytebuf.ByteBufRef
isReadable(int) - Method in class ratpack.bytebuf.ByteBufRef
isReadOnly() - Method in class ratpack.bytebuf.ByteBufRef
isRegisterShutdownHook() - Method in interface ratpack.server.ServerConfig: Whether a JVM shutdown hook was registered for the application in order to shut it down gracefully.
isReload() - Method in interface ratpack.server.StartEvent: Deprecated.

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: Deprecated.

If the server is stopping in response to a reload (during development), as opposed to for the first time.
isReload() - Method in interface ratpack.service.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.service.StopEvent: If the server is stopping in response to a reload (during development), as opposed to for the first time.
isRequireClientSslAuth() - Method in interface ratpack.server.ServerConfig: Deprecated.
since 1.5, replaced by ServerConfig.getNettySslContext()
isRunning() - Method in interface ratpack.server.RatpackServer: Returns true if the server is running.
isText() - Method in interface ratpack.http.MediaType: True if this type starts with "text/".
isUnhealthy() - Method in class ratpack.health.HealthCheckResults: Whether any result is unhealthy.
isWritable() - Method in class ratpack.bytebuf.ByteBufRef
isWritable(int) - Method in class ratpack.bytebuf.ByteBufRef

J

Jackson - Class in ratpack.jackson: Provides key integration points with the Jackson support for dealing with JSON.
jacksonModules(Module...) - Method in interface ratpack.config.ConfigDataBuilder: Adds Jackson modules to the object mapper.
json(ByteSource) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a JSON file.
json(ByteSource) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a JSON file.
json(Class<? extends 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(Object) - Static method in class ratpack.jackson.Jackson: Creates a renderable object to render the given object as JSON.
json(Object, ObjectWriter) - Static method in class ratpack.jackson.Jackson: Creates a renderable object to render the given object as JSON.
json(Object, ObjectWriter, Class<?>) - Static method in class ratpack.jackson.Jackson: Creates a renderable object to render the given object as JSON.
json(Object, Class<?>) - Static method in class ratpack.jackson.Jackson: Creates a renderable object to render the given object as JSON.
json(String) - Method in interface ratpack.config.ConfigDataBuilder: Adds the JSON file at the given path as a configuration source.
json(String) - Method in interface ratpack.server.ServerConfigBuilder: Adds the JSON file at the given path as a configuration source.
json(URL) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a JSON file.
json(URL) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a JSON file.
json(Path) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a JSON file.
json(Path) - Method in interface ratpack.server.ServerConfigBuilder: 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_SUFFIX - Static variable in interface ratpack.http.MediaType: "+json".
jsonNode() - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into a JsonNode.
jsonNode(ObjectMapper) - Static method in class ratpack.jackson.Jackson: Creates a parseable object to parse a request body into a JsonNode.
JsonParseOpts - Interface in ratpack.jackson
JsonRender - Interface in ratpack.jackson: A renderable object wrapper for rendering as JSON.

L

lastModified(Instant, Runnable) - Method in interface ratpack.handling.Context: Convenience method for handling last-modified based HTTP caching.
lastModified(Date, Runnable) - Method in interface ratpack.handling.Context: Convenience method for handling last-modified based HTTP caching.
LegacyServiceAdapter - Interface in ratpack.service: Deprecated.
since 1.3
LENGTH_REQUIRED - Static variable in interface ratpack.http.Status: The 411 status code.
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, FileSystemBinding) - Method in interface ratpack.config.ConfigSource: Loads the configuration data from this data source.
LOCKED - Static variable in interface ratpack.http.Status: The 423 status code.
log(RequestOutcome) - Method in interface ratpack.handling.RequestLogger: Format the provided RequestOutcome to the given string builder.
LOGGER - Static variable in interface ratpack.handling.RequestLogger: The default request logger.
LOGGER_NAME - Static variable in interface ratpack.handling.RequestLogger: The name of RequestLogger.LOGGER: "ratpack.request".
LOOP_DETECTED - Static variable in interface ratpack.http.Status: The 508 status code.

M

map(String) - Method in interface ratpack.config.EnvironmentParser: Transforms a segment.
markReaderIndex() - Method in class ratpack.bytebuf.ByteBufRef
markWriterIndex() - Method in class ratpack.bytebuf.ByteBufRef
maxCapacity() - Method in class ratpack.bytebuf.ByteBufRef
maxChunkSize(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum size of read chunks of request/response bodies.
maxContentLength(int) - Method in interface ratpack.http.client.HttpClientSpec: The maximum size to allow for responses.
maxContentLength(int) - Method in interface ratpack.http.client.RequestSpec: The maximum response length to accept.
maxContentLength(int) - Method in interface ratpack.server.ServerConfigBuilder: The max number of bytes a request body can be.
maxHeaderSize(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum size of all headers allowed for reading http requests.
maxInitialLineLength(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum initial line length allowed for reading http requests.
maxLength(int) - Method in interface ratpack.websocket.WebSocketSpec
maxMessagesPerRead(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum number of messages to read per read loop.
maxWritableBytes() - Method in class ratpack.bytebuf.ByteBufRef
maybeEncodedPath(String) - Method in interface ratpack.http.HttpUrlBuilder: Appends the path to the URL, without escaping any meta characters, unless it is empty or null.
maybePath(String) - Method in interface ratpack.http.HttpUrlBuilder: Appends the path to the URL, unless it is empty or null.
MDCInterceptor - Class in ratpack.logging: An execution interceptor that adds support for SLF4J's Mapped Diagnostic Context (MDC) feature.
MediaType - Interface in ratpack.http: A structured value for a Content-Type header value.
memoryAddress() - Method in class ratpack.bytebuf.ByteBufRef
method(String) - Method in interface ratpack.http.client.RequestSpec: Specifies the request method.
method(HttpMethod) - Method in interface ratpack.http.client.RequestSpec: Specifies the request method.
METHOD_NOT_ALLOWED - Static variable in interface ratpack.http.Status: The 405 status code.
MimeTypes - Interface in ratpack.file: A registry for mime types.
MISDIRECTED_REQUEST - Static variable in interface ratpack.http.Status: The 421 status code.
MOVED_PERMANENTLY - Static variable in interface ratpack.http.Status: The 301 status code.
MULTI_STATUS - Static variable in interface ratpack.http.Status: The 207 status code.
MULTIPLE_CHOICES - Static variable in interface ratpack.http.Status: The 300 status code.
MutableHeaders - Interface in ratpack.http: A set of HTTP headers that can be changed.

N

name(String) - Method in interface ratpack.http.HttpMethod: Returns true if the method has the given name, insensitive to case.
named(String, Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of methodName.
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: Inserts the handler to chain if the request has a HTTP method of methodName.
ncsa() - Static method in interface ratpack.handling.RequestLogger: Calls RequestLogger.ncsa(Logger) with RequestLogger.LOGGER.
ncsa(Logger) - Static method in interface ratpack.handling.RequestLogger: Logs in the NCSA Common Log format.
NETWORK_AUTH_REQUIRED - Static variable in interface ratpack.http.Status: The 511 status code.
next() - Method in interface ratpack.handling.Context: Delegate handling to the next handler in line.
next() - Static method in class ratpack.handling.Handlers: A handler that simply delegates to the next handler.
next(Registry) - Method in interface ratpack.handling.Context: Invokes the next handler, after adding the given registry.
nioBuffer() - Method in class ratpack.bytebuf.ByteBufRef
nioBuffer(int, int) - Method in class ratpack.bytebuf.ByteBufRef
nioBufferCount() - Method in class ratpack.bytebuf.ByteBufRef
nioBuffers() - Method in class ratpack.bytebuf.ByteBufRef
nioBuffers(int, int) - Method in class ratpack.bytebuf.ByteBufRef
NO_CONTENT - Static variable in interface ratpack.http.Status: The 204 status code.
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.
noMatch(Class<? extends 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.
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.
NON_AUTHORITATIVE_INFO - Static variable in interface ratpack.http.Status: The 203 status code.
none() - Static method in class ratpack.impose.Impositions: An empty set of impositions.
none() - Static method in class ratpack.impose.UserRegistryImposition: Creates an imposition of an empty registry.
nonProxyHosts(Collection<String>) - Method in interface ratpack.http.client.ProxySpec: Configure a collection of patterns for which if any are matched, the outbound request will bypass the HTTP proxy.
noop() - Static method in interface ratpack.handling.HandlerDecorator: A handler decorator implementation that does not decorate the handler.
NoOptParserSupport - Class in ratpack.parse: A convenience base for parsers that don't require options.
NoOptParserSupport() - Constructor for class ratpack.parse.NoOptParserSupport
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.
NoSuchParserException(TypeToken<?>, Object, String, Iterable<Parser<?>>) - 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
NOT_ACCEPTABLE - Static variable in interface ratpack.http.Status: The 406 status code.
NOT_EXTENDED - Static variable in interface ratpack.http.Status: The 510 status code.
NOT_FOUND - Static variable in interface ratpack.http.Status: The 404 status code.
NOT_IMPLEMENTED - Static variable in interface ratpack.http.Status: The 501 status code.
NOT_MODIFIED - Static variable in interface ratpack.http.Status: The 304 status code.
notFound() - Method in interface ratpack.handling.Chain: Raises a 404 Context.clientError(int).
notFound() - Method in interface ratpack.handling.Context: Issues a 404 client error.
notFound() - Static method in class ratpack.handling.Handlers: Convenience for clientError(404).
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

object(String, Object) - Method in interface ratpack.config.ConfigDataBuilder: Adds the object's fields at the given path as a configuration source.
object(String, Object) - Method in interface ratpack.server.ServerConfigBuilder: Adds the object's fields at the given path as a configuration source.
of(boolean) - Static method in class ratpack.impose.ForceDevelopmentImposition: Creates a new imposition of the specified value.
of(boolean, Action<? super PathBinderBuilder>) - Static method in interface ratpack.path.PathBinder: Builds a path binder programmatically.
of(int) - Static method in interface ratpack.http.Status: Creates a new status object.
of(int) - Static method in class ratpack.impose.ForceServerListenPortImposition: Creates an imposition that forces the use of the specified port.
of(int, String) - Static method in interface ratpack.http.Status: Creates a new status object.
of(ObjectMapper, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData: Builds a new config data with the specified object mapper, from the given definition.
of(TypeToken<T>) - Static method in class ratpack.parse.Parse: Creates a parse object, with no options.
of(TypeToken<T>, O) - Static method in class ratpack.parse.Parse: Creates a parse object.
of(CharSequence) - Static method in interface ratpack.handling.RequestId: Creates a new request ID from the given string.
of(Class<T>) - Static method in class ratpack.parse.Parse: Creates a parse object, with no options.
of(Class<T>, BiConsumer<? super Context, ? super T>) - Static method in interface ratpack.render.Renderer: Creates a renderer implementation from the given arguments.
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>, O) - Static method in class ratpack.parse.Parse: Creates a parse object.
of(String) - Static method in interface ratpack.handling.UserId: Creates new user identifier of the given string.
of(String) - Static method in interface ratpack.http.HttpMethod: Creates a method of the given name.
of(String, Function<? super Registry, ? extends Promise<HealthCheck.Result>>) - Static method in interface ratpack.health.HealthCheck: Convenience factory for health check implementations.
of(URI) - Static method in interface ratpack.server.PublicAddress: Creates a new public address object using the given URI.
of(Path) - Static method in interface ratpack.file.FileSystemBinding
of(Consumer<? super ServerConfigBuilder>) - Static method in class ratpack.impose.ServerConfigImposition: Creates an override that applies the given function to the server config builder.
of(Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData: Builds a new config data with the default object mapper, from the given definition.
of(Action<? super RequestOutcome>) - Static method in interface ratpack.handling.RequestLogger: Creates a request logger with the given action as the implementation of the RequestLogger.log(RequestOutcome) method.
of(Action<? super HttpClientSpec>) - Static method in interface ratpack.http.client.HttpClient: Creates a new HTTP client.
of(Action<? super ImpositionsSpec>) - Static method in class ratpack.impose.Impositions: Creates an impositions instance of the given imposition objects.
of(Action<? super RatpackServerSpec>) - Static method in interface ratpack.server.RatpackServer: Creates a new, unstarted, Ratpack server from the given definition.
of(Action<? super ServerConfigBuilder>) - Static method in interface ratpack.server.ServerConfig
of(Block) - Static method in class ratpack.handling.Handlers: Creates a handler from the given block
of(Function<? super Registry, ? extends Registry>) - Static method in class ratpack.impose.UserRegistryImposition: Creates an imposition of registry returned by the given function.
of(HttpClient) - Static method in interface ratpack.sse.ServerSentEventStreamClient: Creates an SSE client.
of(Registry) - Static method in class ratpack.impose.UserRegistryImposition: Creates an imposition of the given registry.
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.
OK - Static variable in interface ratpack.http.Status: The 200 status code.
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(Action<WebSocketClose<T>>) - Method in interface ratpack.websocket.WebSocketSpec
onClose(WebSocketClose<T>) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onClose(WebSocketClose<T>) - Method in interface ratpack.websocket.WebSocketHandler
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.ConfigDataBuilder: Sets the error all that will be used for added configuration sources.
onError(Action<? super Throwable>) - Method in interface ratpack.server.ServerConfigBuilder: Sets the error all that will be used for added configuration sources.
onlyIf(Predicate<? super Context>, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
onlyIf(Predicate<? super Context>, Handler) - Method in interface ratpack.handling.Chain: Invokes the given handler only if the predicate passes.
onlyIf(Predicate<? super Context>, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that delegates to the given handler if the predicate applies to the context.
onMessage(Action<WebSocketMessage<T>>) - Method in interface ratpack.websocket.WebSocketSpec
onMessage(WebSocketMessage<T>) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onMessage(WebSocketMessage<T>) - Method in interface ratpack.websocket.WebSocketHandler
onOpen(WebSocket) - Method in class ratpack.websocket.AutoCloseWebSocketHandler
onOpen(WebSocket) - Method in interface ratpack.websocket.WebSocketHandler
onRedirect(Function<? super ReceivedResponse, Action<? super RequestSpec>>) - Method in interface ratpack.http.client.RequestSpec: Specifies a function to invoke when a redirectable response is received.
onStart(StartEvent) - Method in interface ratpack.server.Service: Deprecated.

See Service.onStart(ratpack.service.StartEvent).
onStart(StartEvent) - Method in interface ratpack.service.Service: Server startup event.
onStop(StopEvent) - Method in interface ratpack.server.Service: Deprecated.

See Service.onStop(ratpack.service.StopEvent).
onStop(StopEvent) - Method in interface ratpack.service.Service: Server stop event.
open(Path, OpenOption...) - Static method in class ratpack.file.FileIo: Creates a promise for an (open) async file channel.
open(Path, Set<? extends OpenOption>, FileAttribute<?>...) - Static method in class ratpack.file.FileIo: Creates a promise for an (open) async file channel.
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.
options() - Static method in class ratpack.handling.Handlers: A handler that delegates to the next handler if the request is OPTIONS, otherwise raises a 405 client error.
options() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the OPTIONS request method.
options(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of OPTIONS.
options(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
options(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
options(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 OPTIONS.
options(Block) - Method in interface ratpack.handling.ByMethodSpec: Defines the action to to take if the request has a HTTP method of OPTIONS.
options(Handler) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of OPTIONS.
options(Handler) - Method in interface ratpack.handling.Chain: Adds a handler that delegates to the given handler if the request HTTPMethod is OPTIONS and the path is at the current root.
OPTIONS - Static variable in interface ratpack.http.HttpMethod: The OPTIONS method.
order() - Method in class ratpack.bytebuf.ByteBufRef: Deprecated.
order(ByteOrder) - Method in class ratpack.bytebuf.ByteBufRef: Deprecated.

P

params(Multimap<String, ?>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
params(String...) - 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(Action<? super ImmutableMultimap.Builder<String, Object>>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
params(MultiValueMap<String, ?>) - Method in interface ratpack.http.HttpUrlBuilder: Add some query params to the URL.
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(TypeToken<T>, O) - Method in interface ratpack.handling.Context: Constructs a Parse from the given args and delegates to Context.parse(Parse).
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(Class<T>, O) - Method in interface ratpack.handling.Context: Constructs a Parse from the given args and delegates to Context.parse(Parse).
parse(String, boolean) - Static method in interface ratpack.path.PathBinder: Creates a path binder by parsing the given path binding specification.
parse(Context, TypedData, TypeToken<T>) - Method in class ratpack.parse.NoOptParserSupport: The parser implementation.
parse(Context, TypedData, Parse<T, Void>) - 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, Parse<T, O>) - Method in interface ratpack.parse.Parser: Deserializes the request body of the context into an object.
parse(TypedData, Parse<T, O>) - Method in interface ratpack.handling.Context: Parses the provided request body into an object.
parse(Parse<T, O>) - Method in interface ratpack.handling.Context: Parses the request body into an object.
Parse<T,O> - Class in ratpack.parse: The specification of a particular parse.
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() - Constructor for class ratpack.parse.ParserSupport: Constructor.
PARTIAL_CONTENT - Static variable in interface ratpack.http.Status: The 206 status code.
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.
patch() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the PATCH request method.
patch(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of PATCH.
patch(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
patch(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
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(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: Inserts the handler to chain if the request has a HTTP method of PATCH.
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 - Static variable in interface ratpack.http.HttpMethod: The PATCH method.
path(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
path(String) - Method in interface ratpack.file.FileHandlerSpec: Specifies the request path to bind to for serving files.
path(String) - Method in interface ratpack.http.HttpUrlBuilder: Appends the path to the URL.
path(String) - Method in interface ratpack.websocket.WebSocketSpec
path(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
path(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.
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(Handler) - Method in interface ratpack.handling.Chain
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.
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.
PathBinding - Interface in ratpack.path: A path binding represents some kind of "match" on the path of a request.
PathResolver - Interface in ratpack.config
PathTokens - Interface in ratpack.path: A marker interface for the contextual object that represents the tokens extracted from the request path.
PAYLOAD_TOO_LARGE - Static variable in interface ratpack.http.Status: The 413 status code.
PAYMENT_REQUIRED - Static variable in interface ratpack.http.Status: The 402 status code.
PERMANENT_REDIRECT - Static variable in interface ratpack.http.Status: The 308 status code.
PLAIN_TEXT_UTF8 - Static variable in interface ratpack.http.MediaType: "text/plain;charset=utf-8".
plainText(Class<? extends Handler>) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "text/plain".
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".
poolQueueSize(int) - Method in interface ratpack.http.client.HttpClientSpec: The maximum number of requests that will be queued if connection pool was depleted.
poolSize(int) - Method in interface ratpack.http.client.HttpClientSpec: The maximum number of connections to maintain to a given protocol/host/port.
port(int) - Method in interface ratpack.http.client.ProxySpec: Configure the port on the proxy to will outbound HTTP requests will be sent.
port(int) - Method in interface ratpack.http.HttpUrlBuilder: Sets the port to the given value.
port(int) - Method in interface ratpack.server.ServerConfigBuilder: Sets the port to listen for requests on.
portFile(Path) - Method in interface ratpack.server.ServerConfigBuilder: The path where to store the bind port
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() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the POST request method.
post(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of POST.
post(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
post(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
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(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.
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: Inserts the handler to chain if the request has a HTTP method of POST.
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 - Static variable in interface ratpack.http.HttpMethod: The POST method.
PRECONDITION_FAILED - Static variable in interface ratpack.http.Status: The 412 status code.
PRECONDITION_REQUIRED - Static variable in interface ratpack.http.Status: The 428 status code.
prefix(String, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
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, 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(Class<? extends 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.
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.
prependHandlers(Class<? extends Action<? super Chain>>) - Static method in interface ratpack.handling.HandlerDecorator: A factory for decorator impls that effectively inserts the given chain before the “rest” of the handlers.
prependHandlers(Action<? super Chain>) - Static method in interface ratpack.handling.HandlerDecorator: A factory for decorator impls that effectively inserts the given chain before the “rest” of the handlers.
PROCESSING - Static variable in interface ratpack.http.Status: The 102 status code.
props(ByteSource) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a properties file.
props(ByteSource) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a properties file.
props(String) - Method in interface ratpack.config.ConfigDataBuilder: Adds the properties file at the given path as a configuration source.
props(String) - Method in interface ratpack.server.ServerConfigBuilder: Adds the properties file at the given path as a configuration source.
props(URL) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a properties file.
props(URL) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a properties file.
props(Path) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a properties file.
props(Path) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a properties file.
props(Map<String, String>) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a Map (flat key-value pairs).
props(Map<String, String>) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a Map (flat key-value pairs).
props(Properties) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a properties object.
props(Properties) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a properties object.
proxy(Action<? super ProxySpec>) - Method in interface ratpack.http.client.HttpClientSpec: Configure a HTTP proxy for outgoing calls from this client.
Proxy - Interface in ratpack.http.client: Configuration data for an HTTP proxy to utilize for outbound requests using HttpClient.
PROXY_AUTH_REQUIRED - Static variable in interface ratpack.http.Status: The 407 status code.
ProxySpec - Interface in ratpack.http.client: Class for specifying configuration for an HTTP proxy to utilize for outgoing requests using HttpClient.
publicAddress(URI) - Method in interface ratpack.server.ServerConfigBuilder: The public address of the application.
PublicAddress - Interface in ratpack.server: The advertised public address.
publisher(ByteBufAllocator) - Method in class ratpack.http.ResponseChunks: Returns the chunk publisher.
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() - Method in interface ratpack.http.client.RequestSpec: Specifies to use the PUT request method.
put(Class<? extends Handler>) - Method in interface ratpack.handling.ByMethodSpec: Inserts the handler to chain if the request has a HTTP method of PUT.
put(Class<? extends Handler>) - Method in interface ratpack.handling.Chain
put(String, Class<? extends Handler>) - Method in interface ratpack.handling.Chain
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(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: Inserts the handler to chain if the request has a HTTP method of PUT.
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 - Static variable in interface ratpack.http.HttpMethod: The PUT method.

R

randomUuid() - Static method in interface ratpack.handling.RequestId.Generator: Generates IDs based of a random UUID.
RANGE_NOT_SATISFIABLE - Static variable in interface ratpack.http.Status: The 416 status code.
ratpack.bytebuf - package ratpack.bytebuf
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.file - package ratpack.file: Types for dealing with the file system and serving files.
ratpack.form - package ratpack.form: Support for handling uploaded forms, including file uploads.
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.impose - package ratpack.impose
ratpack.jackson - package ratpack.jackson: Integration with the Jackson JSON marshalling library.
ratpack.logging - package ratpack.logging: Utility classes for integration Ratpack with various logging frameworks.
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.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.service - package ratpack.service: Services participate in the application start/stop lifecycle.
ratpack.sse - package ratpack.sse: Support for Server Sent Events.
ratpack.ssl - package ratpack.ssl: Convenience utitilities for dealing with SSL.
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.
read(Promise<? extends AsynchronousFileChannel>, ByteBufAllocator, int) - Static method in class ratpack.file.FileIo: Read the contents of a file from the given start until the given stop.
read(Promise<? extends AsynchronousFileChannel>, ByteBufAllocator, int, long, long) - Static method in class ratpack.file.FileIo: Read the contents of a file.
readableBytes() - Method in class ratpack.bytebuf.ByteBufRef
readBoolean() - Method in class ratpack.bytebuf.ByteBufRef
readByte() - Method in class ratpack.bytebuf.ByteBufRef
readBytes(byte[]) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(byte[], int, int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(ByteBuf, int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(ByteBuf, int, int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(OutputStream, int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(ByteBuffer) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(FileChannel, long, int) - Method in class ratpack.bytebuf.ByteBufRef
readBytes(GatheringByteChannel, int) - Method in class ratpack.bytebuf.ByteBufRef
readChar() - Method in class ratpack.bytebuf.ByteBufRef
readCharSequence(int, Charset) - Method in class ratpack.bytebuf.ByteBufRef
readDouble() - Method in class ratpack.bytebuf.ByteBufRef
readDoubleLE() - Method in class ratpack.bytebuf.ByteBufRef
readerIndex() - Method in class ratpack.bytebuf.ByteBufRef
readerIndex(int) - Method in class ratpack.bytebuf.ByteBufRef
readFloat() - Method in class ratpack.bytebuf.ByteBufRef
readFloatLE() - Method in class ratpack.bytebuf.ByteBufRef
readInt() - Method in class ratpack.bytebuf.ByteBufRef
readIntLE() - Method in class ratpack.bytebuf.ByteBufRef
readLong() - Method in class ratpack.bytebuf.ByteBufRef
readLongLE() - Method in class ratpack.bytebuf.ByteBufRef
readMedium() - Method in class ratpack.bytebuf.ByteBufRef
readMediumLE() - Method in class ratpack.bytebuf.ByteBufRef
readRetainedSlice(int) - Method in class ratpack.bytebuf.ByteBufRef
readShort() - Method in class ratpack.bytebuf.ByteBufRef
readShortLE() - Method in class ratpack.bytebuf.ByteBufRef
readSlice(int) - Method in class ratpack.bytebuf.ByteBufRef
readStream(Promise<? extends AsynchronousFileChannel>, ByteBufAllocator, int) - Static method in class ratpack.file.FileIo: Streams the entire contents of a file.
readStream(Promise<? extends AsynchronousFileChannel>, ByteBufAllocator, int, long, long) - Static method in class ratpack.file.FileIo: Streams the contents of a file.
readTimeout(Duration) - Method in interface ratpack.http.client.HttpClientSpec: The read timeout value for responses.
readTimeout(Duration) - Method in interface ratpack.http.client.RequestSpec: Sets the socket read timeout.
readTimeoutSeconds(int) - Method in interface ratpack.http.client.RequestSpec: Deprecated.
since 1.4, use RequestSpec.readTimeout(Duration)
readUnsignedByte() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedInt() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedIntLE() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedMedium() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedMediumLE() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedShort() - Method in class ratpack.bytebuf.ByteBufRef
readUnsignedShortLE() - Method in class ratpack.bytebuf.ByteBufRef
receiveBufferSize(int) - Method in interface ratpack.server.ServerConfigBuilder: The StandardSocketOptions.SO_RCVBUF option.
ReceivedResponse - Interface in ratpack.http.client
redirect(int, Object) - Method in interface ratpack.handling.Context: Sends a redirect response to the given location, and with the given status code.
redirect(int, String) - Method in interface ratpack.handling.Chain: Sends an HTTP redirect to the specified location.
redirect(int, String) - Method in interface ratpack.handling.Context: Sends a redirect response to the given location, and with the given status code.
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(int, URI) - Method in interface ratpack.handling.Context: Sends a redirect response to the given location, and with the given status code.
redirect(Object) - Method in interface ratpack.handling.Context: Sends a temporary redirect response (i.e.
redirect(String) - Method in interface ratpack.handling.Context: Sends a temporary redirect response (i.e.
redirect(URI) - Method in interface ratpack.handling.Context: Sends a temporary redirect response (i.e.
redirect(Context, int, Object) - Method in interface ratpack.handling.Redirector: Issues a HTTP redirect response, transforming the given to value into a value for the Location header.
redirect(Context, String, int) - Method in interface ratpack.handling.Redirector: Deprecated.
use Redirector.redirect(Context, int, Object)
Redirector - Interface in ratpack.handling: Interprets objects as a Location header value, and issues the redirect response.
redirects(int) - Method in interface ratpack.http.client.RequestSpec: The maximum number of redirects to automatically follow, before simply returning the redirect response.
refCnt() - Method in class ratpack.bytebuf.ByteBufRef
register() - Method in interface ratpack.render.RenderableDecorator: A registration action, typically used with RegistrySpec.with(Action).
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(Action<? super RegistrySpec>, 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(Registry) - Method in interface ratpack.handling.Chain: Makes the contents of the given registry available for downstream handlers of the same nesting level.
register(Registry) - Static method in class ratpack.handling.Handlers: A handler that simply calls Context.next(Registry) with the given registry.
register(Registry, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
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, Handler) - Static method in class ratpack.handling.Handlers: A handler that simply calls Context.insert(Registry, Handler...) with the given registry and handler.
registerShutdownHook(boolean) - Method in interface ratpack.server.ServerConfigBuilder: Whether or not to register a JVM shutdown hook to gracefully stop the server.
registry(Function<? super Registry, ? extends Registry>) - Method in interface ratpack.server.RatpackServerSpec: Sets the user registry as the return value of the given function.
registry(Registry) - Method in interface ratpack.server.RatpackServerSpec: Sets the user registry to exactly the given registry.
registryOf(Action<? super RegistrySpec>) - Method in interface ratpack.server.RatpackServerSpec: Builds the user registry via the given spec action.
release() - Method in class ratpack.bytebuf.ByteBufRef
release(int) - Method in class ratpack.bytebuf.ByteBufRef
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.
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) - Method in class ratpack.sse.ServerSentEvents: 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.
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(String, Throwable) - Constructor for exception ratpack.render.RendererException: Constructor.
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) - Method in interface ratpack.sse.ServerSentEventStreamClient
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(URI, Action<? super RequestSpec>) - Method in interface ratpack.sse.ServerSentEventStreamClient
Request - Interface in ratpack.http: A request to be handled.
REQUEST_TIMEOUT - Static variable in interface ratpack.http.Status: The 408 status code.
RequestBodyAlreadyReadException - Exception in ratpack.http: Thrown when an attempt is made to read the request body when it has already been read.
RequestBodyAlreadyReadException() - Constructor for exception ratpack.http.RequestBodyAlreadyReadException
RequestBodyAlreadyReadException(String) - Constructor for exception ratpack.http.RequestBodyAlreadyReadException: Constructor.
RequestBodyTooLargeException - Exception in ratpack.http
RequestBodyTooLargeException(long, long) - Constructor for exception ratpack.http.RequestBodyTooLargeException
RequestId - Interface in ratpack.handling: An opaque identifier for the request.
RequestId.Generator - Interface in ratpack.handling: Generates, or assigns, an ID for requests.
requestIntercept(Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClientSpec: Add an interceptor for all requests handled by this client.
RequestLogger - Interface in ratpack.handling: A handler that logs information about the request.
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(String, TypeToken<?>) - Method in interface ratpack.server.ServerConfigBuilder: Declares that it is required that the server config provide an object of the given type at the given path.
require(String, Class<?>) - Method in interface ratpack.server.ServerConfigBuilder: Declares that it is required that the server config provide an object of the given type at the given path.
require(String, Type) - Method in interface ratpack.server.ServerConfigBuilder: Declares that it is required that the server config provide an object of the given type at the given path.
requireClientSslAuth(boolean) - Method in interface ratpack.server.ServerConfigBuilder: Deprecated.
since 1.5, prefer ServerConfigBuilder.ssl(SslContext)
RESET_CONTENT - Static variable in interface ratpack.http.Status: The 205 status code.
resetReaderIndex() - Method in class ratpack.bytebuf.ByteBufRef
resetWriterIndex() - Method in class ratpack.bytebuf.ByteBufRef
resolve(String) - Method in interface ratpack.config.PathResolver
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.
responseIntercept(Operation) - Method in interface ratpack.http.client.HttpClientSpec: Execute the provide Operation for all responses returned by this client.
responseIntercept(Action<? super HttpResponse>) - Method in interface ratpack.http.client.HttpClientSpec: Add an interceptor for all responses returned by this client.
responseMaxChunkSize(int) - Method in interface ratpack.http.client.HttpClientSpec: The max size of the chunks to emit when reading a response as a stream.
responseMaxChunkSize(int) - Method in interface ratpack.http.client.RequestSpec: The max size of the chunks to emit when reading a response as a stream.
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
retain() - Method in class ratpack.bytebuf.ByteBufRef
retain(int) - Method in class ratpack.bytebuf.ByteBufRef
retainedDuplicate() - Method in class ratpack.bytebuf.ByteBufRef
retainedSlice() - Method in class ratpack.bytebuf.ByteBufRef
retainedSlice(int, int) - Method in class ratpack.bytebuf.ByteBufRef
root() - Static method in interface ratpack.file.FileSystemBinding

S

secure() - Method in interface ratpack.http.HttpUrlBuilder: Sets the protocol to be HTTPS.
SEE_OTHER - Static variable in interface ratpack.http.Status: The 303 status code.
segment(String, Object...) - Method in interface ratpack.http.HttpUrlBuilder: Appends one path segment to the URL.
send() - Method in interface ratpack.http.Response: Sends the response back to the client, with no 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(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(ByteBuf) - Method in interface ratpack.websocket.WebSocket
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(CharSequence, ByteBuf) - Method in interface ratpack.http.Response: Sends the response, using the given content type and bytes 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(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(String) - 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(Action<? super ServerConfigBuilder>) - Method in interface ratpack.server.RatpackServerSpec
serverConfig(ServerConfig) - Method in interface ratpack.server.RatpackServerSpec: Sets the server configuration for the application.
serverConfig(ServerConfigBuilder) - Method in interface ratpack.server.RatpackServerSpec: Convenience function that builds the config from the given builder and delegates to RatpackServerSpec.serverConfig(ServerConfig).
ServerConfig - Interface in ratpack.server: The configuration of the server.
ServerConfigBuilder - Interface in ratpack.server: Builds a ServerConfig.
ServerConfigImposition - Class in ratpack.impose: An override object for imposing server configuration.
ServerErrorHandler - Interface in ratpack.error: An object that can deal with errors that occur during the processing of an exchange.
serverSentEvents(Publisher<T>, Action<? super Event<T>>) - Static method in class ratpack.sse.ServerSentEvents: Creates a new renderable object wrapping the event stream.
ServerSentEvents - Class in ratpack.sse: A renderable object for streaming server side events.
ServerSentEventStreamClient - Interface in ratpack.sse
Service - Interface in ratpack.server: Deprecated.
since 1.3
Service - Interface in ratpack.service: A service participates in the application lifecycle.
SERVICE_UNAVAILABLE - Static variable in interface ratpack.http.Status: The 503 status code.
ServiceDependencies - Interface in ratpack.service: Specifies dependencies between services.
ServiceDependenciesSpec - Interface in ratpack.service: Allows declaring which services depend on which services.
set(CharSequence, Iterable<?>) - Method in interface ratpack.http.MutableHeaders: Sets a new header with the specified name and values.
set(CharSequence, Object) - Method in interface ratpack.http.MutableHeaders: Sets the (only) value for the header with the specified name.
setBoolean(int, boolean) - Method in class ratpack.bytebuf.ByteBufRef
setByte(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, byte[]) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, byte[], int, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, ByteBuf, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, ByteBuf, int, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, InputStream, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, ByteBuffer) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, FileChannel, long, int) - Method in class ratpack.bytebuf.ByteBufRef
setBytes(int, ScatteringByteChannel, int) - Method in class ratpack.bytebuf.ByteBufRef
setChar(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setCharSequence(int, CharSequence, Charset) - Method in class ratpack.bytebuf.ByteBufRef
setDate(CharSequence, Instant) - Method in interface ratpack.http.MutableHeaders: Set a header with the given date as the value.
setDate(CharSequence, Date) - Method in interface ratpack.http.MutableHeaders: Set a header with the given date as the value.
setDouble(int, double) - Method in class ratpack.bytebuf.ByteBufRef
setDoubleLE(int, double) - Method in class ratpack.bytebuf.ByteBufRef
setFloat(int, float) - Method in class ratpack.bytebuf.ByteBufRef
setFloatLE(int, float) - Method in class ratpack.bytebuf.ByteBufRef
setIdleTimeout(Duration) - Method in interface ratpack.http.Request: Overrides the idle timeout for this connection.
setIndex(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setInt(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setIntLE(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setLong(int, long) - Method in class ratpack.bytebuf.ByteBufRef
setLongLE(int, long) - Method in class ratpack.bytebuf.ByteBufRef
setMaxContentLength(long) - Method in interface ratpack.http.Request: Sets the allowed max content length for the request body.
setMedium(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setMediumLE(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setShort(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setShortLE(int, int) - Method in class ratpack.bytebuf.ByteBufRef
setZero(int, int) - Method in class ratpack.bytebuf.ByteBufRef
shouldReload(Registry) - Method in interface ratpack.server.ReloadInformant: Whether the server should reload.
shutdown(String, Action<? super StopEvent>) - Static method in interface ratpack.service.Service: Creates a service that executes the given action as the Service.onStop(StopEvent) implementation.
skipBytes(int) - Method in class ratpack.bytebuf.ByteBufRef
slice() - Method in class ratpack.bytebuf.ByteBufRef
slice(int, int) - Method in class ratpack.bytebuf.ByteBufRef
sseStreamClient(ByteBufAllocator) - Static method in interface ratpack.sse.ServerSentEventStreamClient: Deprecated.
since 1.4, use ServerSentEventStreamClient.of(HttpClient).
ssl(SslContext) - Method in interface ratpack.server.ServerConfigBuilder: The SSL context to use if the application serves content over HTTPS.
ssl(SSLContext) - Method in interface ratpack.server.ServerConfigBuilder: Deprecated.
since 1.5, replaced by ServerConfigBuilder.ssl(SslContext)
sslContext(SslContext) - Method in interface ratpack.http.client.RequestSpec: Sets the SslContext used for client and server SSL authentication.
sslContext(File, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(File, String, File, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using password protected keystore as well as password protected truststore file.
sslContext(InputStream, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(InputStream, String, InputStream, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using password protected keystore as well as password protected truststore file.
sslContext(URL, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(URL, String, URL, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using password protected keystore as well as password protected truststore file.
sslContext(Path, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using a password-protected keystore file.
sslContext(Path, String, Path, String) - Static method in class ratpack.ssl.SSLContexts: Creates an SSL context using password protected keystore as well as password protected truststore file.
sslContext(SSLContext) - Method in interface ratpack.http.client.RequestSpec: Deprecated.
since 1.5, use RequestSpec.sslContext(SslContext)
sslContext(Factory<SSLContext>) - Method in interface ratpack.http.client.RequestSpec: Deprecated.
since 1.5, no replacement.
SSLContexts - Class in ratpack.ssl: Factory methods for initializing an SSLContext.
standard() - Static method in interface ratpack.handling.Redirector: The default redirect issuing strategy.
start() - Method in interface ratpack.server.RatpackServer: Starts the server, returning as soon as the server is up and ready to receive requests.
start(Action<? super RatpackServerSpec>) - Static method in interface ratpack.server.RatpackServer: Convenience method to define and RatpackServer.start() the server in one go.
StartEvent - Interface in ratpack.server: Deprecated.
since 1.3
StartEvent - Interface in ratpack.service: A start event.
startup(String, Action<? super StartEvent>) - Static method in interface ratpack.service.Service: Creates a service that executes the given action as the Service.onStart(StartEvent) implementation.
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: Sets the status line of the response.
status(Status) - Method in interface ratpack.http.Response: 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: Deprecated.
since 1.3
StopEvent - Interface in ratpack.service: A stop event.
Stopper - Interface in ratpack.server: The mechanism for stopping the application from within the application.
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.
stringChunks(CharSequence, Charset, 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(Publisher<? extends CharSequence>) - Static method in class ratpack.http.ResponseChunks: Transmit each string emitted by the publisher as a chunk.
SWITCHING_PROTOCOLS - Static variable in interface ratpack.http.Status: The 101 status code.
sysProps() - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for system properties starting with the prefix "ratpack.".
sysProps() - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for system properties starting with the prefix "ratpack.".
sysProps(String) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for system properties starting with the specified prefix.
sysProps(String) - Method in interface ratpack.server.ServerConfigBuilder: 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.
TEMPORARY_REDIRECT - Static variable in interface ratpack.http.Status: The 307 status code.
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".
threads(int) - Method in interface ratpack.server.ServerConfigBuilder: The number of threads to use.
toJson(Registry) - Static method in class ratpack.jackson.Jackson: Creates a mapping function that returns the JSON representation as a string of the input object.
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.
TOO_MANY_REQUESTS - Static variable in interface ratpack.http.Status: The 429 status code.
toString() - Method in class ratpack.bytebuf.ByteBufRef
toString() - Method in class ratpack.health.HealthCheckResults: Provides a string representation of the results.
toString() - Method in class ratpack.parse.NullParseOpts
toString() - Method in interface ratpack.server.ReloadInformant: The description of this reload informant.
toString(int, int, Charset) - Method in class ratpack.bytebuf.ByteBufRef
toString(Charset) - Method in class ratpack.bytebuf.ByteBufRef
touch() - Method in class ratpack.bytebuf.ByteBufRef
touch(Object) - Method in class ratpack.bytebuf.ByteBufRef
type(CharSequence) - Method in interface ratpack.http.client.RequestSpec.Body: Specifies the "Content-Type" of the request.
type(CharSequence, Class<? extends 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(CharSequence, 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(CharSequence, 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, Class<? extends 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, 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 - Static variable in interface ratpack.error.ClientErrorHandler: A type token for this type.
TYPE - Static variable in interface ratpack.error.ServerErrorHandler: A type token for this type.
TYPE - Static variable in interface ratpack.file.FileSystemBinding: A type token for this type.
TYPE - Static variable in interface ratpack.handling.Context: A type token for this type.
TYPE - Static variable in interface ratpack.handling.Redirector: A type token for this type.
TYPE - Static variable in interface ratpack.handling.RequestId.Generator: A type token for this type.
TYPE - Static variable in interface ratpack.handling.RequestId: A type token for this type.
TYPE - Static variable in interface ratpack.http.Request: A type token for this type.
TYPE - Static variable in interface ratpack.http.Response: A type token for this type.
TYPE - Static variable in interface ratpack.path.PathBinding: A type token for this type.
TYPE - Static variable in interface ratpack.server.ServerConfig: A type token for this type.
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.

U

UNAUTHORIZED - Static variable in interface ratpack.http.Status: The 401 status code.
UNAVAILBLE_FOR_LEGAL_REASONS - Static variable in interface ratpack.http.Status: The 451 status code.
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(String, Throwable) - Static method in class ratpack.health.HealthCheck.Result: Creates an unhealthy result, with the given exception and message.
unhealthy(Throwable) - Static method in class ratpack.health.HealthCheck.Result: Creates an unhealthy result, with the given exception.
UNPROCESSABLE_ENTITY - Static variable in interface ratpack.http.Status: The 422 status code.
unspecified(Class<? extends Handler>) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client did not provide a usable "Accept" header in the request.
unspecified(String) - Method in interface ratpack.handling.ByContentSpec: Specifies that the handler for the specified content type should be used if the client did not provide a usable "Accept" header in the request.
unspecified(Block) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client did not provide a usable "Accept" header in the request.
unspecified(Handler) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client did not provide a usable "Accept" header in the request.
UNSUPPORTED_MEDIA_TYPE - Static variable in interface ratpack.http.Status: The 415 status code.
unwrap() - Method in class ratpack.bytebuf.ByteBufRef
UPGRADE_REQUIRED - Static variable in interface ratpack.http.Status: The 426 status code.
UploadedFile - Interface in ratpack.form: A file that was uploaded via a form.
URI_TOO_LONG - Static variable in interface ratpack.http.Status: The 414 status code.
USE_PROXY - Static variable in interface ratpack.http.Status: The 505 status code.
useJdkAddressResolver() - Method in interface ratpack.http.client.HttpClientSpec: Specifies that the JDK name resolver should be used.
UserId - Interface in ratpack.handling: An opaque identifier for the “user” that initiated the request.
UserRegistryImposition - Class in ratpack.impose: Imposes an extra registry to be joined with the user registry when starting an application.

V

value() - Method in annotation type ratpack.service.DependsOn: The types of services that services of the annotated type depend on.
VARIANT_ALSO_NEGOTIATES - Static variable in interface ratpack.http.Status: The 506 status code.

W

websocket(Context, Function<WebSocket, T>) - Static method in class ratpack.websocket.WebSockets
websocket(Context, WebSocketHandler<?>) - Static method in class ratpack.websocket.WebSockets
WebSocket - Interface in ratpack.websocket
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
when(boolean, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain: Inlines the given chain if test is true.
when(boolean, Class<? extends Action<? super Chain>>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain: Inlines the appropriate chain based on the given test.
when(boolean, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Inlines the given chain if test is true.
when(boolean, Action<? super Chain>, Action<? super Chain>) - Method in interface ratpack.handling.Chain: Inlines the appropriate chain based on the given test.
when(Predicate<? super Context>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
when(Predicate<? super Context>, Class<? extends Action<? super Chain>>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
when(Predicate<? super Context>, Action<? super Chain>) - Method in interface ratpack.handling.Chain
when(Predicate<? super Context>, Action<? super Chain>, Action<? super Chain>) - Method in interface ratpack.handling.Chain
when(Predicate<? super Context>, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that inserts and delegates the given handler if the predicate applies to the context.
whenOrElse(Predicate<? super Context>, Handler, Handler) - Static method in class ratpack.handling.Handlers: Creates a handler that inserts and delegates to the appropriate handler depending if the predicate applies to the context.
withInit(Action<? super Execution>) - Static method in class ratpack.logging.MDCInterceptor: Creates an interceptor with the given initialisation action.
writableBytes() - Method in class ratpack.bytebuf.ByteBufRef
write(ByteBuf, long, Promise<? extends AsynchronousFileChannel>) - Static method in class ratpack.file.FileIo: Writes the given bytes to the given file, starting at the given position.
write(ByteBuf, Promise<? extends AsynchronousFileChannel>) - Static method in class ratpack.file.FileIo: Writes the given bytes to the given file, starting at the start.
write(Publisher<? extends ByteBuf>, long, Promise<? extends AsynchronousFileChannel>) - Static method in class ratpack.file.FileIo: Writes the bytes of the given publisher to the given file, returning the number of bytes written.
write(Publisher<? extends ByteBuf>, Promise<? extends AsynchronousFileChannel>) - Static method in class ratpack.file.FileIo: Writes the bytes of the given publisher to the given file starting at the start, returning the number of bytes written.
writeBoolean(boolean) - Method in class ratpack.bytebuf.ByteBufRef
writeByte(int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(byte[]) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(byte[], int, int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(ByteBuf) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(ByteBuf, int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(ByteBuf, int, int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(InputStream, int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(ByteBuffer) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(FileChannel, long, int) - Method in class ratpack.bytebuf.ByteBufRef
writeBytes(ScatteringByteChannel, int) - Method in class ratpack.bytebuf.ByteBufRef
writeChar(int) - Method in class ratpack.bytebuf.ByteBufRef
writeCharSequence(CharSequence, Charset) - Method in class ratpack.bytebuf.ByteBufRef
writeDouble(double) - Method in class ratpack.bytebuf.ByteBufRef
writeDoubleLE(double) - Method in class ratpack.bytebuf.ByteBufRef
writeFloat(float) - Method in class ratpack.bytebuf.ByteBufRef
writeFloatLE(float) - Method in class ratpack.bytebuf.ByteBufRef
writeInt(int) - Method in class ratpack.bytebuf.ByteBufRef
writeIntLE(int) - Method in class ratpack.bytebuf.ByteBufRef
writeLong(long) - Method in class ratpack.bytebuf.ByteBufRef
writeLongLE(long) - Method in class ratpack.bytebuf.ByteBufRef
writeMedium(int) - Method in class ratpack.bytebuf.ByteBufRef
writeMediumLE(int) - Method in class ratpack.bytebuf.ByteBufRef
writerIndex() - Method in class ratpack.bytebuf.ByteBufRef
writerIndex(int) - Method in class ratpack.bytebuf.ByteBufRef
writeShort(int) - Method in class ratpack.bytebuf.ByteBufRef
writeShortLE(int) - Method in class ratpack.bytebuf.ByteBufRef
writeSpinCount(int) - Method in interface ratpack.server.ServerConfigBuilder: The maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
writeTo(OutputStream) - Method in interface ratpack.http.TypedData: Writes the data to the given output stream.
writeTo(Writer) - Method in class ratpack.health.HealthCheckResults: Writes a string representation of the results to the given writer.
writeZero(int) - Method in class ratpack.bytebuf.ByteBufRef

X

xml(Class<? extends Handler>) - Method in interface ratpack.handling.ByContentSpec: Specifies that the given handler should be used if the client wants content of type "application/xml".
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.ConfigDataBuilder: Adds a configuration source for a YAML file.
yaml(ByteSource) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a YAML file.
yaml(String) - Method in interface ratpack.config.ConfigDataBuilder: Adds the YAML file at the given path as a configuration source.
yaml(String) - Method in interface ratpack.server.ServerConfigBuilder: Adds the YAML file at the given path as a configuration source.
yaml(URL) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a YAML file.
yaml(URL) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a YAML file.
yaml(Path) - Method in interface ratpack.config.ConfigDataBuilder: Adds a configuration source for a YAML file.
yaml(Path) - Method in interface ratpack.server.ServerConfigBuilder: Adds a configuration source for a YAML file.

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