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

A

Action<T> - Interface in ratpack.util
A generic type for an object that does some work with a thing.
add(String, Object) - Method in interface ratpack.http.MutableHeaders
Adds a new header with the specified name and value.
add(Class<O>, O) - Method in class ratpack.registry.RegistryBuilder
 
add(O) - Method in class ratpack.registry.RegistryBuilder
 
add(Class<O>, Factory<? extends O>) - Method in class ratpack.registry.RegistryBuilder
 
addImpliedDefaults(Properties) - Method in class ratpack.launch.RatpackMain
Subclass hook for adding default property values.
address(InetAddress) - Method in class ratpack.launch.LaunchConfigBuilder
Sets the address to bind to.
ADDRESS - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The address to bind to.
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".
asBool(K) - Method in interface ratpack.util.TypeCoercingMap
Convert the value with given key to a Boolean, using Boolean.valueOf(String).
asByte(K) - Method in interface ratpack.util.TypeCoercingMap
Convert the value with given key to a Byte, using Byte.valueOf(String).
asInt(K) - Method in interface ratpack.util.TypeCoercingMap
Convert the value with given key to a Integer, using Integer.valueOf(String).
asLong(K) - Method in interface ratpack.util.TypeCoercingMap
Convert the value with given key to a Long, using Long.valueOf(String).
assets(String, String...) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that serves static assets at the given file system path, relative to the contextual file system binding.
assets(String, List<String>) - Static method in class ratpack.handling.Handlers
A handler that serves static assets at the given file system path, relative to the contextual file system binding.
asShort(K) - Method in interface ratpack.util.TypeCoercingMap
Convert the value with given key to a Short, using Short.valueOf(String).

B

Background - Interface in ratpack.background
Allows blocking operations to be executed off of a main request handling thread.
background(Callable<T>) - Method in interface ratpack.handling.Context
Perform a blocking operation, off the request thread.
Background.Success<T> - Interface in ratpack.background
A builder for specifying the result handling strategy for a blocking operation that succeeds.
Background.SuccessOrError<T> - Interface in ratpack.background
A builder for specifying the result handling strategy for a blocking operation.
backgroundExecutorService(ExecutorService) - Method in class ratpack.launch.LaunchConfigBuilder
The executor service to use for blocking operations.
baseDir(File) - Static method in class ratpack.launch.LaunchConfigBuilder
Create a new builder, using the given file as the base dir.
baseDir(Path) - Static method in class ratpack.launch.LaunchConfigBuilder
Create a new builder, using the given file as the base dir.
bind(String, PathBinding) - Method in interface ratpack.path.PathBinder
Creates a binding for the given path, if this binder can bind to this path.
BindAddress - Interface in ratpack.server
Represents the address that the server is listening on for requests.
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.
bufferAllocator(ByteBufAllocator) - Method in class ratpack.launch.LaunchConfigBuilder
The allocator to use when creating buffers in the application.
build(HandlerFactory) - Method in class ratpack.launch.LaunchConfigBuilder
Builds the launch config, based on the current state and the handler factory.
build() - Method in class ratpack.registry.RegistryBuilder
 
build(Registry) - Method in class ratpack.registry.RegistryBuilder
 
build(LaunchConfig) - Static method in class ratpack.server.RatpackServerBuilder
Constructs a new server based on the builder's state.
builder() - Static method in class ratpack.registry.RegistryBuilder
 
ByContentHandler - Interface in ratpack.handling
A buildable strategy for responding based on the HTTP "Accepts" request header.
ByMethodHandler - Interface in ratpack.handling
A buildable strategy for processing an exchange based on HTTP method.

C

Chain - Interface in ratpack.handling
A chain can be used to build a linked series of handlers.
chain(Action<? super Chain>) - Method in interface ratpack.handling.Chain
 
chain(LaunchConfig, Action<? super Chain>) - Static method in class ratpack.handling.Handlers
Builds a handler chain, with no backing registry.
chain(LaunchConfig, Registry, Action<? super Chain>) - Static method in class ratpack.handling.Handlers
Builds a chain, backed by the given registry.
chain(List<? extends Handler>) - Static method in class ratpack.handling.Handlers
Creates a handler chain from the given handlers.
chain(Handler...) - Static method in class ratpack.handling.Handlers
Creates a handler chain from the given handlers.
CharSequenceRenderer - Interface in ratpack.render
A renderer for CharSequence objects.
childPath(String) - Method in interface ratpack.path.PathBinding
Constructs a new path using the PathBinding.getBoundTo() value of this binding and the given path.
clear() - Method in interface ratpack.http.MutableHeaders
Removes all headers from this message.
clear() - Method in interface ratpack.util.MultiValueMap
clientError(int) - Method in interface ratpack.handling.Context
Forwards the error to the ClientErrorHandler in this service.
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.websocket.WebSocket
 
