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

R

rateUnit(TimeUnit) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Slf4j
Convert rates to the given time unit.
rateUnit(TimeUnit) - Method in class ratpack.codahale.metrics.Graphite
Convert rates to the given time unit.
ratpack(Closure<?>) - Static method in class ratpack.groovy.Groovy
Starts a Ratpack app, defined by the given closure.
ratpack.api - package ratpack.api
Annotations that are used to further specify API contracts.
ratpack.auth - package ratpack.auth
 
ratpack.codahale.metrics - package ratpack.codahale.metrics
Integration with Coda Hale's Metrics Library.
ratpack.config - package ratpack.config
Provides the ability to access configuration data from a variety of sources, such as YAML, JSON, properties files, system properties, and environment variables.
ratpack.error - package ratpack.error
Types that deal with handling application errors.
ratpack.exec - package ratpack.exec
The execution management.
ratpack.file - package ratpack.file
Types for dealing with the file system and serving files.
ratpack.file.checksummer - package ratpack.file.checksummer
 
ratpack.form - package ratpack.form
Support for handling uploaded forms, including file uploads.
ratpack.func - package ratpack.func
General functional (i.e. Single Abstract Method) types.
ratpack.groovy - package ratpack.groovy
Support for writing Ratpack applications in the Groovy programming language.
ratpack.groovy.handling - package ratpack.groovy.handling
Groovy specific extensions to classes in the ratpack.handling package.
ratpack.groovy.render - package ratpack.groovy.render
Specialised Groovy support for rendering.
ratpack.groovy.script - package ratpack.groovy.script
 
ratpack.groovy.server - package ratpack.groovy.server
 
ratpack.groovy.sql - package ratpack.groovy.sql
Support for providing Groovy's Sql interface.
ratpack.groovy.template - package ratpack.groovy.template
Support for templating based on embedded Groovy code in text.
ratpack.groovy.test - package ratpack.groovy.test
 
ratpack.groovy.test.embed - package ratpack.groovy.test.embed
Support for creating Groovy based embedded applications.
ratpack.groovy.test.handling - package ratpack.groovy.test.handling
 
ratpack.guice - package ratpack.guice
Integration with Google Guice.
ratpack.h2 - package ratpack.h2
Provides integration with H2.
ratpack.handlebars - package ratpack.handlebars
Integration with Handlebars.java templating engine.
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.hikari - package ratpack.hikari
Provides integration with HikariCP library.
ratpack.http - package ratpack.http
The HTTP protocol.
ratpack.http.client - package ratpack.http.client
The HTTP client.
ratpack.hystrix - package ratpack.hystrix
Provides integration with the Hystrix library.
ratpack.jackson - package ratpack.jackson
Integration with the Jackson JSON marshalling library.
ratpack.jackson.guice - package ratpack.jackson.guice
ratpack.logging - package ratpack.logging
 
ratpack.newrelic - package ratpack.newrelic
Provides integration with New Relic.
ratpack.pac4j - package ratpack.pac4j
Integration with pac4j for authentication/authorization.
ratpack.parse - package ratpack.parse
Parsing in Ratpack refers to deserializing a request body into a Java object of some type.
ratpack.path - package ratpack.path
Types for managing the paths of requests inside the application.
ratpack.registry - package ratpack.registry
Registries hold objects that can be retrieved via type, and are a key aspect of Ratpack applications.
ratpack.remote - package ratpack.remote
Integration with Groovy Remote Control.
ratpack.render - package ratpack.render
The renderer framework provides a pluggable mechanism for serializing objects to the response.
ratpack.rx - package ratpack.rx
Provides integration with the RxJava library.
ratpack.server - package ratpack.server
Objects used to start a ratpack application.
ratpack.session - package ratpack.session
Objects for providing Session support
ratpack.session.clientside - package ratpack.session.clientside
Support for Client Side Session.
ratpack.spring - package ratpack.spring
Provides integration with Spring Boot.
ratpack.spring.config - package ratpack.spring.config
 
ratpack.sse - package ratpack.sse
Support for Server Sent Events.
ratpack.ssl - package ratpack.ssl
Convenience utitilities for dealing with SSL.
ratpack.stream - package ratpack.stream
Support for reactive streams.
ratpack.test - package ratpack.test
 
ratpack.test.embed - package ratpack.test.embed
Support for creating embedded applications at test time, for testing Ratpack features and extensions.
ratpack.test.exec - package ratpack.test.exec
 
ratpack.test.handling - package ratpack.test.handling
 
ratpack.test.http - package ratpack.test.http
 
ratpack.test.remote - package ratpack.test.remote
 
