Package | Description |
---|---|
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.consul |
Support for integrating Ratpack applications with Hashicorp's Consul service discovery and distributed configuration engine.
|
ratpack.dropwizard.metrics |
Integration with Dropwizard Metrics Library.
|
ratpack.exec |
The execution management.
|
ratpack.exec.util | |
ratpack.exec.util.retry | |
ratpack.func |
General functional (i.e. Single Abstract Method) types.
|
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 |
Groovy implementations of the Ratpack server building classes.
|
ratpack.groovy.test.handling | |
ratpack.guice |
Integration with Google Guice.
|
ratpack.handling |
The handling of application requests.
|
ratpack.handling.direct |
Low level direct access to the underlying Netty internals.
|
ratpack.http |
The HTTP protocol.
|
ratpack.http.client |
The HTTP client.
|
ratpack.impose | |
ratpack.logging |
Utility classes for integration Ratpack with various logging frameworks.
|
ratpack.path |
Types for managing the paths of requests inside the application.
|
ratpack.reactor |
Provides integration with the Project Reactor library.
|
ratpack.registry |
Registries hold objects that can be retrieved via type, and are a key aspect of Ratpack applications.
|
ratpack.render |
The renderer framework provides a pluggable mechanism for serializing objects to the response.
|
ratpack.retrofit |
Integration with Retrofit.
|
ratpack.rx |
Provides integration with the RxJava library.
|
ratpack.rx2 |
Provides integration with the RxJava library.
|
ratpack.server |
Objects used to start a ratpack application.
|
ratpack.service |
Services participate in the application start/stop lifecycle.
|
ratpack.session |
Objects for providing
Session support. |
ratpack.spring.config | |
ratpack.sse |
Support for Server Sent Events.
|
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.exec | |
ratpack.test.handling |
Test fixtures for exercising
Handler implementations without
start a full EmbeddedApp . |
ratpack.test.http |
Test fixtures that provide HTTP client interfaces to applications under test.
|
ratpack.util |
General purpose types and utilities.
|
ratpack.websocket |
Support for Websockets.
|
Modifier and Type | Method and Description |
---|---|
ConfigDataBuilder |
ConfigDataBuilder.configureObjectMapper(Action<ObjectMapper> action)
Configures the object mapper used for binding configuration data to arbitrary objects.
|
static ConfigData |
ConfigData.of(Action<? super ConfigDataBuilder> definition)
Builds a new config data with the default object mapper, from the given definition.
|
static ConfigData |
ConfigData.of(ObjectMapper objectMapper,
Action<? super ConfigDataBuilder> definition)
Builds a new config data with the specified object mapper, from the given definition.
|
ConfigDataBuilder |
ConfigDataBuilder.onError(Action<? super java.lang.Throwable> errorHandler)
Sets the error all that will be used for added configuration sources.
|
Modifier and Type | Method and Description |
---|---|
static com.google.common.io.ByteSource |
RatpackConsulConfig.value(java.lang.String key,
Action<? super com.orbitz.consul.Consul.Builder> clientConfig)
Read the specified key as a
ByteSource using the specified configuration to connection to Consul. |
static com.google.common.io.ByteSource |
RatpackConsulConfig.value(java.lang.String key,
com.orbitz.consul.option.QueryOptions queryOptions,
Action<? super com.orbitz.consul.Consul.Builder> clientConfig)
Read the specified key as a
ByteSource using the specified configuration to connection to Consul and the provided QueryOptions . |
Modifier and Type | Method and Description |
---|---|
DropwizardMetricsConfig |
DropwizardMetricsConfig.byteBufAllocator(Action<? super ByteBufAllocatorConfig> configure)
Configure the byte buf allocator metric set.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.console(Action<? super ConsoleConfig> configure)
Configure the console metrics publisher.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.csv(Action<? super CsvConfig> configure)
Configure the csv metrics publisher.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.graphite(Action<? super GraphiteConfig> configure)
Configure the Graphite metrics publisher.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.httpClient(Action<? super HttpClientConfig> configure)
Configure the http client metric set.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.jmx(Action<? super JmxConfig> configure)
Configure the JMX metrics publisher.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.slf4j(Action<? super Slf4jConfig> configure)
Configure the Slf4j logger metrics publisher.
|
DropwizardMetricsConfig |
DropwizardMetricsConfig.webSocket(Action<? super WebsocketConfig> configure)
Configure the websockets metrics broadcaster.
|
Modifier and Type | Method and Description |
---|---|
default Promise<T> |
Promise.blockingOp(Action<? super T> action)
Executes the given action with the promise value, on a blocking thread.
|
default Promise<T> |
Promise.defer(Action<? super java.lang.Runnable> releaser)
Defers the subscription of
this promise until later. |
default Promise<T> |
Promise.fork(Action<? super ExecSpec> execSpec)
Forks a new execution and subscribes to this promise, returning a promise for its value.
|
default Operation |
Operation.mapError(Action<? super java.lang.Throwable> action)
Convert an error to a success or different error.
|
default Promise<T> |
Promise.next(Action<? super T> action)
Executes the provided, potentially asynchronous,
Action with the promised value as input. |
ExecSpec |
ExecSpec.onComplete(Action<? super Execution> onComplete)
Specifies the completion callback for the execution.
|
ExecStarter |
ExecStarter.onComplete(Action<? super Execution> onComplete)
Specifies the completion callback for the execution.
|
default Downstream<T> |
Downstream.onError(Action<? super java.lang.Throwable> action)
Wrap this downstream, using the given action as the implementation of the
Downstream.error(Throwable) method. |
ExecSpec |
ExecSpec.onError(Action<? super java.lang.Throwable> onError)
Specify the top level error handler for the execution.
|
Operation |
Operation.onError(Action<? super java.lang.Throwable> onError) |
default Promise<T> |
Promise.onError(Action<? super java.lang.Throwable> errorHandler)
Specifies the action to take if the an error occurs trying to produce the promised value.
|
ExecStarter |
ExecStarter.onError(Action<? super java.lang.Throwable> onError)
Specify the top level error handler for the execution.
|
default <E extends java.lang.Throwable> |
Promise.onError(java.lang.Class<E> errorType,
Action<? super E> errorHandler)
Specifies the action to take if the an error of the given type occurs trying to produce the promised value.
|
default Promise<T> |
Promise.onError(Predicate<? super java.lang.Throwable> predicate,
Action<? super java.lang.Throwable> errorHandler)
Specifies the action to take if the an error occurs trying to produce the promised value, that the given predicate applies to.
|
ExecSpec |
ExecSpec.onStart(Action<? super Execution> onStart)
Specifies an action to be taken just before the execution starts.
|
ExecStarter |
ExecStarter.onStart(Action<? super Execution> onStart)
Specifies an action to be taken just before the execution starts.
|
default <O> Downstream<O> |
Downstream.onSuccess(Action<? super O> action)
Wrap this downstream, using the given action as the implementation of the
Downstream.success(T) method. |
default Operation |
Promise.operation(Action<? super T> action)
Converts this promise to an operation which is effectively
action . |
ExecSpec |
ExecSpec.register(Action<? super RegistrySpec> action)
Populates the execution's registry.
|
ExecStarter |
ExecStarter.register(Action<? super RegistrySpec> action)
Populates the execution's registry.
|
default void |
Promise.result(Action<? super ExecResult<T>> resultHandler)
Consume the promised value as a
Result . |
default Promise<T> |
Promise.route(Predicate<? super T> predicate,
Action<? super T> action)
Allows the promised value to be handled specially if it meets the given predicate, instead of being handled by the promise subscriber.
|
void |
ExecStarter.start(Action<? super Execution> initialExecutionSegment)
Starts the execution, with the given action as the initial segment.
|
void |
Promise.then(Action<? super T> then)
Specifies what should be done with the promised object when it becomes available.
|
default Promise<T> |
Promise.time(Action<? super java.time.Duration> action)
Emits the time taken from when the promise is subscribed to to when the result is available.
|
default Operation |
Operation.wiretap(Action<? super java.util.Optional<? extends java.lang.Throwable>> action) |
default Promise<T> |
Promise.wiretap(Action<? super Result<T>> listener)
Registers a listener for the promise outcome.
|
Modifier and Type | Method and Description |
---|---|
ParallelBatch<T> |
ParallelBatch.execInit(Action<? super Execution> execInit)
Specifies an initializer for each forked execution.
|
Modifier and Type | Method and Description |
---|---|
static AttemptRetryPolicy |
AttemptRetryPolicy.of(Action<? super AttemptRetryPolicyBuilder> definition)
Builds a new attempt based retry policy from the given definition.
|
static DurationRetryPolicy |
DurationRetryPolicy.of(Action<? super DurationRetryPolicyBuilder> definition)
Builds a new duration based retry policy from the given definition.
|
Modifier and Type | Method and Description |
---|---|
default Action<java.lang.Object> |
Block.action()
Creates an
Action from this block, where the argument is ignored. |
default <O extends T> |
Action.append(Action<? super O> action)
Returns a new action that executes this action and then the given action.
|
static Action<java.lang.Throwable> |
Action.beforeThrow(Action<? super java.lang.Throwable> action)
Creates an exception-taking action that executes the given action before throwing the exception.
|
static Action<java.lang.Throwable> |
Action.beforeThrow(Block block)
Creates an exception-taking action that executes the given block before throwing the exception.
|
static <I> Action<I> |
Action.conditional(Action<? super Action.ConditionalSpec<I>> conditions)
Creates an action that delegates based on the specified conditions.
|
static <I> Action<I> |
Action.conditional(Action<? super I> onElse,
Action<? super Action.ConditionalSpec<I>> conditions)
Creates an action that delegates based on the specified conditions.
|
static <T> Action<T> |
Action.from(java.util.function.Consumer<T> consumer)
Creates an action from a JDK consumer.
|
static <T> Action<T> |
Action.ignoreArg(Block block) |
static <T> Action<T> |
Action.join(Action<? super T>... actions)
Returns a new action that executes the given actions in order.
|
static <T> Action<T> |
Action.noop()
Returns an action that does precisely nothing.
|
static <T> Action<? super T> |
Action.noopIfNull(Action<T> action)
If the given action is
null , returns noop() , otherwise returns the given action. |
default <O extends T> |
Action.prepend(Action<? super O> action)
Returns a new action that executes the given action and then this action.
|
static Action<java.lang.Throwable> |
Action.suppressAndThrow(java.lang.Throwable toSuppress)
An action that receives a throwable to thrown, suppressing the given value.
|
static Action<java.lang.Throwable> |
Action.throwException()
Returns an action that receives a throwable and immediately throws it.
|
static <T> Action<T> |
Action.throwException(java.lang.Throwable throwable)
Returns an action that immediately throws the given exception.
|
static <I> Action<I> |
Action.when(Predicate<? super I> predicate,
Action<? super I> action)
Creates an action that delegates to the given action if the given predicate applies, else delegates to
noop() . |
static <I> Action<I> |
Action.when(Predicate<? super I> predicate,
Action<? super I> onTrue,
Action<? super I> onFalse)
Creates an action that delegates to the first action if the given predicate applies, else the second action.
|
Modifier and Type | Method and Description |
---|---|
default <O extends T> |
Action.append(Action<? super O> action)
Returns a new action that executes this action and then the given action.
|
static Action<java.lang.Throwable> |
Action.beforeThrow(Action<? super java.lang.Throwable> action)
Creates an exception-taking action that executes the given action before throwing the exception.
|
static <I> Action<I> |
Action.conditional(Action<? super Action.ConditionalSpec<I>> conditions)
Creates an action that delegates based on the specified conditions.
|
static <I,O> Function<I,O> |
Function.conditional(Action<? super Function.ConditionalSpec<I,O>> conditions)
Creates a function that delegates based on the specified conditions.
|
static <I> Action<I> |
Action.conditional(Action<? super I> onElse,
Action<? super Action.ConditionalSpec<I>> conditions)
Creates an action that delegates based on the specified conditions.
|
static <I> Action<I> |
Action.conditional(Action<? super I> onElse,
Action<? super Action.ConditionalSpec<I>> conditions)
Creates an action that delegates based on the specified conditions.
|
static <I,O> Function<I,O> |
Function.conditional(Function<? super I,? extends O> onElse,
Action<? super Function.ConditionalSpec<I,O>> conditions)
Creates a function that delegates based on the specified conditions.
|
static <T> Action<T> |
Action.join(Action<? super T>... actions)
Returns a new action that executes the given actions in order.
|
static <T> Action<? super T> |
Action.noopIfNull(Action<T> action)
If the given action is
null , returns noop() , otherwise returns the given action. |
default <O extends T> |
Action.prepend(Action<? super O> action)
Returns a new action that executes the given action and then this action.
|
static <T> T |
Action.uncheckedWith(T t,
Action<? super T> action)
Like
with(Object, Action) , but unchecks any exceptions thrown by the action via Exceptions.uncheck(Throwable) . |
Action.ConditionalSpec<I> |
Action.ConditionalSpec.when(Predicate<? super I> predicate,
Action<? super I> action) |
static <I> Action<I> |
Action.when(Predicate<? super I> predicate,
Action<? super I> action)
Creates an action that delegates to the given action if the given predicate applies, else delegates to
noop() . |
static <I> Action<I> |
Action.when(Predicate<? super I> predicate,
Action<? super I> onTrue,
Action<? super I> onFalse)
Creates an action that delegates to the first action if the given predicate applies, else the second action.
|
static <I> Action<I> |
Action.when(Predicate<? super I> predicate,
Action<? super I> onTrue,
Action<? super I> onFalse)
Creates an action that delegates to the first action if the given predicate applies, else the second action.
|
static <T> T |
Action.with(T t,
Action<? super T> action)
Executes the action with the given argument, then returns the argument.
|
Modifier and Type | Method and Description |
---|---|
static Action<? super RatpackServerSpec> |
Groovy.Script.app()
Creates an application defining action from a Groovy script named "ratpack.groovy".
|
static Action<? super RatpackServerSpec> |
Groovy.Script.app(boolean compileStatic)
Creates an application defining action from a Groovy script named "ratpack.groovy".
|
static Action<? super RatpackServerSpec> |
Groovy.Script.app(boolean compileStatic,
java.nio.file.Path script)
Creates an application defining action from a Groovy script.
|
static Action<? super RatpackServerSpec> |
Groovy.Script.app(boolean compileStatic,
java.lang.String... scriptPaths)
Creates an application defining action from a Groovy script.
|
static Action<? super RatpackServerSpec> |
Groovy.Script.app(java.nio.file.Path script)
Creates an application defining action from a Groovy script.
|
static Action<? super RatpackServerSpec> |
Groovy.Script.appWithArgs(boolean compileStatic,
java.nio.file.Path script,
java.lang.String... args)
Creates an application defining action from a Groovy script.
|
static Action<? super RatpackServerSpec> |
Groovy.Script.appWithArgs(boolean compileStatic,
java.lang.String[] scriptPaths,
java.lang.String... args)
Creates an application defining action from a Groovy script.
|
static Action<? super RatpackServerSpec> |
Groovy.Script.appWithArgs(java.lang.String... args)
Creates an application defining action from a Groovy script named "ratpack.groovy"
|
static Action<Chain> |
Groovy.chain(Closure<?> closure)
Creates a chain action implementation from the given closure.
|
static Action<Chain> |
Groovy.chainAction(Closure<?> closure)
Creates a chain action based on the given closure.
|
Modifier and Type | Method and Description |
---|---|
static MarkupTemplate |
Groovy.groovyMarkupTemplate(java.lang.String id,
Action<? super com.google.common.collect.ImmutableMap.Builder<java.lang.String,java.lang.Object>> modelBuilder)
Creates a
renderable Groovy based markup template, using the default content type. |
static MarkupTemplate |
Groovy.groovyMarkupTemplate(java.lang.String id,
java.lang.String type,
Action<? super com.google.common.collect.ImmutableMap.Builder<java.lang.String,java.lang.Object>> modelBuilder)
Creates a
renderable Groovy based markup template. |
Modifier and Type | Class and Description |
---|---|
class |
GroovyChainAction
A convenience super class for a standalone implementation of a
Action<GroovyChain> . |
Modifier and Type | Method and Description |
---|---|
default GroovyChain |
GroovyChain.files(Action<? super FileHandlerSpec> config)
Adds a handler that serves files from the file system.
|
default GroovyChain |
GroovyChain.fileSystem(java.lang.String path,
Action<? super Chain> action)
Adds a handler to this chain that changes the
FileSystemBinding for the given handler chain. |
default GroovyChain |
GroovyChain.host(java.lang.String hostName,
Action<? super Chain> action)
Adds a handler to the chain that delegates to the given handler chain if the request has a
Host header that matches the given value exactly. |
default GroovyChain |
GroovyChain.insert(Action<? super Chain> action)
Inserts the given nested handler chain.
|
default GroovyChain |
GroovyChain.prefix(java.lang.String prefix,
Action<? super Chain> action)
Adds a handler that delegates to the given handlers if the
relative path starts with the given
prefix . |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> action)
Builds a new registry via the given action, then registers it via
Chain.register(Registry) . |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> registryAction,
Action<? super Chain> chainAction)
Adds a handler that inserts the given handler chain with a registry built by the given action via
Context.insert(ratpack.registry.Registry, Handler...) . |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> registryAction,
Action<? super Chain> chainAction)
Adds a handler that inserts the given handler chain with a registry built by the given action via
Context.insert(ratpack.registry.Registry, Handler...) . |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> registryAction,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> registryAction,
Closure<?> handler) |
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.when(boolean test,
Action<? super Chain> action)
Inlines the given chain if
test is true . |
default GroovyChain |
GroovyChain.when(boolean test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse)
Inlines the appropriate chain based on the given
test . |
default GroovyChain |
GroovyChain.when(boolean test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse)
Inlines the appropriate chain based on the given
test . |
default GroovyChain |
GroovyChain.when(Closure<?> test,
Action<? super Chain> chain) |
default GroovyChain |
GroovyChain.when(Closure<?> test,
Action<? super Chain> ifChain,
Action<? super Chain> elseChain) |
default GroovyChain |
GroovyChain.when(Closure<?> test,
Action<? super Chain> ifChain,
Action<? super Chain> elseChain) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
Action<? super Chain> action) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse) |
Modifier and Type | Method and Description |
---|---|
default GroovyChain |
GroovyChain.fileSystem(java.lang.String path,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.host(java.lang.String hostName,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.insert(java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.prefix(java.lang.String prefix,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.register(Action<? super RegistrySpec> registryAction,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.register(Registry registry,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> action)
Inlines the given chain if
test is true . |
default GroovyChain |
GroovyChain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse)
Inlines the appropriate chain based on the given
test . |
default GroovyChain |
GroovyChain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse)
Inlines the appropriate chain based on the given
test . |
default GroovyChain |
GroovyChain.when(Closure<?> test,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.when(Closure<?> test,
java.lang.Class<? extends Action<? super Chain>> ifAction,
java.lang.Class<? extends Action<? super Chain>> elseAction) |
default GroovyChain |
GroovyChain.when(Closure<?> test,
java.lang.Class<? extends Action<? super Chain>> ifAction,
java.lang.Class<? extends Action<? super Chain>> elseAction) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> action) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse) |
default GroovyChain |
GroovyChain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse) |
Modifier and Type | Method and Description |
---|---|
GroovyRatpackServerSpec |
GroovyRatpackServerSpec.serverConfig(Action<? super ServerConfigBuilder> action) |
Modifier and Type | Method and Description |
---|---|
static HandlingResult |
GroovyRequestFixture.handle(Action<? super Chain> handlers,
Closure<?> closure)
Unit test a chain of
handlers . |
GroovyRequestFixture |
GroovyRequestFixture.registry(Action<? super RegistrySpec> action)
Configures the context registry.
|
GroovyRequestFixture |
GroovyRequestFixture.serverConfig(Action<? super ServerConfigBuilder> action)
Configures the server config to have no base dir and given configuration.
|
Modifier and Type | Method and Description |
---|---|
Action<? super BindingsSpec> |
BindingsImposition.getBindings()
The bindings to add/override.
|
Modifier and Type | Method and Description |
---|---|
BindingsSpec |
BindingsSpec.binder(Action<? super Binder> action)
Adds bindings by directly configuring a
Binder . |
void |
ConfigurableModule.configure(Action<? super T> configurer)
Registers the configuration action.
|
<C,T extends ConfigurableModule<C>> |
BindingsSpec.module(java.lang.Class<T> moduleClass,
Action<? super C> configurer)
Adds the bindings from the given configurable module.
|
<C> BindingsSpec |
BindingsSpec.module(ConfigurableModule<C> module,
Action<? super C> configurer)
Adds the bindings from the given configurable module.
|
<C,T extends ConfigurableModule<C>> |
BindingsSpec.moduleConfig(java.lang.Class<T> moduleClass,
C config,
Action<? super C> configurer)
Adds the bindings from the given configurable module.
|
<C> BindingsSpec |
BindingsSpec.moduleConfig(ConfigurableModule<C> module,
C config,
Action<? super C> configurer)
Adds the bindings from the given configurable module.
|
default <T> BindingsSpec |
BindingsSpec.multiBinder(java.lang.Class<T> type,
Action<? super Multibinder<T>> action) |
default <T> BindingsSpec |
BindingsSpec.multiBinder(TypeLiteral<T> type,
Action<? super Multibinder<T>> action) |
default <T> BindingsSpec |
BindingsSpec.multiBinder(com.google.common.reflect.TypeToken<T> type,
Action<? super Multibinder<T>> action) |
static BindingsImposition |
BindingsImposition.of(Action<? super BindingsSpec> bindings)
Creates a new bindings imposition of the given bindings.
|
static Function<Registry,Registry> |
Guice.registry(Action<? super BindingsSpec> bindings) |
static Function<Registry,Registry> |
Guice.registry(Injector parentInjector,
Action<? super BindingsSpec> bindings) |
Modifier and Type | Method and Description |
---|---|
void |
Context.byContent(Action<? super ByContentSpec> action)
Respond to the request based on the requested content type (i.e.
|
static Handler |
Handlers.byContent(Registry registry,
Action<? super ByContentSpec> action)
Builds a content negotiating handler.
|
void |
Context.byMethod(Action<? super ByMethodSpec> action)
Respond to the request based on the request method.
|
static Handler |
Handlers.byMethod(Registry registry,
Action<? super ByMethodSpec> action)
Builds a multi method handler.
|
default Handler |
Chain.chain(Action<? super Chain> action)
Constructs a handler using the given action to define a chain.
|
static Handler |
Handlers.chain(Registry registry,
Action<? super Chain> action)
Builds a chain, backed by the given registry.
|
static Handler |
Handlers.chain(ServerConfig serverConfig,
Action<? super Chain> action)
Builds a handler chain, with no backing registry.
|
static Handler |
Handlers.chain(ServerConfig serverConfig,
Registry registry,
Action<? super Chain> action)
Builds a chain, backed by the given registry.
|
default Chain |
Chain.files(Action<? super FileHandlerSpec> config)
Adds a handler that serves files from the file system.
|
static Handler |
Handlers.files(ServerConfig serverConfig,
Action<? super FileHandlerSpec> config)
Creates a handler that serves files from the file system.
|
default Chain |
Chain.fileSystem(java.lang.String path,
Action<? super Chain> action)
Adds a handler to this chain that changes the
FileSystemBinding for the given handler chain. |
default Chain |
Chain.host(java.lang.String hostName,
Action<? super Chain> action)
Adds a handler to the chain that delegates to the given handler chain if the request has a
Host header that matches the given value exactly. |
default Chain |
Chain.insert(Action<? super Chain> action)
Inserts the given nested handler chain.
|
static RequestLogger |
RequestLogger.of(Action<? super RequestOutcome> action)
Creates a request logger with the given action as the implementation of the
RequestLogger.log(RequestOutcome) method. |
void |
Context.onClose(Action<? super RequestOutcome> onClose)
Registers a callback to be notified when the request for this context is “closed” (i.e.
|
default Chain |
Chain.prefix(java.lang.String prefix,
Action<? super Chain> action)
Adds a handler that delegates to the given handlers if the
relative path starts with the given
prefix . |
static HandlerDecorator |
HandlerDecorator.prependHandlers(Action<? super Chain> handlers)
A factory for decorator impls that effectively inserts the given chain before the “rest” of the handlers.
|
default Chain |
Chain.register(Action<? super RegistrySpec> action)
Builds a new registry via the given action, then registers it via
Chain.register(Registry) . |
default Chain |
Chain.register(Action<? super RegistrySpec> registryAction,
Action<? super Chain> action)
Adds a handler that inserts the given handler chain with a registry built by the given action via
Context.insert(ratpack.registry.Registry, Handler...) . |
default Chain |
Chain.register(Action<? super RegistrySpec> registryAction,
Action<? super Chain> action)
Adds a handler that inserts the given handler chain with a registry built by the given action via
Context.insert(ratpack.registry.Registry, Handler...) . |
default Chain |
Chain.register(Action<? super RegistrySpec> registryAction,
java.lang.Class<? extends Action<? super Chain>> action) |
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.when(boolean test,
Action<? super Chain> action)
Inlines the given chain if
test is true . |
default Chain |
Chain.when(boolean test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse)
Inlines the appropriate chain based on the given
test . |
default Chain |
Chain.when(boolean test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse)
Inlines the appropriate chain based on the given
test . |
default Chain |
Chain.when(Predicate<? super Context> test,
Action<? super Chain> action) |
default Chain |
Chain.when(Predicate<? super Context> test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse) |
default Chain |
Chain.when(Predicate<? super Context> test,
Action<? super Chain> onTrue,
Action<? super Chain> onFalse) |
Modifier and Type | Method and Description |
---|---|
default Handler |
Chain.chain(java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.fileSystem(java.lang.String path,
java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.host(java.lang.String hostName,
java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.insert(java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.prefix(java.lang.String prefix,
java.lang.Class<? extends Action<? super Chain>> action) |
static HandlerDecorator |
HandlerDecorator.prependHandlers(java.lang.Class<? extends Action<? super Chain>> handlers)
A factory for decorator impls that effectively inserts the given chain before the “rest” of the handlers.
|
default Chain |
Chain.register(Action<? super RegistrySpec> registryAction,
java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.register(Registry registry,
java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> action)
Inlines the given chain if
test is true . |
default Chain |
Chain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse)
Inlines the appropriate chain based on the given
test . |
default Chain |
Chain.when(boolean test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse)
Inlines the appropriate chain based on the given
test . |
default Chain |
Chain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> action) |
default Chain |
Chain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse) |
default Chain |
Chain.when(Predicate<? super Context> test,
java.lang.Class<? extends Action<? super Chain>> onTrue,
java.lang.Class<? extends Action<? super Chain>> onFalse) |
Modifier and Type | Method and Description |
---|---|
void |
DirectChannelAccess.takeOwnership(Action<java.lang.Object> messageReceiver)
Signals that Ratpack should no longer manage this channel.
|
Modifier and Type | Method and Description |
---|---|
Response |
Response.beforeSend(Action<? super Response> responseFinalizer)
Register a callback to execute with the response immediately before sending it to the client.
|
default HttpUrlBuilder |
HttpUrlBuilder.params(Action<? super com.google.common.collect.ImmutableMultimap.Builder<java.lang.String,java.lang.Object>> params)
Add some query params to the URL.
|
Modifier and Type | Method and Description |
---|---|
RequestSpec |
RequestSpec.body(Action<? super RequestSpec.Body> action)
Executes the given action with the
request body . |
HttpClient |
HttpClient.copyWith(Action<? super HttpClientSpec> action)
Create a new HttpClient by appending the provided configuration to this client.
|
HttpClientSpec |
HttpClientSpec.errorIntercept(Action<? super java.lang.Throwable> interceptor)
Add an interceptor for errors thrown by this client (eg.
|
void |
StreamedResponse.forwardTo(Response response,
Action<? super MutableHeaders> headerMutator)
Stream this received response out to the given server response.
|
Promise<ReceivedResponse> |
HttpClient.get(java.net.URI uri,
Action<? super RequestSpec> action)
An asynchronous method to do a GET HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a GET.
|
RequestSpec |
RequestSpec.headers(Action<? super MutableHeaders> action)
This method can be used to buffer changes to the headers.
|
static HttpClient |
HttpClient.of(Action<? super HttpClientSpec> action)
Creates a new HTTP client.
|
Promise<ReceivedResponse> |
HttpClient.post(java.net.URI uri,
Action<? super RequestSpec> action)
An asynchronous method to do a POST HTTP request, the URL and all details of the request are configured by the Action acting on the RequestSpec, but the method will be defaulted to a POST.
|
Promise<ReceivedResponse> |
HttpClient.request(java.net.URI uri,
Action<? super RequestSpec> action)
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.
|
HttpClientSpec |
HttpClientSpec.requestIntercept(Action<? super RequestSpec> interceptor)
Add an interceptor for all requests handled by this client.
|
Promise<StreamedResponse> |
HttpClient.requestStream(java.net.URI uri,
Action<? super RequestSpec> requestConfigurer)
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.
|
HttpClientSpec |
HttpClientSpec.responseIntercept(Action<? super HttpResponse> interceptor)
Add an interceptor for all responses returned by this client.
|
RequestSpec.Body |
RequestSpec.Body.stream(Action<? super java.io.OutputStream> action)
Specifies the request body by writing to an output stream.
|
Modifier and Type | Method and Description |
---|---|
RequestSpec |
RequestSpec.onRedirect(Function<? super ReceivedResponse,Action<? super RequestSpec>> function)
Specifies a function to invoke when a redirectable response is received.
|
Modifier and Type | Method and Description |
---|---|
static Impositions |
Impositions.of(Action<? super ImpositionsSpec> consumer)
Creates an impositions instance of the given imposition objects.
|
Modifier and Type | Method and Description |
---|---|
static MDCInterceptor |
MDCInterceptor.withInit(Action<? super Execution> init)
Creates an interceptor with the given initialisation action.
|
Modifier and Type | Method and Description |
---|---|
static PathBinder |
PathBinder.of(boolean exhaustive,
Action<? super PathBinderBuilder> action)
Builds a path binder programmatically.
|
Modifier and Type | Method and Description |
---|---|
static <T> Flux<T> |
ReactorRatpack.fork(Flux<T> flux,
Action<? super RegistrySpec> doWithRegistrySpec)
A variant of
ReactorRatpack.fork(reactor.core.publisher.Flux<T>) that allows access to the registry of the forked execution inside an Action . |
static <T> Flux<T> |
ReactorRatpack.forkEach(Flux<T> flux,
Action<? super RegistrySpec> doWithRegistrySpec)
A variant of
ReactorRatpack.forkEach(reactor.core.publisher.Flux<T>) that allows access to the registry of each forked execution inside an Action . |
Modifier and Type | Method and Description |
---|---|
static Registry |
Registry.of(Action<? super RegistrySpec> action)
Builds a registry from the given action.
|
default RegistrySpec |
RegistrySpec.with(Action<? super RegistrySpec> action)
Executes the given action with
this . |
default RegistryBuilder |
RegistryBuilder.with(Action<? super RegistrySpec> action) |
Modifier and Type | Method and Description |
---|---|
default Action<RegistrySpec> |
RenderableDecorator.register()
A registration action, typically used with
RegistrySpec.with(Action) . |
Modifier and Type | Method and Description |
---|---|
RatpackRetrofit.Builder |
RatpackRetrofit.Builder.configure(Action<? super Retrofit.Builder> builderAction)
Configure the underlying
Retrofit.Builder instance. |
Modifier and Type | Method and Description |
---|---|
static <T> Observable<T> |
RxRatpack.fork(Observable<T> observable,
Action<? super RegistrySpec> doWithRegistrySpec)
Deprecated.
A variant of
RxRatpack.fork(rx.Observable<T>) that allows access to the registry of the forked execution inside an Action . |
static <T> Observable<T> |
RxRatpack.forkEach(Observable<T> observable,
Action<? super RegistrySpec> doWithRegistrySpec)
Deprecated.
A variant of
RxRatpack.forkEach(rx.Observable<T>) that allows access to the registry of each forked execution inside an Action . |
Modifier and Type | Method and Description |
---|---|
static <T> Observable<T> |
RxRatpack.fork(Observable<T> observable,
Action<? super RegistrySpec> registrySpec)
A variant of
RxRatpack.fork(io.reactivex.Observable<T>) that allows access to the registry of the forked execution inside an Action . |
static <T> Observable<T> |
RxRatpack.forkEach(Observable<T> observable,
Action<? super RegistrySpec> registrySpec)
A variant of
RxRatpack.forkEach(io.reactivex.Observable<T>) that allows access to the registry of each forked execution inside an Action . |
Modifier and Type | Method and Description |
---|---|
ServerConfigBuilder |
ServerConfigBuilder.configureObjectMapper(Action<ObjectMapper> action)
Configures the object mapper used for binding configuration data to arbitrary objects.
|
default java.net.URI |
PublicAddress.get(Action<? super HttpUrlBuilder> action)
Creates a URL by building a URL based on the public address.
|
default java.net.URI |
PublicAddress.get(Context ctx,
Action<? super HttpUrlBuilder> action)
Deprecated.
since 1.2, use
PublicAddress.get(Action) |
default RatpackServerSpec |
RatpackServerSpec.handlers(Action<? super Chain> handlers)
Sets the root handler to the chain specified by the given action.
|
static RatpackServer |
RatpackServer.of(Action<? super RatpackServerSpec> definition)
Creates a new, unstarted, Ratpack server from the given definition.
|
static ServerConfig |
ServerConfig.of(Action<? super ServerConfigBuilder> action) |
ServerConfigBuilder |
ServerConfigBuilder.onError(Action<? super java.lang.Throwable> errorHandler)
Sets the error all that will be used for added configuration sources.
|
default RatpackServerSpec |
RatpackServerSpec.registryOf(Action<? super RegistrySpec> action)
Builds the user registry via the given spec action.
|
default RatpackServerSpec |
RatpackServerSpec.serverConfig(Action<? super ServerConfigBuilder> action) |
static RatpackServer |
RatpackServer.start(Action<? super RatpackServerSpec> definition)
Convenience method to
define and RatpackServer.start() the server in one go. |
Modifier and Type | Method and Description |
---|---|
static Service |
Service.shutdown(java.lang.String name,
Action<? super StopEvent> action)
Creates a service that executes the given action as the
Service.onStop(StopEvent) implementation. |
static Service |
Service.startup(java.lang.String name,
Action<? super StartEvent> action)
Creates a service that executes the given action as the
Service.onStart(StartEvent) implementation. |
Modifier and Type | Method and Description |
---|---|
static Action<Binder> |
SessionModule.memoryStore(java.util.function.Consumer<? super com.google.common.cache.CacheBuilder<io.netty.util.AsciiString,io.netty.buffer.ByteBuf>> config)
A builder for an alternative cache for the default in memory store.
|
Modifier and Type | Method and Description |
---|---|
Action<BindingsSpec> |
RatpackServerCustomizerAdapter.getBindings() |
Action<BindingsSpec> |
RatpackServerCustomizer.getBindings() |
Action<ServerConfigBuilder> |
RatpackServerCustomizerAdapter.getServerConfig() |
Action<ServerConfigBuilder> |
RatpackServerCustomizer.getServerConfig() |
Modifier and Type | Method and Description |
---|---|
java.util.List<Action<Chain>> |
RatpackServerCustomizerAdapter.getHandlers() |
java.util.List<Action<Chain>> |
RatpackServerCustomizer.getHandlers() |
Modifier and Type | Method and Description |
---|---|
Promise<TransformablePublisher<Event<?>>> |
ServerSentEventStreamClient.request(java.net.URI uri,
Action<? super RequestSpec> action) |
static <T> ServerSentEvents |
ServerSentEvents.serverSentEvents(Publisher<T> publisher,
Action<? super Event<T>> action)
Creates a new renderable object wrapping the event stream.
|
Modifier and Type | Method and Description |
---|---|
default TransformablePublisher<T> |
TransformablePublisher.batch(int batchSize,
Action<? super T> disposer)
|
static <T> TransformablePublisher<T> |
Streams.batch(int batchSize,
Publisher<T> publisher,
Action<? super T> disposer)
Batches and serialised demand.
|
default TransformablePublisher<T> |
TransformablePublisher.bindExec(Action<? super T> disposer)
|
static <T> TransformablePublisher<T> |
Streams.bindExec(Publisher<T> publisher,
Action<? super T> disposer)
Binds the given publisher to the current
Execution . |
static <T> TransformablePublisher<T> |
Streams.concat(java.lang.Iterable<? extends Publisher<? extends T>> publishers,
Action<? super T> disposer)
Returns a publisher that aggregates the given publishers into a single stream of elements, without interleaving them.
|
static <T> TransformablePublisher<T> |
Streams.fanOut(Publisher<? extends java.lang.Iterable<? extends T>> publisher,
Action<? super T> disposer)
Returns a publisher that publishes each element from Collections that are produced from the given input publisher.
|
static <T> TransformablePublisher<T> |
Streams.flatten(Publisher<? extends Publisher<T>> publisher,
Action<? super T> disposer)
Creates a single publisher from a publisher of publishers.
|
default TransformablePublisher<T> |
TransformablePublisher.fork(Action<? super ExecSpec> execConfig,
Action<? super T> disposer)
Consumes the given publisher eagerly in a forked execution, buffering results until ready to be consumed by this execution.
|
default TransformablePublisher<T> |
TransformablePublisher.fork(Action<? super ExecSpec> execConfig,
Action<? super T> disposer)
Consumes the given publisher eagerly in a forked execution, buffering results until ready to be consumed by this execution.
|
static <T> TransformablePublisher<T> |
Streams.fork(Publisher<T> publisher,
Action<? super ExecSpec> execConfig,
Action<? super T> disposer)
Consumes the given publisher eagerly in a forked execution, buffering results until ready to be consumed by this execution.
|
static <T> TransformablePublisher<T> |
Streams.fork(Publisher<T> publisher,
Action<? super ExecSpec> execConfig,
Action<? super T> disposer)
Consumes the given publisher eagerly in a forked execution, buffering results until ready to be consumed by this execution.
|
default TransformablePublisher<T> |
TransformablePublisher.gate(Action<? super java.lang.Runnable> valveReceiver)
|
static <T> TransformablePublisher<T> |
Streams.gate(Publisher<T> publisher,
Action<? super java.lang.Runnable> valveReceiver)
Allows requests from the subscriber of the return publisher to be withheld from the given publisher until an externally defined moment.
|
default <O> WriteStream<O> |
WriteStream.itemMap(Action<? super O> itemMapper)
Deprecated.
since 1.4, use
WriteStream.itemMap(Subscription, Action) |
default <O> WriteStream<O> |
WriteStream.itemMap(Subscription subscription,
Action<? super O> itemMapper)
Creates a new write stream that passes error and complete signals on to this stream, but passes items to the given action.
|
default TransformablePublisher<T> |
TransformablePublisher.wiretap(Action<? super StreamEvent<T>> listener)
|
static <T> TransformablePublisher<T> |
Streams.wiretap(Publisher<T> publisher,
Action<? super StreamEvent<T>> listener)
Allows listening to the events of the given publisher as they flow to subscribers.
|
Modifier and Type | Method and Description |
---|---|
default void |
CloseableApplicationUnderTest.test(Action<? super TestHttpClient> action)
Provides the given action with a
test http client for this application, then closes this application. |
Modifier and Type | Method and Description |
---|---|
static EmbeddedApp |
EmbeddedApp.fromHandlers(Action<? super Chain> action)
Creates an embedded application with a default launch config (no base dir, ephemeral port) and the given handler chain.
|
static EmbeddedApp |
EmbeddedApp.fromServer(ServerConfig serverConfig,
Action<? super RatpackServerSpec> definition)
Creates an embedded application using the given server config, and server creating function.
|
static EmbeddedApp |
EmbeddedApp.fromServer(ServerConfigBuilder serverConfig,
Action<? super RatpackServerSpec> definition)
Creates an embedded application using the given server config, and server creating function.
|
static EmbeddedApp |
EmbeddedApp.of(Action<? super RatpackServerSpec> definition)
Creates an embedded application from the given function.
|
default void |
EphemeralBaseDir.use(Action<? super EphemeralBaseDir> action)
Executes the given action with this base dir, then closes this base dir.
|
Modifier and Type | Method and Description |
---|---|
default void |
ExecHarness.run(Action<? super Execution> action)
Initiates an execution and blocks until it completes.
|
void |
ExecHarness.run(Action<? super RegistrySpec> registry,
Action<? super Execution> action)
Initiates an execution and blocks until it completes.
|
void |
ExecHarness.run(Action<? super RegistrySpec> registry,
Action<? super Execution> action)
Initiates an execution and blocks until it completes.
|
static void |
ExecHarness.runSingle(Action<? super Execution> action)
Convenient form of
ExecHarness.run(Action) that creates and closes a harness for the run. |
static void |
ExecHarness.runSingle(Action<? super RegistrySpec> registry,
Action<? super Execution> action)
Convenient form of
ExecHarness.run(Action, Action) that creates and closes a harness for the run. |
static void |
ExecHarness.runSingle(Action<? super RegistrySpec> registry,
Action<? super Execution> action)
Convenient form of
ExecHarness.run(Action, Action) that creates and closes a harness for the run. |
<T> ExecResult<T> |
ExecHarness.yield(Action<? super RegistrySpec> registry,
Function<? super Execution,? extends Promise<T>> func)
Synchronously returns a promised value.
|
static <T> ExecResult<T> |
ExecHarness.yieldSingle(Action<? super RegistrySpec> registry,
Function<? super Execution,? extends Promise<T>> func)
Creates an exec harness,
executes the given function with it before closing it, then returning execution result. |
Modifier and Type | Method and Description |
---|---|
static HandlingResult |
RequestFixture.handle(Action<? super Chain> chainAction,
Action<? super RequestFixture> requestFixtureAction)
Unit test a
Handler chain. |
static HandlingResult |
RequestFixture.handle(Action<? super Chain> chainAction,
Action<? super RequestFixture> requestFixtureAction)
Unit test a
Handler chain. |
static HandlingResult |
RequestFixture.handle(Handler handler,
Action<? super RequestFixture> action)
Unit test a single
Handler . |
HandlingResult |
RequestFixture.handleChain(Action<? super Chain> chainAction)
Similar to
RequestFixture.handle(Handler) , but for testing a handler chain. |
RequestFixture |
RequestFixture.registry(Action<? super RegistrySpec> action)
Configures the context registry.
|
RequestFixture |
RequestFixture.serverConfig(Action<? super ServerConfigBuilder> action)
Configures the server config to have no base dir and given configuration.
|
Modifier and Type | Method and Description |
---|---|
TestHttpClient |
TestHttpClient.params(Action<? super com.google.common.collect.ImmutableMultimap.Builder<java.lang.String,java.lang.Object>> params) |
ReceivedResponse |
TestHttpClient.request(Action<? super RequestSpec> requestAction)
Executes the request as specified by the provided
RequestSpec . |
ReceivedResponse |
TestHttpClient.request(java.lang.String path,
Action<? super RequestSpec> requestAction)
Executes the request as specified by the provided
RequestSpec against the provided path. |
TestHttpClient |
TestHttpClient.requestSpec(Action<? super RequestSpec> requestAction) |
static TestHttpClient |
TestHttpClient.testHttpClient(ApplicationUnderTest applicationUnderTest,
Action<? super RequestSpec> requestConfigurer)
A method to create an instance of the default implementation of TestHttpClient.
|
Modifier and Type | Method and Description |
---|---|
static <T> void |
Exceptions.uncheck(T input,
Action<T> action)
Executes the given action with the provided input argument, unchecking any exceptions it throws.
|
Modifier and Type | Method and Description |
---|---|
void |
WebSocketConnector.connect(Action<? super WebSocketSpec<T>> specAction) |
WebSocketSpec<T> |
WebSocketSpec.onClose(Action<WebSocketClose<T>> action) |
WebSocketSpec<T> |
WebSocketSpec.onMessage(Action<WebSocketMessage<T>> action) |