CONFIG_RESOURCE_DEFAULT - Static variable in class ratpack.launch.LaunchConfigFactory
 
CONFIG_RESOURCE_PROPERTY - Static variable in class ratpack.launch.LaunchConfigFactory
 
connect() - Method in interface ratpack.websocket.WebSocketBuilder
 
contains(String) - Method in interface ratpack.http.Headers
Checks whether a header has been specified for the given value.
contentType(String) - Method in interface ratpack.http.Response
Sets the response Content-Type header.
Context - Interface in ratpack.handling
The context of an individual Handler invocation.
ContextualException - Interface in ratpack.error
A marker interface to indicate that if an exception has a cause, it is merely providing service.
cookie(String, String) - Method in interface ratpack.http.Response
Creates a new cookie with the given name and value.
create(LaunchConfig) - Method in interface ratpack.launch.HandlerFactory
Creates a handler from the given launch config.
create() - Method in interface ratpack.util.Factory
Creates a new object.
createFromFile(ClassLoader, Path, Path, Properties, Properties) - Static method in class ratpack.launch.LaunchConfigFactory
Delegates to LaunchConfigFactory.createWithBaseDir(ClassLoader, java.nio.file.Path, java.util.Properties), after merging the properties from configFile and overrideProperties.
createFromGlobalProperties(ClassLoader, Properties, Properties) - Static method in class ratpack.launch.LaunchConfigFactory
Delegates to LaunchConfigFactory.createFromGlobalProperties(ClassLoader, String, java.util.Properties, java.util.Properties), extracting the “propertyPrefix” from the “globalProperties”.
createFromGlobalProperties(ClassLoader, String, Properties, Properties) - Static method in class ratpack.launch.LaunchConfigFactory
Delegates to LaunchConfigFactory.createFromProperties(ClassLoader, java.util.Properties, java.util.Properties) after extracting the “prefixed” properties from the global properties.
createFromProperties(ClassLoader, Properties, Properties) - Static method in class ratpack.launch.LaunchConfigFactory
createWithBaseDir(ClassLoader, Path, Properties) - Static method in class ratpack.launch.LaunchConfigFactory
Constructs a launch config, based on the given properties.

D