ratpack.thymeleaf - package ratpack.thymeleaf
Integration with Thymeleaf templating engine.
ratpack.util - package ratpack.util
General purpose types and utilities.
ratpack.websocket - package ratpack.websocket
Support for Websockets.
RATPACK_METRIC_REGISTRY - Static variable in class ratpack.codahale.metrics.CodaHaleMetricsModule
 
RatpackConfiguration - Class in ratpack.spring.config
 
RatpackConfiguration() - Constructor for class ratpack.spring.config.RatpackConfiguration
 
RatpackConfiguration.ServerConfigConfiguration - Class in ratpack.spring.config
 
RatpackConfiguration.ServerConfiguration - Class in ratpack.spring.config
 
RatpackPac4j - Class in ratpack.pac4j
Provides integration with the Pac4j library for authentication and authorization.
RatpackProperties - Class in ratpack.spring.config
 
RatpackProperties() - Constructor for class ratpack.spring.config.RatpackProperties
 
RatpackServer - Interface in ratpack.server
The entry point for creating and starting a Ratpack application.
ratpackServer(ApplicationContext) - Method in class ratpack.spring.config.RatpackConfiguration.ServerConfiguration
 
ratpackServerConfig() - Method in class ratpack.spring.config.RatpackConfiguration.ServerConfigConfiguration
 
RatpackServerCustomizer - Interface in ratpack.spring.config
 
RatpackServerCustomizerAdapter - Class in ratpack.spring.config
 
RatpackServerCustomizerAdapter() - Constructor for class ratpack.spring.config.RatpackServerCustomizerAdapter
 
RatpackServerSpec - Interface in ratpack.server
A buildable specification of a Ratpack server.
RatpackVersion - Class in ratpack.util
Provides the version of the Ratpack core at runtime.
readTimeout(Duration) - Method in interface ratpack.http.client.RequestSpec
 
readTimeoutSeconds(int) - Method in interface ratpack.http.client.RequestSpec
 
receiveBufferSize(int) - Method in interface ratpack.server.ServerConfigBuilder
ReceivedResponse - Interface in ratpack.http.client
 
