All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class |
Description |
AutoCloseWebSocketHandler<T extends java.lang.AutoCloseable> |
|
BaseDir |
|
BaseDirRequiredException |
Thrown when the base directory of the application has not been set but is required.
|
ByContentSpec |
A specification of how to respond to a request, based on the requested content type (i.e.
|
ByMethodSpec |
A specification of how to respond to a request, based on the requested method.
|
ByteBufRef |
A byte buf that is backed by another, but has its own ref count lifecycle.
|
Chain |
A chain is a write only builder for composing handlers.
|
ClientErrorException |
Indicates that this exception represents a client error.
|
ClientErrorHandler |
The client error handler deals with errors that are due to the client doing something wrong.
|
ConfigData |
Configuration data for the application, potentially built from many sources.
|
ConfigDataBuilder |
Configures how configuration data will be loaded and bound to objects.
|
ConfigObject<T> |
An object deserialized from config.
|
ConfigSource |
Allows providing custom sources of configuration data.
|
ConnectionClosedException |
Thrown when an operation is attempted against a connection that is closed.
|
Context |
The context of an individual Handler invocation.
|
DependsOn |
Declares the other service types that services of the annotated type depend on.
|
DirectChannelAccess |
Provides direct access to the underlying Netty Channel .
|
EnvironmentParser |
Strategy for parsing a set of environment variables into a form appropriate for use in a ConfigSource .
|
Event<T> |
Deprecated.
|
FileHandlerSpec |
A specification for a handler that serves files from the file system.
|
FileIo |
Utilities for streaming to and from files.
|
FileSystemBinding |
A file system binding represents a file system location that is used to resolve relative paths.
|
ForceDevelopmentImposition |
|
ForceServerListenPortImposition |
Forces the port that the server should use to listen for requests.
|
Form |
An uploaded form.
|
FormParseOpts |
Options for parsing a Form .
|
Handler |
A handler participates in the processing of a request/response pair, operating on a Context .
|
HandlerDecorator |
Decorates a handler, effectively wrapping it.
|
Handlers |
Factory methods for handler decorations.
|
Headers |
An immutable set of HTTP headers.
|
HealthCheck |
Reports on the health of some aspect of the system.
|
HealthCheck.Result |
The result of a health check.
|
HealthCheckHandler |
|
HealthCheckResults |
A value type representing the result of running multiple health checks.
|
HttpClient |
An asynchronous HTTP client.
|
HttpClientReadTimeoutException |
Thrown when the read timeout duration for a request is reached.
|
HttpClientSpec |
An additive specification of a HTTP client.
|
HttpMethod |
The method of a HTTP request.
|
HttpResponse |
Base type of responses from HttpClient regardless of if the request is streaming or not.
|
HttpUrlBuilder |
Builds a HTTP URL, safely.
|
Imposition |
A marker interface for all types used as an imposition.
|
Impositions |
A mechanism for imposing things on an application from the outside and typically during testing.
|
ImpositionsSpec |
Used to specify a set of impositions.
|
InjectionHandler |
A super class that removes the boiler plate of retrieving objects from the context registry by injecting them based on a method signature.
|
InjectionHandler.NoSuitableHandleMethodException |
Exception thrown if the subclass doesn't provide a valid handle method.
|
InvalidPathEncodingException |
Thrown when a request is made for a path that is not correctly encoded.
|
Jackson |
Provides key integration points with the Jackson support for dealing with JSON.
|
JsonParseOpts |
|
JsonRender |
|
LegacyServiceAdapter |
Deprecated.
|
MDCInterceptor |
|
MediaType |
A structured value for a Content-Type header value.
|
MimeTypes |
A registry for mime types.
|
MutableHeaders |
A set of HTTP headers that can be changed.
|
NoBaseDirException |
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.
|
NoOptParserSupport |
A convenience base for parsers that don't require options.
|
NoSuchParserException |
Thrown when a request is made to parse the request, but no suitable parser was found that matched the content type and parse object.
|
NoSuchRendererException |
Thrown when a request is made to render an object, but no suitable renderer can be found.
|
NullParseOpts |
A generic parse type that can be used when parsers do not need any extra information from parse objects other than type.
|
Parse<T,O> |
The specification of a particular parse.
|
ParseException |
A generic super type for exceptions indicate something when wrong for a parse operation.
|
Parser<O> |
A parser converts a request body into an object.
|
ParserException |
Wraps an exception thrown by a parser while parsing.
|
ParserSupport<O> |
A convenience superclass for Parser implementations.
|
PathBinder |
A path binder binds to a request path, extracting information from it.
|
PathBinderBuilder |
A builder to generate a PathBinder from a list of tokens and literals.
|
PathBinding |
A path binding represents some kind of "match" on the path of a request.
|
PathResolver |
|
PathTokens |
A marker interface for the contextual object that represents the tokens extracted from the request path.
|
Proxy |
Configuration data for an HTTP proxy to utilize for outbound requests using HttpClient .
|
Proxy.ProxyProtocol |
|
ProxyCredentials |
Credentials to use when using a HTTP proxy that requires authentication.
|
ProxySpec |
Class for specifying configuration for an HTTP proxy to utilize for outgoing requests using HttpClient .
|
PublicAddress |
The advertised public address.
|
RatpackServer |
The entry point for creating and starting a Ratpack application.
|
RatpackServerSpec |
A buildable specification of a Ratpack server.
|
ReceivedResponse |
|
Redirector |
Interprets objects as a Location header value, and issues the redirect response.
|
ReloadInformant |
Informs when the server should be reloaded, during development .
|
Renderable |
|
RenderableDecorator<T> |
Decorates an object before it is rendered .
|
RenderableDecoratorSupport<T> |
|
Renderer<T> |
A renderer is responsible for rendering an object to the response.
|
RendererException |
Wraps an exception thrown by a renderer while rendering.
|
RendererSupport<T> |
|
RenderException |
A generic super type for exceptions indicate something when wrong for a render operation.
|
Request |
A request to be handled.
|
RequestBodyAlreadyReadException |
Thrown when an attempt is made to read the request body when it has already been read.
|
RequestBodyTooLargeException |
|
RequestId |
An opaque identifier for the request.
|
RequestId.Generator |
Generates, or assigns, an ID for requests.
|
RequestLogger |
A handler that logs information about the request.
|
RequestOutcome |
The outcome of processing a request.
|
RequestSpec |
|
RequestSpec.Body |
The request body.
|
Response |
A response to a request.
|
ResponseChunks |
A renderable object for streaming data with HTTP chunked transfer-encoding.
|
ResponseTimer |
A handler , that adds a "X-Response-Time" header to all requests indicating how long it took to start sending a response in milliseconds.
|
SentResponse |
Represents a response that has been committed.
|
ServerConfig |
The configuration of the server.
|
ServerConfigBuilder |
|
ServerConfigImposition |
An override object for imposing server configuration.
|
ServerErrorHandler |
An object that can deal with errors that occur during the processing of an exchange.
|
ServerSentEvent |
A server sent event.
|
ServerSentEventBuilder |
A server sent event builder.
|
ServerSentEventClient |
A client for request Server Sent Event streams.
|
ServerSentEventResponse |
A response for a server sent event stream.
|
ServerSentEvents |
A renderable object for streaming server side events.
|
ServerSentEventsBuilder |
Creates a builder for a server sent event stream.
|
ServerSentEventStreamClient |
Deprecated.
|
Service |
Deprecated.
|
Service |
A service participates in the application lifecycle.
|
ServiceDependencies |
Specifies dependencies between services.
|
ServiceDependenciesSpec |
Allows declaring which services depend on which services.
|
SSLContexts |
Factory methods for initializing an SSLContext .
|
StartEvent |
Deprecated.
|
StartEvent |
A start event.
|
StartupFailureException |
Thrown when a server fails to start.
|
Status |
A status line of a HTTP response.
|
StopEvent |
Deprecated.
|
StopEvent |
A stop event.
|
Stopper |
The mechanism for stopping the application from within the application.
|
StreamedResponse |
A received response to a http client request with streamed response content.
|
TypedData |
Data that potentially has a content type.
|
UploadedFile |
A file that was uploaded via a form.
|
UserId |
An opaque identifier for the “user” that initiated the request.
|
UserRegistryImposition |
Imposes an extra registry to be joined with the user registry when starting an application.
|
WebSocket |
|
WebSocketClose<T> |
|
WebSocketConnector<T> |
|
WebSocketHandler<T> |
|
WebSocketMessage<T> |
|
WebSockets |
WebSockets support for Ratpack.
|
WebSocketSpec<T> |
|