O

object(String, Object) - Method in interface ratpack.config.ConfigDataBuilder

Adds the object's fields at the given path as a configuration source.

object(String, Object) - Method in interface ratpack.core.server.ServerConfigBuilder

Adds the object's fields at the given path as a configuration source.

observe(Promise<I>) - Static method in class ratpack.rx2.RxRatpack

Observe a promise list as an observable stream.

of(boolean) - Static method in class ratpack.core.impose.ForceDevelopmentImposition

Creates a new imposition of the specified value.

of(boolean, Action<? super PathBinderBuilder>) - Static method in interface ratpack.core.path.PathBinder

Builds a path binder programmatically.

of(int) - Static method in interface ratpack.core.http.Status

Creates a new status object.

of(int) - Static method in class ratpack.core.impose.ForceServerListenPortImposition

Creates an imposition that forces the use of the specified port.

of(int, String) - Static method in interface ratpack.core.http.Status

Creates a new status object.

of(ObjectMapper, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData

 

of(TypeToken<T>) - Static method in class ratpack.core.parse.Parse

Creates a parse object, with no options.

of(TypeToken<T>, O) - Static method in class ratpack.core.parse.Parse

Creates a parse object.

of(Closure<?>) - Static method in interface ratpack.groovy.test.embed.GroovyEmbeddedApp

Groovy version of EmbeddedApp.of(Action) that accepts Closure to configure the application.

of(CharSequence) - Static method in interface ratpack.core.handling.RequestId

Creates a new request ID from the given string.

of(Class<T>) - Static method in class ratpack.core.parse.Parse

Creates a parse object, with no options.

of(Class<T>) - Static method in interface ratpack.session.SessionKey

Creates a key of the given type with no name.

of(Class<T>, BiConsumer<? super Context, ? super T>) - Static method in interface ratpack.core.render.Renderer

Creates a renderer implementation from the given arguments.

of(Class<T>, BiFunction<? super Context, ? super T, ? extends T>) - Static method in interface ratpack.core.render.RenderableDecorator

Creates a renderable decorator implementation for the given type that uses the function as decorator.

of(Class<T>, O) - Static method in class ratpack.core.parse.Parse

Creates a parse object.

of(Iterable<? extends Promise<? extends T>>) - Static method in interface ratpack.exec.util.ParallelBatch

Creates a new parallel batch of the given promises.

of(Iterable<? extends Promise<? extends T>>) - Static method in interface ratpack.exec.util.SerialBatch

Creates a new serial batch of the given promises.

of(String) - Static method in interface ratpack.core.handling.UserId

Creates new user identifier of the given string.

of(String) - Static method in interface ratpack.core.http.HttpMethod

Creates a method of the given name.

of(String) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name with no type.

of(String, Class<T>) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name and type.

of(String, Function<? super Registry, ? extends Promise<HealthCheck.Result>>) - Static method in interface ratpack.core.health.HealthCheck

Convenience factory for health check implementations.

of(URI) - Static method in interface ratpack.core.server.PublicAddress

Creates a new public address object using the given URI.

of(Path) - Static method in interface ratpack.config.FileSystemBinding

 

of(Duration) - Static method in class ratpack.exec.util.retry.FixedDelay

Builds a fixed duration delay.

of(Consumer<? super ServerConfigBuilder>) - Static method in class ratpack.core.impose.ServerConfigImposition

Creates an override that applies the given function to the server config builder.

of(Function<? super Integer, Duration>) - Static method in class ratpack.exec.util.retry.IndexedDelay

Builds an index based delay.

of(L, R) - Static method in class ratpack.func.Pair

Creates a new pair.

of(Environment, ObjectMapper, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData

Builds a new config data with the specified object mapper, from the given definition.

of(Environment, Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData

Builds a new config data with the default object mapper, from the given definition.

of(HttpClient) - Static method in interface ratpack.core.sse.client.ServerSentEventClient

Creates a client that uses the given HTTP client.

of(RatpackServer) - Static method in class ratpack.test.ServerBackedApplicationUnderTest

Creates a new instance backed by the given server.

of(Promise<? extends T>...) - Static method in interface ratpack.exec.util.ParallelBatch

Creates a new parallel batch of the given promises.

of(Promise<? extends T>...) - Static method in interface ratpack.exec.util.SerialBatch

Creates a new serial batch of the given promises.

of(Registry) - Static method in class ratpack.core.impose.UserRegistryImposition

Creates an imposition of the given registry.

of(Result<T>) - Static method in interface ratpack.exec.ExecResult

Wraps the given result as an exec result.

of(Action<? super ConfigDataBuilder>) - Static method in interface ratpack.config.ConfigData

 

of(Action<? super RequestOutcome>) - Static method in interface ratpack.core.handling.RequestLogger

Creates a request logger with the given action as the implementation of the RequestLogger.log(RequestOutcome) method.

of(Action<? super HttpClientSpec>) - Static method in interface ratpack.core.http.client.HttpClient

Creates a new HTTP client.

of(Action<? super ImpositionsSpec>) - Static method in class ratpack.core.impose.Impositions

Creates an impositions instance of the given imposition objects.

of(Action<? super RatpackServerSpec>) - Static method in interface ratpack.core.server.RatpackServer

Creates a new, unstarted, Ratpack server from the given definition.

of(Action<? super RatpackServerSpec>) - Static method in interface ratpack.test.embed.EmbeddedApp

Creates an embedded application from the given function.

of(Action<? super ServerConfigBuilder>) - Static method in interface ratpack.core.server.ServerConfig

 

of(Action<? super ExecControllerSpec>) - Static method in interface ratpack.exec.ExecController

Construct a new execution controller from the provided specification.

of(Action<? super RegistrySpec>) - Static method in interface ratpack.exec.registry.Registry

Builds a registry from the given action.

of(Action<? super AttemptRetryPolicyBuilder>) - Static method in class ratpack.exec.util.retry.AttemptRetryPolicy

Builds a new attempt based retry policy from the given definition.

of(Action<? super DurationRetryPolicyBuilder>) - Static method in class ratpack.exec.util.retry.DurationRetryPolicy

Builds a new duration based retry policy from the given definition.

of(Action<? super BindingsSpec>) - Static method in class ratpack.guice.BindingsImposition

Creates a new bindings imposition of the given bindings.

of(Block) - Static method in class ratpack.core.handling.Handlers

Creates a handler from the given block

of(Block) - Static method in interface ratpack.exec.Operation

 

of(Factory<? extends RatpackServer>) - Static method in class ratpack.test.ServerBackedApplicationUnderTest

Creates a new instance backed by the server returned by the given function.

of(Function<? super Registry, ? extends Registry>) - Static method in class ratpack.core.impose.UserRegistryImposition

Creates an imposition of registry returned by the given function.

of(HandlerFactory) - Static method in class ratpack.test.mock.MockApi

Creates an embedded Ratpack server which delegates handling to the provided factory.

ofAsync(Class<T>, BiFunction<? super Context, ? super T, ? extends Promise<T>>) - Static method in interface ratpack.core.render.RenderableDecorator

Creates a renderable decorator implementation for the given type that uses the function as decorator.

ofNull() - Static method in interface ratpack.exec.Promise

A promise for null.

ofSize(int) - Static method in interface ratpack.exec.Throttle

Create a new throttle of the given size.

ofType(String, T) - Static method in interface ratpack.session.SessionKey

Creates a key of the given name, and the type of the given object (as provided by Object.getClass()).

ofType(T) - Static method in interface ratpack.session.SessionKey

Creates a key of type of the given object (as provided by Object.getClass()), and no name.

OK - Static variable in interface ratpack.core.http.Status

The 200 status code.

on(Promise<T>) - Static method in class ratpack.exec.Blocking

Blocks execution waiting for this promise to complete and returns the promised value.

onClose(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyContext

Adds a request close handler.

onClose(WebSocketClose<T>) - Method in class ratpack.core.websocket.AutoCloseWebSocketHandler

 

onClose(WebSocketClose<T>) - Method in interface ratpack.core.websocket.WebSocketHandler

 

onClose(Action<? super RequestOutcome>) - Method in interface ratpack.core.handling.Context

Registers a callback to be notified when the request for this context is “closed” (i.e.

onClose(Action<WebSocketClose<T>>) - Method in interface ratpack.core.websocket.WebSocketSpec

 

onClose(Block) - Method in interface ratpack.exec.ExecController

Registers a block to be executed when this controller closes.

onComplete(AutoCloseable) - Method in interface ratpack.exec.Execution

Registers a closeable that will be closed when the execution completes.

onComplete(Action<? super Execution>) - Method in interface ratpack.exec.ExecSpec

Specifies the completion callback for the execution.

onComplete(Action<? super Execution>) - Method in interface ratpack.exec.ExecStarter

Specifies the completion callback for the execution.

onComplete(Block) - Method in interface ratpack.exec.Downstream

Wrap this downstream, using the given action as the implementation of the Downstream.complete() method.

onComplete(Block) - Method in interface ratpack.exec.Promise

Specifies the action to take if the Upstream signals complete without emitting a value or an error.

oneCookie(String) - Method in interface ratpack.core.http.Request

Returns the value of the cookie with the specified name if it was sent.

onError(Class<E>, Action<? super E>) - Method in interface ratpack.exec.Operation

Specifies the action to take if the an error of the given type occurs trying to perform the operation.

onError(Class<E>, Action<? super E>) - Method in interface ratpack.exec.Promise

Specifies the action to take if the an error of the given type occurs trying to produce the promised value.

onError(Action<? super Throwable>) - Method in interface ratpack.config.ConfigDataBuilder

Sets the error all that will be used for added configuration sources.

onError(Action<? super Throwable>) - Method in interface ratpack.core.server.ServerConfigBuilder

Sets the error all that will be used for added configuration sources.

onError(Action<? super Throwable>) - Method in interface ratpack.exec.Downstream

Wrap this downstream, using the given action as the implementation of the Downstream.error(Throwable) method.

onError(Action<? super Throwable>) - Method in interface ratpack.exec.ExecSpec

Specify the top level error handler for the execution.

onError(Action<? super Throwable>) - Method in interface ratpack.exec.ExecStarter

Specify the top level error handler for the execution.

onError(Action<? super Throwable>) - Method in interface ratpack.exec.Operation

 

onError(Action<? super Throwable>) - Method in interface ratpack.exec.Promise

Specifies the action to take if an error occurs trying to produce the promised value.

onError(Predicate<? super Throwable>, Action<? super Throwable>) - Method in interface ratpack.exec.Operation

Specifies the action to take if the an error occurs performing the operation that the given predicate applies to.

onError(Predicate<? super Throwable>, Action<? super Throwable>) - Method in interface ratpack.exec.Promise

Specifies the action to take if the an error occurs trying to produce the promised value, that the given predicate applies to.

onlyIf(Closure<?>, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

 

onlyIf(Closure<?>, Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain

 

onlyIf(Closure<?>, Handler) - Method in interface ratpack.groovy.handling.GroovyChain

 

onlyIf(Predicate<? super Context>, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

 

onlyIf(Predicate<? super Context>, Class<? extends Handler>) - Method in interface ratpack.core.handling.Chain

 

onlyIf(Predicate<? super Context>, Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain

onlyIf(Predicate<? super Context>, Handler) - Method in interface ratpack.core.handling.Chain

Invokes the given handler only if the predicate passes.

onlyIf(Predicate<? super Context>, Handler) - Static method in class ratpack.core.handling.Handlers

Creates a handler that delegates to the given handler if the predicate applies to the context.

onlyIf(Predicate<? super Context>, Handler) - Method in interface ratpack.groovy.handling.GroovyChain

Invokes the given handler only if the predicate passes.

onMessage(WebSocketMessage<T>) - Method in class ratpack.core.websocket.AutoCloseWebSocketHandler

 

onMessage(WebSocketMessage<T>) - Method in interface ratpack.core.websocket.WebSocketHandler

 

onMessage(Action<WebSocketMessage<T>>) - Method in interface ratpack.core.websocket.WebSocketSpec

 

onNull(Block) - Method in interface ratpack.exec.Promise

A convenience shorthand for routing null values.

onOpen(WebSocket) - Method in class ratpack.core.websocket.AutoCloseWebSocketHandler

 

onOpen(WebSocket) - Method in interface ratpack.core.websocket.WebSocketHandler

 

onRedirect(Function<? super ReceivedResponse, Action<? super RequestSpec>>) - Method in interface ratpack.core.http.client.RequestSpec

Specifies a function to invoke when a redirectable response is received.

onStart(StartEvent) - Method in interface ratpack.core.service.Service

Server startup event.

onStart(Action<? super Execution>) - Method in interface ratpack.exec.ExecSpec

Specifies an action to be taken just before the execution starts.

onStart(Action<? super Execution>) - Method in interface ratpack.exec.ExecStarter

Specifies an action to be taken just before the execution starts.

onStop(StopEvent) - Method in interface ratpack.core.service.Service

Server stop event.

onStop(StopEvent) - Method in class ratpack.hikari.HikariService

 

onSuccess(Action<? super O>) - Method in interface ratpack.exec.Downstream

Wrap this downstream, using the given action as the implementation of the Downstream.success(T) method.

onYield(Runnable) - Method in interface ratpack.exec.Promise

Registers a listener that is invoked when this promise is initiated.

op(Block) - Static method in class ratpack.exec.Blocking

 

open(Path, OpenOption...) - Static method in class ratpack.core.file.FileIo

Creates a promise for an (open) async file channel.

open(Path, Set<? extends OpenOption>, FileAttribute<?>...) - Static method in class ratpack.core.file.FileIo

Creates a promise for an (open) async file channel.

operation() - Method in interface ratpack.exec.Promise

Converts this promise to an operation, by effectively discarding the result.

operation(Action<? super T>) - Method in interface ratpack.exec.Promise

Converts this promise to an operation which is effectively action.

Operation - Interface in ratpack.exec

A logical operation.

optionalToken(String) - Method in interface ratpack.core.path.PathBinderBuilder

Add an optional token to the path.

optionalTokenWithPattern(String, String) - Method in interface ratpack.core.path.PathBinderBuilder

Add a regular expression parameterized named optional token to the path.

options() - Static method in class ratpack.core.handling.Handlers

A handler that delegates to the next handler if the request is OPTIONS, otherwise raises a 405 client error.

options() - Method in interface ratpack.core.http.client.RequestSpec

Specifies to use the OPTIONS request method.

options() - Method in interface ratpack.test.http.TestHttpClient

Make a OPTIONS request with a path of "" this is the same as calling options("").

options(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec

Inserts the handler to chain if the request has a HTTP method of OPTIONS.

options(Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the request HTTPMethod is OPTIONS and the path is at the current root.

options(Class<? extends Handler>) - Method in interface ratpack.core.handling.ByMethodSpec

Inserts the handler to chain if the request has a HTTP method of OPTIONS.

options(Class<? extends Handler>) - Method in interface ratpack.core.handling.Chain

 

options(Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec

Inserts the handler to chain if the request has a HTTP method of OPTIONS.

options(Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain

options(String) - Method in interface ratpack.test.http.TestHttpClient

Make a OPTIONS request to the specified path.

options(String, Closure<?>) - Method in interface ratpack.groovy.handling.GroovyChain

Adds a Handler to this GroovyChain that delegates to the given Closure as a Handler if the relative path matches the given path and the request HTTPMethod is OPTIONS.

options(String, Class<? extends Handler>) - Method in interface ratpack.core.handling.Chain

 

options(String, Class<? extends Handler>) - Method in interface ratpack.groovy.handling.GroovyChain

options(String, Handler) - Method in interface ratpack.core.handling.Chain

Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is OPTIONS.

options(String, Handler) - Method in interface ratpack.groovy.handling.GroovyChain

Adds a handler that delegates to the given handler if the relative path matches the given path and the request HTTPMethod is OPTIONS.

options(Handler) - Method in interface ratpack.core.handling.ByMethodSpec

Inserts the handler to chain if the request has a HTTP method of OPTIONS.

options(Handler) - Method in interface ratpack.core.handling.Chain

Adds a handler that delegates to the given handler if the request HTTPMethod is OPTIONS and the path is at the current root.

options(Handler) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec

Inserts the handler to chain if the request has a HTTP method of OPTIONS.

options(Handler) - Method in interface ratpack.groovy.handling.GroovyChain

Adds a handler that delegates to the given handler if the request HTTPMethod is OPTIONS and the path is at the current root.

options(Block) - Method in interface ratpack.core.handling.ByMethodSpec

Defines the action to to take if the request has a HTTP method of OPTIONS.

options(Block) - Method in interface ratpack.groovy.handling.GroovyByMethodSpec

Defines the action to to take if the request has a HTTP method of OPTIONS.

OPTIONS - Static variable in interface ratpack.core.http.HttpMethod

The OPTIONS method.

optionsText() - Method in interface ratpack.test.http.TestHttpClient

A convenience method for doing a OPTIONS request then calling ReceivedResponse.getBody() then TypedData.getText().

optionsText(String) - Method in interface ratpack.test.http.TestHttpClient

A convenience method for doing a OPTIONS request then calling ReceivedResponse.getBody() then TypedData.getText().

order() - Method in class ratpack.core.bytebuf.ByteBufRef

Deprecated.

order(ByteOrder) - Method in class ratpack.core.bytebuf.ByteBufRef

Deprecated.

OverlappingExecutionException - Exception in ratpack.exec

An instance of this exception will be logged when execution overlaps.

OverlappingExecutionException(String) - Constructor for exception ratpack.exec.OverlappingExecutionException

Constructor.

OverlappingExecutionException(String, Throwable) - Constructor for exception ratpack.exec.OverlappingExecutionException

Constructor.