redirect(int, String) - Method in interface ratpack.groovy.handling.GroovyChain
Sends an HTTP redirect to the specified location.
redirect(int, String) - Method in interface ratpack.handling.Chain
Sends an HTTP redirect to the specified location.
redirect(String) - Method in interface ratpack.handling.Context
Sends a temporary redirect response (i.e.
redirect(int, String) - Method in interface ratpack.handling.Context
Sends a redirect response location URL and status code (which should be in the 3xx range).
redirect(int, String) - Static method in class ratpack.handling.Handlers
Creates a handler that always issues a redirect using Context.redirect(int, String) with exactly the given code and location.
redirect(Context, String, int) - Method in interface ratpack.handling.Redirector
Issue a redirect to the client.
Redirector - Interface in ratpack.handling
Contextual strategy for issuing redirects.
redirects(int) - Method in interface ratpack.http.client.RequestSpec
The maximum number of redirects to automatically follow, before simply returning the redirect response.
register(Action<? super RegistrySpec>) - Method in interface ratpack.exec.ExecBuilder
Populates the execution's registry.
register(Registry) - Method in interface ratpack.groovy.handling.GroovyChain
Makes the contents of the given registry available for downstream handlers of the same nesting level.
register(Action<? super RegistrySpec>) - Method in interface ratpack.groovy.handling.GroovyChain
Builds a new registry via the given action, then registers it via Chain.register(Registry).
register(Registry, Action<? super Chain>) - Method in interface ratpack.groovy.handling.GroovyChain
Adds a handler that inserts the given handler chain with the given registry via Context.insert(ratpack.registry.Registry, Handler...).
register(Registry, Class<? extends Action<? super Chain>>) - Method in interface ratpack.groovy.handling.GroovyChain
register(Action<? super RegistrySpec>, Action<? super Chain>) - Method in interface ratpack.groovy.handling.GroovyChain
Adds a handler that inserts the given handler chain with a registry built by the given action via Context.insert(ratpack.registry.Registry, Handler...).
register(Action<? super RegistrySpec>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.groovy.handling.GroovyChain
register(Action<? super RegistrySpec>, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain
 
register(Registry, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain
 
register(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain
 
register(Registry) - Method in interface ratpack.handling.Chain
Makes the contents of the given registry available for downstream handlers of the same nesting level.
register(Action<? super RegistrySpec>) - Method in interface ratpack.handling.Chain
Builds a new registry via the given action, then registers it via Chain.register(Registry).
register(Registry, Action<? super Chain>) - Method in interface ratpack.handling.Chain
Adds a handler that inserts the given handler chain with the given registry via Context.insert(ratpack.registry.Registry, Handler...).
register(Registry, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
 
register(Action<? super RegistrySpec>, Action<? super Chain>) - Method in interface ratpack.handling.Chain
Adds a handler that inserts the given handler chain with a registry built by the given action via Context.insert(ratpack.registry.Registry, Handler...).
register(Action<? super RegistrySpec>, Class<? extends Action<? super Chain>>) - Method in interface ratpack.handling.Chain
 
register(Registry, Handler) - Static method in class ratpack.handling.Handlers
A handler that simply calls Context.insert(Registry, Handler...) with the given registry and handler.
register(Registry) - Static method in class ratpack.handling.Handlers
A handler that simply calls Context.next(Registry) with the given registry.
register(RegistrySpec, ObjectMapper, ObjectWriter) - Static method in class ratpack.jackson.Jackson.Init
Registers the renderer and parsers with the given registry.
register() - Method in interface ratpack.render.RenderableDecorator
A registration action, typically used with RegistrySpec.with(Action).
register() - Method in interface ratpack.render.Renderer
An action that registers this renderer with a registry.
registry(Function<? super Registry, ? extends Registry>) - Method in interface ratpack.groovy.server.GroovyRatpackServerSpec
 
registry(Closure<?>) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture
A closure friendly overload of GroovyRequestFixture.registry(Action).
registry(Action<? super RegistrySpec>) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture
Configures the context registry.
registry(Injector) - Static method in class ratpack.guice.Guice
Creates a Ratpack Registry backed by the given Injector that will NOT create objects via “just-in-time” binding.
registry(Action<? super BindingsSpec>) - Static method in class ratpack.guice.Guice
 
registry(Injector, Action<? super BindingsSpec>) - Static method in class ratpack.guice.Guice
 
Registry - Interface in ratpack.registry
An object registry.
registry(Registry) - Method in interface ratpack.server.RatpackServerSpec
Sets the user registry to exactly the given registry.
registry(Function<? super Registry, ? extends Registry>) - Method in interface ratpack.server.RatpackServerSpec
Sets the user registry as the return value of the given function.
registry(Action<? super RegistrySpec>) - Method in interface ratpack.test.handling.RequestFixture
Configures the context registry.
RegistryBacking - Interface in ratpack.registry
Provides instances to the Registry implementation which uses an implementation of this interface for backing the instances that the Registry contains or returns.
RegistryBuilder - Interface in ratpack.registry
A builder of registries.
registryOf(Closure<?>) - Method in interface ratpack.groovy.server.GroovyRatpackServerSpec
 
registryOf(Action<? super RegistrySpec>) - Method in interface ratpack.server.RatpackServerSpec
Builds the user registry via the given spec action.
RegistrySpec - Interface in ratpack.registry
An additive specification of a registry.
reload() - Method in interface ratpack.server.RatpackServer
Reloads the server from its definition function.
reloadable(boolean) - Method in class ratpack.handlebars.HandlebarsModule.Config
 
ReloadInformant - Interface in ratpack.server
Informs when the server should be reloaded, during development.
remoteAddress(HostAndPort) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture
Set the remote address from which the request is made.
remoteAddress(HostAndPort) - Method in interface ratpack.test.handling.RequestFixture
Set the remote address from which the request is made.
RemoteControl - Class in ratpack.remote
 
RemoteControl - Class in ratpack.test.remote
 
RemoteControl(ApplicationUnderTest, String) - Constructor for class ratpack.test.remote.RemoteControl
 
RemoteControl(ApplicationUnderTest) - Constructor for class ratpack.test.remote.RemoteControl
 
remove(CharSequence) - Method in interface ratpack.http.MutableHeaders
Removes the header with the specified name.
remove(Class<T>) - Method in interface ratpack.registry.MutableRegistry
Remove the registration for the given type.
remove(TypeToken<T>) - Method in interface ratpack.registry.MutableRegistry
Remove the registration for the given type.
remove(SessionKey<?>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.remove(SessionKey).
remove(Class<?>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.remove(Class).
remove(String) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.remove(String).
remove(SessionKey<?>) - Method in interface ratpack.session.SessionData
Removes the object with the given key, if it exists.
remove(Class<?>) - Method in interface ratpack.session.SessionData
Removes the object with the given type and no name, if it exists.
remove(String) - Method in interface ratpack.session.SessionData
Removes the object with the name, if it exists.
remove(AsciiString) - Method in interface ratpack.session.SessionStore
Removes the session data for the given id.
remove(Object) - Method in interface ratpack.util.MultiValueMap
render(Context, T) - Method in class ratpack.groovy.render.GroovyRendererSupport
Delegates to GroovyRendererSupport.render(GroovyContext, Object), wrapping the given context in a GroovyContext.
render(GroovyContext, T) - Method in class ratpack.groovy.render.GroovyRendererSupport
Renders the given object to the context.
render(Context) - Method in class ratpack.groovy.template.Markup
 
render(String) - Method in interface ratpack.groovy.template.TextTemplateScript
Renders a nested template inline, using the same model as this template.
render(Map<String, ?>, String) - Method in interface ratpack.groovy.template.TextTemplateScript
Renders a nested template inline, with the given model merged with the current template model.
render(Object) - Method in interface ratpack.handling.Context
Render the given object, using the rendering framework.
render(Context) - Method in class ratpack.http.ResponseChunks
Render this object to the response.
render(Context) - Method in interface ratpack.render.Renderable
Render this object to the response.
render(Context, T) - Method in interface ratpack.render.Renderer
Render the given object to the response.
render(Context, T) - Method in class ratpack.render.RendererSupport
Render the given object to the response.
render(Context) - Method in class ratpack.sse.ServerSentEvents
Render this object to the response.
Renderable - Interface in ratpack.render
A renderable object, that can be given to Context.render(Object).
RenderableDecorator<T> - Interface in ratpack.render
Decorates an object before it is rendered.
RenderableDecoratorSupport<T> - Class in ratpack.render
A convenience base class for RenderableDecorator implementations.
RenderableDecoratorSupport() - Constructor for class ratpack.render.RenderableDecoratorSupport
 
rendered(Class<T>) - Method in interface ratpack.test.handling.HandlingResult
The object that was rendered to the response.
renderer(ObjectWriter) - Method in class ratpack.jackson.guice.JacksonModule
 
renderer(ObjectWriter) - Static method in class ratpack.jackson.Jackson.Init
The renderer.
Renderer<T> - Interface in ratpack.render
A renderer is responsible for rendering an object to the response.
RendererException - Exception in ratpack.render
Wraps an exception thrown by a renderer while rendering.
RendererException(Renderer<?>, Object, Throwable) - Constructor for exception ratpack.render.RendererException
Constructor.
RendererSupport<T> - Class in ratpack.render
A Renderer super class that provides a RendererSupport.getType() implementation based on the generic type of the impl.
RendererSupport() - Constructor for class ratpack.render.RendererSupport
 
RenderException - Exception in ratpack.render
A generic super type for exceptions indicate something when wrong for a render operation.
RenderException(String) - Constructor for exception ratpack.render.RenderException
Constructor.
RenderException(String, Throwable) - Constructor for exception ratpack.render.RenderException
Constructor.
reportDirectory(File) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Csv
Configure the output directory for csv metrics reports.
reporterInterval(Duration) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Console
Configure the interval between metrics reports.
reporterInterval(Duration) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Csv
Configure the interval between metrics reports.
reporterInterval(Duration) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.Slf4j
Configure the interval between metrics reports.
reporterInterval(Duration) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config.WebSocket
Configure the interval between broadcasts.
reporterInterval(Duration) - Method in class ratpack.codahale.metrics.Graphite
Configure the interval between broadcasts.
request(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient
An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec.
Request - Interface in ratpack.http
A request to be handled.
request(URI, Action<? super RequestSpec>) - Method in interface ratpack.sse.ServerSentEventStreamClient
 
request(URI) - Method in interface ratpack.sse.ServerSentEventStreamClient
 
requestFixture() - Static method in interface ratpack.groovy.test.handling.GroovyRequestFixture
Create a Groovy request fixture, for unit testing a Handler.
requestFixture(RequestFixture) - Static method in interface ratpack.groovy.test.handling.GroovyRequestFixture
Create a Groovy request fixture, for unit testing a Handler, by wrapping the given RequestFixture.
RequestFixture - Interface in ratpack.test.handling
A contrived request environment, suitable for unit testing Handler implementations.
requestFixture() - Static method in interface ratpack.test.handling.RequestFixture
Create a request fixture, for unit testing of handlers.
RequestId - Interface in ratpack.handling
An opaque identifier for the request.
RequestId.Generator - Interface in ratpack.handling
Generates a unique request ID.
RequestLog - Interface in ratpack.handling
An object that formats information about a RequestOutcome.
requestMetricGroups(Map<String, String>) - Method in class ratpack.codahale.metrics.CodaHaleMetricsModule.Config
Configure the request metric groups
RequestOutcome - Interface in ratpack.handling
The outcome of processing a request.
RequestSpec - Interface in ratpack.http.client
 
requestSpec(Action<? super RequestSpec>) - Method in interface ratpack.test.http.TestHttpClient
 
RequestSpec.Body - Interface in ratpack.http.client
The request body.
requestStream(URI, Action<? super RequestSpec>) - Method in interface ratpack.http.client.HttpClient
An asynchronous method to do a HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, the received response content will be streamed.
require() - Static method in interface ratpack.exec.ExecController
Returns the execution controller bound to the current thread, or throws an exception if called on a non Ratpack managed compute thread.
require(String, Class<?>) - Method in interface ratpack.server.ServerConfigBuilder
Declares that it is required that the server config provide an object of the given type at the given path.
require(SessionKey<T>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.require(SessionKey).
require(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.Session
require(Class<T>) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.require(Class).
require(Class<T>, SessionSerializer) - Method in interface ratpack.session.Session
require(String) - Method in interface ratpack.session.Session
A convenience shorthand for SessionData.require(String).
require(String, SessionSerializer) - Method in interface ratpack.session.Session
require(SessionKey<T>) - Method in interface ratpack.session.SessionData
Like SessionData.get(SessionKey), but throws NoSuchElementException on the absence of a value.
require(SessionKey<T>, SessionSerializer) - Method in interface ratpack.session.SessionData
require(Class<T>) - Method in interface ratpack.session.SessionData
Like SessionData.get(Class), but throws NoSuchElementException on the absence of a value.
require(Class<T>, SessionSerializer) - Method in interface ratpack.session.SessionData
Like SessionData.get(Class, SessionSerializer), but throws NoSuchElementException on the absence of a value.
require(String) - Method in interface ratpack.session.SessionData
Like SessionData.get(String), but throws NoSuchElementException on the absence of a value.
require(String, SessionSerializer) - Method in interface ratpack.session.SessionData
Like SessionData.get(String, SessionSerializer), but throws NoSuchElementException on the absence of a value.
requireAuth(Class<? extends Client<?, ?>>) - Static method in class ratpack.pac4j.RatpackPac4j
An authentication “filter”, that initiates authentication if necessary.
requireClientSslAuth(boolean) - Method in interface ratpack.server.ServerConfigBuilder
The server needs client SSL authentication.
resetRequest() - Method in interface ratpack.test.http.TestHttpClient
Set the requestSpec back to a No Op default and clear the cookies.
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.
responseHeader(CharSequence, String) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture
Set a response header value.
responseHeader(CharSequence, String) - Method in interface ratpack.test.handling.RequestFixture
Set a response header value.
ResponseMetaData - Interface in ratpack.http
The metadata associated with a response.
ResponseTimer - Class in ratpack.handling
A handler, that adds a "X-Response-Time" header to all requests indicating how long it took to start sending a response in milliseconds.
ResponseTimer() - Constructor for class ratpack.handling.ResponseTimer
 
result(Action<? super Result<T>>) - Method in interface ratpack.exec.Promise
Consume the promised value as a Result.
Result<T> - Interface in ratpack.exec
The result of an asynchronous operation, which may be an error.
right(Promise<O>) - Method in interface ratpack.exec.Promise
 
right - Variable in class ratpack.func.Pair
The right item of the pair.
right() - Method in class ratpack.func.Pair
The right item of the pair.
right(T) - Method in class ratpack.func.Pair
Replaces the right item with the given item.
route(Predicate<? super T>, Action<? super T>) - Method in interface ratpack.exec.Promise
Allows the promised value to be handled specially if it meets the given predicate, instead of being handled by the promise subscriber.
run(String...) - Method in class ratpack.spring.config.RatpackConfiguration
 
run(Action<? super Execution>) - Method in interface ratpack.test.exec.ExecHarness
Initiates an execution and blocks until it completes.
run(Action<? super RegistrySpec>, Action<? super Execution>) - Method in interface ratpack.test.exec.ExecHarness
Initiates an execution and blocks until it completes.
runSingle(Action<? super Execution>) - Static method in interface ratpack.test.exec.ExecHarness
Convenient form of ExecHarness.run(Action) that creates and closes a harness for the run.
runSingle(Action<? super RegistrySpec>, Action<? super Execution>) - Static method in interface ratpack.test.exec.ExecHarness
Convenient form of ExecHarness.run(Action, Action) that creates and closes a harness for the run.
RxRatpack - Class in ratpack.rx
Provides integration with RxJava.
A B C D E F G H I J L M N O P R S T U V W X Y 
Skip navigation links