Package | Description |
---|---|
ratpack.exec |
The execution management.
|
ratpack.groovy |
Support for writing Ratpack applications in the Groovy programming language.
|
ratpack.groovy.handling |
Groovy specific extensions to classes in the
ratpack.handling package. |
ratpack.groovy.server | |
ratpack.guice |
Integration with Google Guice.
|
ratpack.handling |
The handling of application requests.
|
ratpack.health |
Health checks report on the status of key components in the system and are generally used for monitoring and reporting.
|
ratpack.http |
The HTTP protocol.
|
ratpack.http.client |
The HTTP client.
|
ratpack.jackson |
Integration with the Jackson JSON marshalling library.
|
ratpack.registry |
Registries hold objects that can be retrieved via type, and are a key aspect of Ratpack applications.
|
ratpack.remote |
Integration with Groovy Remote Control.
|
ratpack.server |
Objects used to start a ratpack application.
|
ratpack.spring |
Provides integration with Spring Boot.
|
ratpack.stream |
Support for reactive streams.
|
ratpack.test | |
ratpack.test.embed |
Support for creating embedded applications at test time, for testing Ratpack features and extensions.
|
ratpack.test.handling |
Modifier and Type | Interface and Description |
---|---|
interface |
Execution
A logical stream of execution, which is potentially serialized over many threads.
|
Modifier and Type | Method and Description |
---|---|
Registry |
ExecResult.getRegistry()
The execution registry.
|
Modifier and Type | Method and Description |
---|---|
static Function<Registry,Registry> |
Groovy.Script.bindings() |
static Function<Registry,Registry> |
Groovy.Script.bindings() |
static Function<Registry,Registry> |
Groovy.Script.bindings(boolean staticCompile) |
static Function<Registry,Registry> |
Groovy.Script.bindings(boolean staticCompile) |
static Function<Registry,Registry> |
Groovy.Script.bindings(boolean staticCompile,
String scriptPath) |
static Function<Registry,Registry> |
Groovy.Script.bindings(boolean staticCompile,
String scriptPath) |
static Function<Registry,Handler> |
Groovy.Script.handlers() |
static Function<Registry,Handler> |
Groovy.Script.handlers(boolean staticCompile) |
static Function<Registry,Handler> |
Groovy.Script.handlers(boolean staticCompile,
String scriptPath) |
Modifier and Type | Method and Description |
---|---|
static Handler |
Groovy.chain(Registry registry,
Closure<?> closure)
Builds a chain, backed by the given registry.
|
static Handler |
Groovy.chain(ServerConfig serverConfig,
Registry registry,
Closure<?> closure)
Builds a chain, backed by the given registry.
|
Modifier and Type | Interface and Description |
---|---|
interface |
GroovyContext
Subclass of
Context that adds Groovy friendly variants of methods. |
Modifier and Type | Method and Description |
---|---|
Registry |
GroovyChainAction.getRegistry()
The registry that backs this chain.
|
Modifier and Type | Method and Description |
---|---|
default GroovyChain |
GroovyChain.register(Registry registry)
Makes the contents of the given registry available for downstream handlers of the same nesting level.
|
default GroovyChain |
GroovyChain.register(Registry registry,
Action<? super Chain> action)
Adds a handler that inserts the given handler chain with the given registry via
Context.insert(ratpack.registry.Registry, Handler...) . |
default GroovyChain |
GroovyChain.register(Registry registry,
Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.register(Registry registry,
Closure<?> handlers) |
Modifier and Type | Method and Description |
---|---|
GroovyRatpackServerSpec |
GroovyRatpackServerSpec.handler(Function<? super Registry,? extends Handler> handlerFactory) |
GroovyRatpackServerSpec |
GroovyRatpackServerSpec.registry(Function<? super Registry,? extends Registry> function) |
GroovyRatpackServerSpec |
GroovyRatpackServerSpec.registry(Function<? super Registry,? extends Registry> function) |
Modifier and Type | Method and Description |
---|---|
static Registry |
Guice.justInTimeRegistry(Injector injector)
|
static Registry |
Guice.registry(Injector injector)
|
Modifier and Type | Method and Description |
---|---|
static Function<Registry,Registry> |
Guice.registry(Action<? super BindingsSpec> bindings) |
static Function<Registry,Registry> |
Guice.registry(Action<? super BindingsSpec> bindings) |
static Function<Registry,Registry> |
Guice.registry(Injector parentInjector,
Action<? super BindingsSpec> bindings) |
static Function<Registry,Registry> |
Guice.registry(Injector parentInjector,
Action<? super BindingsSpec> bindings) |
Modifier and Type | Interface and Description |
---|---|
interface |
Context
The context of an individual
Handler invocation. |
Modifier and Type | Method and Description |
---|---|
Registry |
Chain.getRegistry()
The registry that backs this chain.
|
Modifier and Type | Method and Description |
---|---|
static Handler |
Handlers.chain(Registry registry,
Action<? super Chain> action)
Builds a chain, backed by the given registry.
|
static Handler |
Handlers.chain(ServerConfig serverConfig,
Registry registry,
Action<? super Chain> action)
Builds a chain, backed by the given registry.
|
Handler |
HandlerDecorator.decorate(Registry serverRegistry,
Handler rest)
Creates a new handler that decorates the application handlers, given as the
rest argument. |
void |
Context.insert(Registry registry,
Handler... handlers)
Inserts some handlers into the pipeline to execute with the given registry, then delegates to the first.
|
void |
Context.next(Registry registry)
Invokes the next handler, after adding the given registry.
|
default Chain |
Chain.register(Registry registry)
Makes the contents of the given registry available for downstream handlers of the same nesting level.
|
static Handler |
Handlers.register(Registry registry)
A handler that simply calls
Context.next(Registry) with the given registry. |
default Chain |
Chain.register(Registry registry,
Action<? super Chain> action)
Adds a handler that inserts the given handler chain with the given registry via
Context.insert(ratpack.registry.Registry, Handler...) . |
default Chain |
Chain.register(Registry registry,
Class<? extends Action<? super Chain>> action) |
static Handler |
Handlers.register(Registry registry,
Handler handler)
A handler that simply calls
Context.insert(Registry, Handler...) with the given registry and handler. |
Modifier and Type | Method and Description |
---|---|
Promise<HealthCheck.Result> |
HealthCheck.check(ExecControl execControl,
Registry registry)
Checks the health of the component, providing a promise for the result.
|
Modifier and Type | Method and Description |
---|---|
static HealthCheck |
HealthCheck.of(String name,
BiFunction<? super ExecControl,? super Registry,? extends Promise<HealthCheck.Result>> func)
Convenience factory for health check implementations.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Request
A request to be handled.
|
Modifier and Type | Method and Description |
---|---|
static HttpClient |
HttpClient.httpClient(ServerConfig serverConfig,
Registry registry)
A method to create an instance of the default implementation of HttpClient.
|
Modifier and Type | Method and Description |
---|---|
static <T> ResponseChunks |
Jackson.chunkedJsonList(Registry registry,
Publisher<T> stream)
Renders a data stream as a JSON list, directly streaming the JSON.
|
static <T> Function<T,String> |
Jackson.toJson(Registry registry)
Creates a mapping function that returns the JSON representation as a string of the input object.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MutableRegistry
A
Registry that is also mutable. |
Modifier and Type | Method and Description |
---|---|
static Registry |
Registry.backedBy(RegistryBacking registryBacking)
Creates a new registry instance that is backed by a RegistryBacking implementation.
|
Registry |
RegistryBuilder.build()
Builds the registry.
|
static Registry |
Registry.empty()
Returns an empty registry.
|
default Registry |
Registry.join(Registry child)
Creates a new registry by joining
this registry with the given registry |
static Registry |
Registry.of(Action<? super RegistrySpec> action)
Builds a registry from the given action.
|
static <T> Registry |
Registry.single(Class<? super T> publicType,
T implementation)
Creates a single entry registry, using
RegistryBuilder.add(Class, Object) . |
static <T> Registry |
Registry.single(Class<T> publicType,
Supplier<? extends T> supplier)
Creates a single lazily created entry registry, using
RegistryBuilder.addLazy(Class, Supplier) . |
static Registry |
Registry.single(Object object)
Creates a single entry registry, using
RegistryBuilder.add(Object) . |
Modifier and Type | Method and Description |
---|---|
default Registry |
Registry.join(Registry child)
Creates a new registry by joining
this registry with the given registry |
Modifier and Type | Interface and Description |
---|---|
interface |
CommandDelegate
The delegate object for commands
|
Modifier and Type | Method and Description |
---|---|
Registry |
StartEvent.getRegistry()
The server registry.
|
Registry |
StopEvent.getRegistry()
The server registry.
|
Modifier and Type | Method and Description |
---|---|
default RatpackServerSpec |
RatpackServerSpec.registry(Registry registry)
Sets the user registry to exactly the given registry.
|
boolean |
ReloadInformant.shouldReload(Registry registry)
Whether the server should reload.
|
Modifier and Type | Method and Description |
---|---|
RatpackServerSpec |
RatpackServerSpec.handler(Function<? super Registry,? extends Handler> handlerFactory)
Sets the root handler to the return of the given function.
|
RatpackServerSpec |
RatpackServerSpec.registry(Function<? super Registry,? extends Registry> function)
Sets the user registry as the return value of the given function.
|
RatpackServerSpec |
RatpackServerSpec.registry(Function<? super Registry,? extends Registry> function)
Sets the user registry as the return value of the given function.
|
Modifier and Type | Method and Description |
---|---|
static Registry |
Spring.spring(Class<?> clazz,
String... args)
Creates a registry backed by the given Spring Boot application class.
|
static Registry |
Spring.spring(ListableBeanFactory beanFactory)
Creates a registry backed by the given bean factory.
|
static Registry |
Spring.spring(SpringApplicationBuilder builder,
String... args)
Creates a registry backed by the given Spring Boot application builder.
|
Modifier and Type | Method and Description |
---|---|
static <T> TransformablePublisher<T> |
Streams.periodically(Registry registry,
Duration duration,
Function<Integer,T> producer) |
Modifier and Type | Method and Description |
---|---|
protected Registry |
MainClassApplicationUnderTest.createOverrides(Registry serverRegistry) |
Modifier and Type | Method and Description |
---|---|
protected Registry |
MainClassApplicationUnderTest.createOverrides(Registry serverRegistry) |
Modifier and Type | Method and Description |
---|---|
static EmbeddedApp |
EmbeddedApp.fromHandlerFactory(Function<? super Registry,? extends Handler> handlerFactory)
Creates an embedded application with a default launch config (no base dir, ephemeral port) and the given handler.
|
static EmbeddedApp |
EmbeddedApp.fromHandlerFactory(Path baseDir,
Function<? super Registry,? extends Handler> handlerFactory)
Creates an embedded application with a default launch config (ephemeral port) and the given handler.
|
Modifier and Type | Method and Description |
---|---|
Registry |
HandlingResult.getRegistry()
The final state of the context registry.
|
Registry |
HandlingResult.getRequestRegistry()
The final state of the request registry.
|