DEFAULT_MAX_CONTENT_LENGTH - Static variable in interface ratpack.launch.LaunchConfig
The default max content length
DEFAULT_PORT - Static variable in interface ratpack.launch.LaunchConfig
The default port for Ratpack applications, 5050.
delete(Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of DELETE.
delete(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path and the request HTTPMethod is DELETE.
delete(Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the request HTTPMethod is DELETE and the path is at the current root.
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.
DirectChannelAccess - Interface in ratpack.handling.direct
 

E

error(Context, int) - Method in interface ratpack.error.ClientErrorHandler
Handle a client error.
error(Context, Exception) - Method in interface ratpack.error.ServerErrorHandler
Processes the given exception that occurred processing the given context.
error(Exception) - Method in interface ratpack.handling.Context
Forwards the exception to the ServerErrorHandler in this service.
ExceptionUtils - Class in ratpack.util
 
ExceptionUtils() - Constructor for class ratpack.util.ExceptionUtils
 
exec(Callable<T>) - Method in interface ratpack.background.Background
Execute the given operation in a background thread pool, avoiding blocking on a request handling thread.
execute(T) - Method in interface ratpack.util.Action
Executes the action against the given thing.
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

Factory<T> - Interface in ratpack.util
An object that creates another.
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
 
file(String) - Method in interface ratpack.handling.Context
Gets the file relative to the contextual FileSystemBinding.
FileRenderer - Interface in ratpack.file
 
files(String) - Method in interface ratpack.form.Form
 
files() - Method in interface ratpack.form.Form
 
fileSystem(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that changes the FileSystemBinding for the given handler.
fileSystem(String, Action<? super Chain>) - Method in interface ratpack.handling.Chain
 
fileSystem(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.
Form - Interface in ratpack.form
 
form() - Static method in class ratpack.form.Forms
 
FormParse - Interface in ratpack.form
 
FormParser - Interface in ratpack.form
 
Forms - Class in ratpack.form
 
Forms() - Constructor for class ratpack.form.Forms
 

G

get(Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of GET.
get(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path and the request HTTPMethod is GET.
get(Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the request HTTPMethod is GET and the path is at the current root.
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(String) - Method in interface ratpack.http.Headers
Returns the header value with the specified header name.
get(Class<O>) - Method in interface ratpack.registry.Registry
Provides an object of the specified type, or throws an exception if no object of that type is available.
get(Object) - Method in interface ratpack.util.MultiValueMap
Get the first value for the key, or null if there are no values for the key.
getAddress() - Method in interface ratpack.launch.LaunchConfig
The address of the interface that the application should bind to.
getAddress(Context) - Method in interface ratpack.server.PublicAddress
The advertised public address.
getAll(String) - Method in interface ratpack.http.Headers
Returns all of the header values with the specified header name.
getAll(Class<O>) - Method in interface ratpack.registry.Registry
 
getAll(K) - Method in interface ratpack.util.MultiValueMap
All of the values for the given key.
getAll() - Method in interface ratpack.util.MultiValueMap
Returns a new view of the map where each map value is a list of all the values for the given key (i.e.
getAllPathTokens() - Method in interface ratpack.handling.Context
The contextual path tokens of the current PathBinding.
getAllTokens() - Method in interface ratpack.path.PathBinding
Similar to PathBinding.getTokens() except that tokens of all parent bindings are included.
getBackground() - Method in interface ratpack.handling.Context
An object to be used when executing blocking IO, or long operations.
getBackgroundExecutorService() - Method in interface ratpack.launch.LaunchConfig
The executor service to use to perform background operations.
getBaseDir() - Method in interface ratpack.launch.LaunchConfig
The base dir of the application, which is also the initial FileSystemBinding.
getBindAddress() - Method in interface ratpack.handling.Context
The address that this request was received on.
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.Response
The (mutable) buffer that is the body to be sent.
getBoundTo() - Method in interface ratpack.path.PathBinding
The path of the request path that was bound to.
getBuffer() - Method in interface ratpack.form.UploadedFile
 
getBuffer() - Method in interface ratpack.http.Request
 
getBuffer() - Method in interface ratpack.http.RequestBody
 
getBufferAllocator() - Method in interface ratpack.launch.LaunchConfig
The allocator for buffers needed by the application.
getByContent() - Method in interface ratpack.handling.Context
A buildable handler useful for performing content negotiation.
getByMethod() - Method in interface ratpack.handling.Context
A buildable handler for conditional processing based on the HTTP request method.
getBytes() - Method in interface ratpack.form.UploadedFile
 
getBytes() - Method in interface ratpack.http.Request
The request body as bytes.
getBytes() - Method in interface ratpack.http.RequestBody
 
getChannel() - Method in interface ratpack.handling.direct.DirectChannelAccess
 
getCharset() - Method in interface ratpack.http.MediaType
The value of the "charset" parameter, or the HTTP default of "ISO-8859-1".
getClosedAt() - Method in interface ratpack.handling.RequestOutcome
 
getCode() - Method in interface ratpack.http.Status
The status code.
getConnection() - Method in interface ratpack.websocket.WebSocketMessage
 
getContentType(String) - Method in interface ratpack.file.MimeTypes
Calculate the mime type for the given file.
getContentType() - Method in interface ratpack.form.UploadedFile
 
getContentType() - Method in interface ratpack.http.Request
A structured representation of the "Content-Type" header value of the request.
getContentType() - Method in interface ratpack.parse.Parser
The content type that this parser knows how to deserialize.
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.
getDate(String) - Method in interface ratpack.http.Headers
Returns the header value as a date with the specified header name.
getDefaultPrefixedProperties() - Static method in class ratpack.launch.LaunchConfigFactory
Extracts the properties prefixed with "ratpack." from the system properties, without the prefix.
getDirectChannelAccess() - Method in interface ratpack.handling.Context
 
getFailure() - Method in class ratpack.util.Result
The failure exception.
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
 
getForegroundExecutorService() - Method in interface ratpack.handling.Context
 
getHandlerFactory() - Method in interface ratpack.launch.LaunchConfig
The handler factory that can create the root handler for the application.
getHeaders() - Method in interface ratpack.http.Request
The request headers.
getHeaders() - Method in interface ratpack.http.Response
The response headers.
getHost() - Method in interface ratpack.server.BindAddress
The host name.
getIndexFiles() - Method in interface ratpack.launch.LaunchConfig
The names of files that can be served if a request is made to serve a directory.
getInputStream() - Method in interface ratpack.http.Request
Provides an input stream of the request body.
getInputStream() - Method in interface ratpack.http.RequestBody
 
getLaunchConfig() - Method in interface ratpack.handling.Chain
The launch config of the application that this chain is being created for.
getLaunchConfig() - Method in interface ratpack.server.RatpackServer
The (read only) configuration that was used to launch this server.
getMainThreads() - Method in interface ratpack.launch.LaunchConfig
The number of threads for handling application requests.
getMaxContentLength() - Method in interface ratpack.launch.LaunchConfig
The max content length to use for the HttpObjectAggregator
getMessage() - Method in interface ratpack.http.Status
The message of the status.
getMethod() - Method in interface ratpack.http.Request
The method of the request.
getName() - Method in interface ratpack.http.HttpMethod
The name of the method, always in upper case.
getNames() - Method in interface ratpack.http.Headers
All header names.
getOpenResult() - Method in interface ratpack.websocket.WebSocketClose
 
getOpenResult() - Method in interface ratpack.websocket.WebSocketMessage
 
getOther(String, String) - Method in interface ratpack.launch.LaunchConfig
Provides access to any "other" properties that were specified.
getParams() - Method in interface ratpack.http.MediaType
The parameters of the mime type.
getParsedType() - Method in interface ratpack.parse.Parser
The type that this parser can deserialize to.
getParsedType() - Method in class ratpack.parse.ParserSupport
 
getParseType() - Method in interface ratpack.parse.Parser
The type of the Parse object for this parser.
getParseType() - Method in class ratpack.parse.ParserSupport
 
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.http.Request
The URI without the query string and leading forward slash.
getPathTokens() - Method in interface ratpack.handling.Context
The contextual path tokens of the current PathBinding.
getPort() - Method in interface ratpack.launch.LaunchConfig
The port that the application should listen to requests on.
getPort() - Method in interface ratpack.server.BindAddress
The port number.
getPublicAddress() - Method in interface ratpack.launch.LaunchConfig
The public address of the site used for redirects.
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.
getRegistry() - Method in interface ratpack.handling.Chain
The registry that backs this GroovyChain.
getRequest() - Method in interface ratpack.handling.Context
The HTTP request.
getRequest() - Method in interface ratpack.handling.RequestOutcome
 
getResponse() - Method in interface ratpack.handling.Context
The HTTP response.
getResponse() - Method in interface ratpack.handling.RequestOutcome
 
getScheme() - Method in interface ratpack.server.RatpackServer
The URL scheme the server uses.
getSSLContext() - Method in interface ratpack.launch.LaunchConfig
The SSL context to use if the application will serve content over HTTPS.
getStatus() - Method in interface ratpack.http.Response
The status that will be part of the response when sent.
getText() - Method in interface ratpack.form.UploadedFile
 
getText() - Method in interface ratpack.http.Request
The request body as text.
getText() - Method in interface ratpack.http.RequestBody
 
getText() - Method in interface ratpack.websocket.WebSocketMessage
 
getTokens() - Method in interface ratpack.path.PathBinding
Any tokens that the binding has extracted from the path.
getType() - Method in interface ratpack.http.MediaType
The type without parameters.
getType() - Method in class ratpack.parse.NoOptionParse
 
getType() - Method in interface ratpack.parse.Parse
 
getType() - Method in class ratpack.parse.ParseSupport
 
getType() - Method in interface ratpack.render.Renderer
The type of object that this renderer can render.
getType() - Method in class ratpack.render.RendererSupport
The type of object that this renderer can render (the type for T).
getUri() - Method in interface ratpack.http.Request
The complete URI of the request (path + query string).
getValue() - Method in class ratpack.util.Result
The result value.
getVersion() - Static method in class ratpack.util.RatpackVersion
The version of Ratpack.

H

handle(Context) - Method in interface ratpack.handling.Handler
Handles the context.
handle(Context) - Method in class ratpack.handling.ServiceUsingHandler
Invokes the custom "handle" method, extracting necessary parameters from the context to satisfy the call.
handler(Handler) - Method in interface ratpack.handling.Chain
Adds the given Handler to this GroovyChain.
handler(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path exactly.
Handler - Interface in ratpack.handling
A handler participates in the processing of a request/response pair, operating on a Context.
HANDLER_FACTORY - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The full qualified classname of the handler factory (required).
HandlerFactory - Interface in ratpack.launch
A factory contract for creating handlers, typically the root handler of the application.
Handlers - Class in ratpack.handling
Factory methods for handler decorations.
header(String, String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to the chain that delegates to the given handler if the request has a header with the given name and a its value matches the given value exactly.
header(String, String, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that delegates to the given handler if the request has a HTTPHeader with the given name and a it's value matches the given value exactly.
Headers - Interface in ratpack.http
An immutable set of HTTP headers.
html(Runnable) - Method in interface ratpack.handling.ByContentHandler
Convenience method to respond with "text/html" mime type.
HttpMethod - Interface in ratpack.http
The method of a HTTP request.

I

INDEX_FILES - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The comma separated list of file names of files that can be served in place of a directory.
indexFiles(String...) - Method in class ratpack.launch.LaunchConfigBuilder
Adds the given values as potential index file names.
indexFiles(List<String>) - Method in class ratpack.launch.LaunchConfigBuilder
Adds the given values as potential index file names.
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.
insert(Class<T>, Factory<? extends T>, Handler...) - Method in interface ratpack.handling.Context
Inserts some handlers into the pipeline to execute with the given object created by the factory made available, then delegates to the first.
insert(Class<P>, T, Handler...) - Method in interface ratpack.handling.Context
Inserts some handlers into the pipeline to execute with the given object made available, then delegates to the first.
insert(Object, Handler...) - Method in interface ratpack.handling.Context
Inserts some handlers into the pipeline to execute with the the given object added to the service, then delegates to the first.
isDelete() - Method in interface ratpack.http.HttpMethod
True if the method is DELETE.
isEmpty() - Method in interface ratpack.http.MediaType
True if this represents the absence of a value (i.e.
isFailure() - Method in class ratpack.util.Result
True if this was a failure result.
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.
isHead() - Method in interface ratpack.http.HttpMethod
True if the method is HEAD.
isHtml() - Method in interface ratpack.http.MediaType
True if this type equals "text/html".
isJson() - Method in interface ratpack.http.MediaType
True if this type equals "application/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.
isReloadable() - Method in interface ratpack.launch.LaunchConfig
Whether or not the server is in "reloadable" (i.e.
isRunning() - Method in interface ratpack.server.RatpackServer
Returns true if the server is running.
isSuccess() - Method in class ratpack.util.Result
True if this was a success result.
isText() - Method in interface ratpack.http.MediaType
True if this type starts with "text/".

J

join(Registry, Registry) - Static method in class ratpack.registry.RegistryBuilder
 
json(Runnable) - Method in interface ratpack.handling.ByContentHandler
Convenience method to respond with "application/json" mime type.

L

lastModified(Date, Runnable) - Method in interface ratpack.handling.Context
Convenience method for handling last-modified based HTTP caching.
LaunchConfig - Interface in ratpack.launch
The configuration used to launch a server.
LaunchConfigBuilder - Class in ratpack.launch
A builder for LaunchConfig objects.
LaunchConfigFactory - Class in ratpack.launch
Static factory methods for creating LaunchConfig objects using various strategies.
LaunchConfigFactory.Property - Class in ratpack.launch
Constants for meaningful configuration properties.
LaunchException - Exception in ratpack.launch
Thrown if something goes wrong at launch time.
LaunchException(String) - Constructor for exception ratpack.launch.LaunchException
Constructor.
LaunchException(String, Throwable) - Constructor for exception ratpack.launch.LaunchException
Constructor.

M

main(String[]) - Static method in class ratpack.launch.RatpackMain
Starts a Ratpack application, by creating a new instance of this class and calling RatpackMain.start().
MAIN_THREADS - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The number of worker threads to use.
mainThreads(int) - Method in class ratpack.launch.LaunchConfigBuilder
How many request handling threads to use.
MAX_CONTENT_LENGTH - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The max conent lenght.
maxContentLength(int) - Method in class ratpack.launch.LaunchConfigBuilder
The max content length.
maxLength(int) - Method in interface ratpack.websocket.WebSocketBuilder
 
maybeGet(Class<O>) - Method in interface ratpack.registry.Registry
Does the same thing as Registry.get(Class), except returns null instead of throwing an exception.
MediaType - Interface in ratpack.http
A structured value for a Content-Type header value.
MimeTypes - Interface in ratpack.file
A registry for mime types.
MultiValueMap<K,V> - Interface in ratpack.util
A map that may contain multiple values for a given key, but typically only one value.
MutableHeaders - Interface in ratpack.http
A set of HTTP headers that can be changed.
MutableRegistry<T> - Interface in ratpack.registry
A Registry that is also mutable.

N

name(String) - Method in interface ratpack.http.HttpMethod
Returns true if the method has the given name, insensitive to case.
named(String, Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of methodName.
next() - Method in interface ratpack.handling.Context
Delegate handling to the next handler in line.
next(Registry) - Method in interface ratpack.handling.Context
 
next(Class<P>, T) - Method in interface ratpack.handling.Context
 
next(Class<T>, Factory<? extends T>) - Method in interface ratpack.handling.Context
 
next(Object) - Method in interface ratpack.handling.Context
 
next() - Static method in class ratpack.handling.Handlers
A handler that simply delegates to the next handler.
NonBlocking - Annotation Type in ratpack.api
Declares that a method is non blocking, making no guarantees about when it will return.
NoOptionParse<T> - Class in ratpack.parse
 
NoOptionParse(Class<T>) - Constructor for class ratpack.parse.NoOptionParse
 
NoSuchRendererException - Exception in ratpack.render
Thrown when a request is made to render an object, but no suitable renderer can be found.
NoSuchRendererException(String) - Constructor for exception ratpack.render.NoSuchRendererException
Constructor.
NotInRegistryException - Exception in ratpack.registry
Thrown when a request is made for an object that a registry cannot provide.
NotInRegistryException(Class<?>) - Constructor for exception ratpack.registry.NotInRegistryException
Constructs the exception.
NotInRegistryException(String) - Constructor for exception ratpack.registry.NotInRegistryException
Constructor.
Nullable - Annotation Type in ratpack.api
Denotes that something may be null.

O

onClose(Action<? super RequestOutcome>) - Method in interface ratpack.handling.Context
 
onClose(Action<WebSocketClose<T>>) - Method in interface ratpack.websocket.WebSocketBuilder
 
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.background.Background.SuccessOrError
Specifies the action to take should an error occur during the blocking operation.
onMessage(Action<WebSocketMessage<T>>) - Method in interface ratpack.websocket.WebSocketBuilder
 
onMessage(WebSocketMessage<T>) - Method in interface ratpack.websocket.WebSocketHandler
 
onOpen(WebSocket) - Method in interface ratpack.websocket.WebSocketHandler
 
other(String, String) - Method in class ratpack.launch.LaunchConfigBuilder
Add an "other" property.
other(Map<String, String>) - Method in class ratpack.launch.LaunchConfigBuilder
Add some "other" properties.

P

parse(Parse<T>) - Method in interface ratpack.handling.Context
 
Parse<T> - Interface in ratpack.parse
 
parse(Context, RequestBody, P) - Method in interface ratpack.parse.Parser
Deserializes the request body of the context into an object.
Parser<T,P extends Parse<T>> - Interface in ratpack.parse
A parser is able to deserialize the body of a request into an object representation.
ParserSupport<T,P extends Parse<T>> - Class in ratpack.parse
 
ParserSupport() - Constructor for class ratpack.parse.ParserSupport
 
ParseSupport<T> - Class in ratpack.parse
 
ParseSupport() - Constructor for class ratpack.parse.ParseSupport
 
patch(Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of PATCH.
patch(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path and the request HTTPMethod is PATCH.
patch(Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the request HTTPMethod is PATCH and the path is at the current root.
patch() - Static method in class ratpack.handling.Handlers
A handler that delegates to the next handler if the request is PATCH, otherwise raises a 405 client error.
path(String, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that delegates to the given handlers if the request matches the given path exactly.
path(PathBinder, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that delegates to the given handlers if the request can be bound by the given path binder.
path(String) - Method in interface ratpack.websocket.WebSocketBuilder
 
PathBinder - Interface in ratpack.path
A path binder binds to a request path, extracting information from it.
PathBinding - Interface in ratpack.path
A path binding represents some kind of "match" on the path of a request.
PathTokens - Interface in ratpack.path
A marker interface for the contextual object that represents the tokens extracted from the request path.
plainText(Runnable) - Method in interface ratpack.handling.ByContentHandler
Convenience method to respond with "text/plain" mime type.
port(int) - Method in class ratpack.launch.LaunchConfigBuilder
Sets the port to bind to.
PORT - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The port to listen for requests on.
post(Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of POST.
post(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path and the request HTTPMethod is POST.
post(Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the request HTTPMethod is POST and the path is at the current root.
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.
prefix(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given handlers if the relative path starts with the given prefix.
prefix(String, Action<? super Chain>) - Method in interface ratpack.handling.Chain
 
prefix(String, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that delegates to the given handlers if the request path starts with the given prefix.
PUBLIC_ADDRESS - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The public address of the site.
publicAddress(URI) - Method in class ratpack.launch.LaunchConfigBuilder
The public address of the application.
PublicAddress - Interface in ratpack.server
The advertised public address.
put(Runnable) - Method in interface ratpack.handling.ByMethodHandler
Defines the action to to take if the request has a HTTP method of PUT.
put(String, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the relative path matches the given path and the request HTTPMethod is PUT.
put(Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that delegates to the given Handler if the request HTTPMethod is PUT and the path is at the current root.
put() - Static method in class ratpack.handling.Handlers
A handler that delegates to the next handler if the request is PUT, otherwise raises a 405 client error.
put(K, V) - Method in interface ratpack.util.MultiValueMap
putAll(Map<? extends K, ? extends V>) - Method in interface ratpack.util.MultiValueMap

R

ratpack.api - package ratpack.api
Annotations that are used to further specify API contracts.
ratpack.background - package ratpack.background
Mechanisms for executing operations that performing operations in the background (i.e.
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
 
ratpack.handling - package ratpack.handling
The handling of application requests.
ratpack.handling.direct - package ratpack.handling.direct
 
ratpack.http - package ratpack.http
The HTTP protocol.
ratpack.launch - package ratpack.launch
Classes used to bootstrap a Ratpack application.
ratpack.parse - package ratpack.parse
 
ratpack.path - package ratpack.path
Types for managing the paths of requests inside the application.
ratpack.registry - package ratpack.registry
Handlers communicate with each other by binding a "service" on to each Context.
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.ssl - package ratpack.ssl
 
ratpack.util - package ratpack.util
General purpose types and utilities.
ratpack.websocket - package ratpack.websocket
 
RatpackMain - Class in ratpack.launch
An application entry point for starting a Ratpack application.
RatpackMain() - Constructor for class ratpack.launch.RatpackMain
 
RatpackServer - Interface in ratpack.server
A Ratpack server.
RatpackServerBuilder - Class in ratpack.server
Builds a RatpackServer.
RatpackVersion - Class in ratpack.util
Provides the version of the Ratpack core at runtime.
redirect(String) - Method in interface ratpack.handling.Context
Sends a temporary redirect response (i.e.
redirect(int, String) - Method in interface ratpack.handling.Context
Sends a redirect response location URL and status code (which should be in the 3xx range).
redirect(Context, String, int) - Method in interface ratpack.handling.Redirector
Issue a redirect to the client.
Redirector - Interface in ratpack.handling
Contextual strategy for issuing redirects.
register(Object, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that inserts the given handler with the given service addition.
register(Object, Action<? super Chain>) - Method in interface ratpack.handling.Chain
 
register(Class<? super T>, T, Handler) - Method in interface ratpack.handling.Chain
Adds a Handler to this GroovyChain that inserts the given handlers with the given service addition.
register(Class<? super T>, T, Action<? super Chain>) - Method in interface ratpack.handling.Chain
 
register(T, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that inserts the handler chain defined by the builder, with the given service addition.
register(Class<? super T>, T, Handler) - Static method in class ratpack.handling.Handlers
Creates a handler that inserts the handler chain defined by the builder, with the given service addition.
register(Class<O>, O) - Method in interface ratpack.registry.MutableRegistry
Register the given object under the given type.
register(T) - Method in interface ratpack.registry.MutableRegistry
Registers the given object with its concrete type.
Registry - Interface in ratpack.registry
An object that can potentially provide objects of given types.
RegistryBuilder - Class in ratpack.registry
 
reloadable(boolean) - Method in class ratpack.launch.LaunchConfigBuilder
Whether or not the application is "reloadable".
RELOADABLE - Static variable in class ratpack.launch.LaunchConfigFactory.Property
Whether to reload the application if the script changes at runtime.
remove(String) - Method in interface ratpack.http.MutableHeaders
Removes the header with the specified name.
remove(Class<O>) - Method in interface ratpack.registry.MutableRegistry
Remove the registration for the given type.
remove(Object) - Method in interface ratpack.util.MultiValueMap
render(Object) - Method in interface ratpack.handling.Context
Render the given object, using the rendering framework.
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.
Renderer<T> - Interface in ratpack.render
A renderer is responsible for rendering an object to the response.
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
Constructor.
RendererSupport(Class<?>) - Constructor for class ratpack.render.RendererSupport
Constructor.
Request - Interface in ratpack.http
A request to be handled.
RequestBody - Interface in ratpack.http
 
RequestOutcome - Interface in ratpack.handling
 
respond(Handler) - Method in interface ratpack.handling.Context
Convenience method for delegating to a single handler.
Response - Interface in ratpack.http
A response to a request.
Result<T> - Class in ratpack.util
The result of an asynchronous operation, which may be a failure.
Result(Exception) - Constructor for class ratpack.util.Result
Creates a failure result object.
Result(Y) - Constructor for class ratpack.util.Result
Creates a successful result object.
resultAction(Action<T>) - Method in interface ratpack.handling.Context
Creates a result action that uses the contextual error handler if the result is failure.
ResultAction<T> - Interface in ratpack.util
Convenience subtype for an action that takes a result.

S

send() - Method in interface ratpack.http.Response
Sends the response back to the client, with no body.
send(String) - Method in interface ratpack.http.Response
Sends the response, using "text/plain" as the content type and the given string as the response body.
send(String, String) - Method in interface ratpack.http.Response
Sends the response, using the given content type and string as the response body.
send(byte[]) - Method in interface ratpack.http.Response
Sends the response, using "application/octet-stream" as the content type (if a content type hasn't already been set) and the given byte array as the response body.
send(String, byte[]) - Method in interface ratpack.http.Response
Sends the response, using the given content type and byte array as the response body.
send(InputStream) - 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 contents of the given input stream as the response body.
send(String, InputStream) - Method in interface ratpack.http.Response
Sends the response, using the given content type and the content of the given input stream 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(String, ByteBuf) - Method in interface ratpack.http.Response
Sends the response, using the given content type and bytes as the response body.
send(String) - Method in interface ratpack.websocket.WebSocket
 
sendFile(Background, String, Path) - Method in interface ratpack.http.Response
Sends the response, using the given content type and the content of the given type as the response body.
sendFile(Background, String, BasicFileAttributes, Path) - Method in interface ratpack.http.Response
Sends the response, using the given content type and the content of the given type as the response body.
server(Properties, Properties) - Method in class ratpack.launch.RatpackMain
ServerErrorHandler - Interface in ratpack.error
An object that can deal with errors that occur during the processing of an exchange.
ServiceUsingHandler - Class in ratpack.handling
Convenience handler super class that provides syntactic sugar for accessing contextual objects.
ServiceUsingHandler() - Constructor for class ratpack.handling.ServiceUsingHandler
Constructor.
ServiceUsingHandler.NoSuitableHandleMethodException - Exception in ratpack.handling
Exception thrown if the subclass doesn't provide a valid handle method.
set(String, Object) - Method in interface ratpack.http.MutableHeaders
Sets the (only) value for the header with the specified name.
set(String, Iterable<?>) - Method in interface ratpack.http.MutableHeaders
Sets a new header with the specified name and values.
set(int) - Method in interface ratpack.http.Status
Update the status to be the given code, and the default message for that code.
set(int, String) - Method in interface ratpack.http.Status
Update the status to be the given code and message.
setDate(String, Date) - Method in interface ratpack.http.MutableHeaders
Set a header with the given date as the value.
ssl(InputStream, String) - Method in class ratpack.launch.LaunchConfigBuilder
A convenience method for configuring an SSL context using a password-protected keystore file.
ssl(URL, String) - Method in class ratpack.launch.LaunchConfigBuilder
A convenience method for configuring an SSL context using a password-protected keystore file.
ssl(File, String) - Method in class ratpack.launch.LaunchConfigBuilder
A convenience method for configuring an SSL context using a password-protected keystore file.
SSL_KEYSTORE_FILE - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The absolute file path, URI or classpath location of the SSL keystore file.
SSL_KEYSTORE_PASSWORD - Static variable in class ratpack.launch.LaunchConfigFactory.Property
The password for the SSL keystore file.
sslContext(SSLContext) - Method in class ratpack.launch.LaunchConfigBuilder
The SSL context to use if the application serves content over HTTPS.
sslContext(URL, String) - Static method in class ratpack.ssl.SSLContexts
Creates an SSL context using a password-protected keystore file.
sslContext(File, String) - Static method in class ratpack.ssl.SSLContexts
Creates an SSL context using a password-protected keystore file.
sslContext(InputStream, String) - Static method in class ratpack.ssl.SSLContexts
Creates an SSL context using a password-protected keystore file.
SSLContexts - Class in ratpack.ssl
Factory methods for initializing an SSLContext.
start() - Method in class ratpack.launch.RatpackMain
start() - Method in interface ratpack.server.RatpackServer
Starts the server, returning as soon as the server is up and ready to receive requests.
status(int) - Method in interface ratpack.http.Response
Sets the status line of the response.
status(int, String) - 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.
Stopper - Interface in ratpack.server
The mechanism for stopping the application from within the application.
SYSPROP_PREFIX_DEFAULT - Static variable in class ratpack.launch.LaunchConfigFactory
Value: "ratpack.".
SYSPROP_PREFIX_PROPERTY - Static variable in class ratpack.launch.LaunchConfigFactory
Value: "ratpack.syspropPrefix".

T

takeOwnership(Action<Object>) - Method in interface ratpack.handling.direct.DirectChannelAccess
 
TEXT_HTML - Static variable in interface ratpack.http.MediaType
"text/html".
then(Action<? super T>) - Method in interface ratpack.background.Background.Success
Specifies the success handler, and actually starts the process of having the blocking operation execute.
toException(Throwable) - Static method in class ratpack.util.ExceptionUtils
 
toType(Class<T>) - Static method in class ratpack.parse.NoOptionParse
 
transform(F) - Method in interface ratpack.util.Transformer
Transforms the given object into a different object.
Transformer<F,T> - Interface in ratpack.util
An object that transforms an object into another.
type(String, Runnable) - Method in interface ratpack.handling.ByContentHandler
Register how to respond with the given mime type.
TypeCoercingMap<K> - Interface in ratpack.util
A string valued map that can do simple type conversions from the string values to primitive types.

U

uncheck(Throwable) - Static method in class ratpack.util.ExceptionUtils
 
UploadedFile - Interface in ratpack.form
 

W

WebSocket - Interface in ratpack.websocket
 
websocket(Context, Transformer<WebSocket, T>) - Static method in class ratpack.websocket.WebSockets
 
websocket(Context, WebSocketHandler<?>) - Static method in class ratpack.websocket.WebSockets
 
WebSocketBuilder<T> - Interface in ratpack.websocket
 
WebSocketClose<T> - Interface in ratpack.websocket
 
WebSocketHandler<T> - Interface in ratpack.websocket
 
WebSocketMessage<T> - Interface in ratpack.websocket
 
WebSockets - Class in ratpack.websocket
 
WebSockets() - Constructor for class ratpack.websocket.WebSockets
 
withErrorHandling(Runnable) - Method in interface ratpack.handling.Context
Executes the given runnable in a try/catch, where exceptions are given to Context.error(Exception).
writeBodyTo(OutputStream) - Method in interface ratpack.http.Request
Writes the request body bytes to the given output stream.
writeTo(OutputStream) - Method in interface ratpack.http.RequestBody
 

X

xml(Runnable) - Method in interface ratpack.handling.ByContentHandler
Convenience method to respond with "application/xml" mime type.
A B C D E F G H I J L M N O P R S T U W X