B

backedBy(RegistryBacking) - Static method in interface ratpack.exec.registry.Registry

Creates a new registry instance that is backed by a RegistryBacking implementation.

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

The 502 status code.

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

The 400 status code.

base(URI) - Static method in interface ratpack.core.http.HttpUrlBuilder

Create a new builder, with the initial state of the given URI.

baseDir(File) - Method in interface ratpack.core.server.ServerConfigBuilder

Calls ServerConfigBuilder.baseDir(Path) after converting the given File to a Path using File.toPath().

baseDir(Path) - Method in interface ratpack.core.server.ServerConfigBuilder

Sets the root of the filesystem for the application.

BaseDir - Class in ratpack.core.server

 

BaseDirRequiredException - Exception in ratpack.core.file

Thrown when the base directory of the application has not been set but is required.

BaseDirRequiredException(String) - Constructor for exception ratpack.core.file.BaseDirRequiredException

Constructor.

basicAuth(String, String) - Method in interface ratpack.core.http.client.RequestSpec

Adds the appropriate header for HTTP Basic authentication with the given username and password.

batch(int, Publisher<T>, Action<? super T>) - Static method in class ratpack.exec.stream.Streams

Batches and serialised demand.

batch(int, Action<? super T>) - Method in interface ratpack.exec.stream.TransformablePublisher

See Streams.batch(int, Publisher, Action).

Batch<T> - Interface in ratpack.exec.util

A batch of promises to be processed.

beforeSend(Action<? super Response>) - Method in interface ratpack.core.http.Response

Register a callback to execute with the response immediately before sending it to the client.

beforeThrow(Action<? super Throwable>) - Static method in interface ratpack.func.Action

Creates an exception-taking action that executes the given action before throwing the exception.

beforeThrow(Block) - Static method in interface ratpack.func.Action

Creates an exception-taking action that executes the given block before throwing the exception.

begin() - Method in interface ratpack.jdbctx.Transaction

Starts a transaction.

BiAction<T,​U> - Interface in ratpack.func

A generic type for an object that does some work with 2 input things.

BiFunction<I1,​I2,​O> - Interface in ratpack.func

 

bind() - Method in interface ratpack.jdbctx.Transaction

Binds this transaction to the current execution.

bind(TypeToken<T>, Class<? extends T>) - Method in interface ratpack.guice.BindingsSpec

 

bind(TypeLiteral<T>, Class<? extends T>) - Method in interface ratpack.guice.BindingsSpec

 

bind(Class<?>) - Method in interface ratpack.guice.BindingsSpec

Add a binding for the given type.

bind(Class<T>, Class<? extends T>) - Method in interface ratpack.guice.BindingsSpec

Add a binding for the given public type, to the given implementation type.

bind(PathBinding) - Method in interface ratpack.core.path.PathBinder

Attempts to bind in the context of the given parent binding.

bindAddress(RatpackServer) - Static method in interface ratpack.core.server.PublicAddress

Uses the serves bind address as the current address.

binder(Action<? super Binder>) - Method in interface ratpack.guice.BindingsSpec

Adds bindings by directly configuring a Binder.

bindExec() - Method in interface ratpack.exec.stream.TransformablePublisher

See Streams.bindExec(Publisher).

bindExec(Observable<T>) - Static method in class ratpack.rx2.RxRatpack

Binds the given observable to the current execution, allowing integration of third-party asynchronous observables with Ratpack's execution model.

bindExec(Publisher<T>) - Static method in class ratpack.exec.stream.Streams

Binds the given publisher to the current Execution.

bindExec(Publisher<T>, Action<? super T>) - Static method in class ratpack.exec.stream.Streams

Binds the given publisher to the current Execution.

bindExec(Action<? super T>) - Method in interface ratpack.exec.stream.TransformablePublisher

See Streams.bindExec(Publisher, Action).

bindExec(Flux<T>) - Static method in class ratpack.reactor.ReactorRatpack

Binds the given flux to the current execution, allowing integration of third-party asynchronous fluxes with Ratpack's execution model.

binding(String) - Method in interface ratpack.config.FileSystemBinding

Construct a new binding by using the given path as a relative path from this bind point.

bindings() - Static method in class ratpack.groovy.Groovy.Script

Creates a registry building function from a Groovy script named "bindings.groovy".

bindings(boolean) - Static method in class ratpack.groovy.Groovy.Script

Creates a registry building function from a Groovy script named "bindings.groovy".

bindings(boolean, String) - Static method in class ratpack.groovy.Groovy.Script

Creates a registry building function from a Groovy script.

bindings(Closure<?>) - Method in interface ratpack.groovy.Groovy.Ratpack

Registers the closure used to configure the BindingsSpec that will back the application.

BindingsImposition - Class in ratpack.guice

An imposition of additional and overridden Guice bindings, used by Guice.registry(Action) and similar methods.

BindingsSpec - Interface in ratpack.guice

A buildable specification of Guice bindings.

bindingsWithArgs(boolean, String, String...) - Static method in class ratpack.groovy.Groovy.Script

Creates a registry building function from a Groovy script.

bindInstance(TypeToken<? super T>, T) - Method in interface ratpack.guice.BindingsSpec

 

bindInstance(TypeLiteral<? super T>, T) - Method in interface ratpack.guice.BindingsSpec

Add a binding for the given public type, to the given implementing instance.

bindInstance(Class<? super T>, T) - Method in interface ratpack.guice.BindingsSpec

 

bindInstance(T) - Method in interface ratpack.guice.BindingsSpec

Add a binding for the given object to its concrete type.

bindSessionTypeFilterPlugin(Binder) - Static method in class ratpack.session.SessionModule

Creates a multi-binding binder for a SessionTypeFilterPlugin.

Block - Interface in ratpack.func

A block of code.

blocking(Action<? super ExecControllerSpec.BlockingSpec>) - Method in interface ratpack.exec.ExecControllerSpec

Configures the default executor for blocking (i.e.

Blocking - Class in ratpack.exec

Facilitates working with code that blocks (e.g.

BLOCKING - ratpack.exec.ExecInterceptor.ExecType

The execution segment is executing on a blocking thread.

BlockingExecTimingInterceptor - Interface in ratpack.dropwizard.metrics

 

blockingMap(Function<? super T, ? extends O>) - Method in interface ratpack.exec.Promise

Like Promise.map(Function), but performs the transformation on a blocking thread.

blockingNext(Block) - Method in interface ratpack.exec.Operation

Executes the given block as an operation, on a blocking thread.

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

Executes the given action with the promise value, on a blocking thread.

blockingTimingMetrics(boolean) - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig

The state of blocking timing metrics reporting.

Blocks - Annotation Type in ratpack.exec.api

 

body(byte[], String) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture

Sets the request body to be the given bytes, and adds a Content-Type request header of the given value.

body(byte[], String) - Method in interface ratpack.test.handling.RequestFixture

Sets the request body to be the given bytes, and adds a Content-Type request header of the given value.

body(String, String) - Method in interface ratpack.groovy.test.handling.GroovyRequestFixture

Sets the request body to be the given string in utf8 bytes, and adds a Content-Type request header of the given value.

body(String, String) - Method in interface ratpack.test.handling.RequestFixture

Sets the request body to be the given string in utf8 bytes, and adds a Content-Type request header of the given value.

body(Action<? super RequestSpec.Body>) - Method in interface ratpack.core.http.client.RequestSpec

Executes the given action with the request body.

bound(Factory<? extends Connection>) - Static method in interface ratpack.jdbctx.Transaction

Creates a transaction implementation that delegates to the execution bound transaction.

buffer() - Method in interface ratpack.exec.stream.TransformablePublisher

See Streams.buffer(Publisher).

buffer(ByteBuf) - Method in interface ratpack.core.http.client.RequestSpec.Body

Specifies the request body as a byte buffer.

buffer(Publisher<? extends ByteBuf>, long, int) - Static method in class ratpack.exec.stream.bytebuf.ByteBufStreams

Buffers and composes byte bufs together into composites before emitting.

buffer(Publisher<? extends ByteBuf>, long, int, ByteBufAllocator) - Static method in class ratpack.exec.stream.bytebuf.ByteBufStreams

Buffers and composes byte bufs together into composites before emitting.

buffer(Publisher<T>) - Static method in class ratpack.exec.stream.Streams

Returns a publisher that allows the given publisher to without respecting demand.

bufferChunks(CharSequence, Publisher<? extends ByteBuf>) - Static method in class ratpack.core.http.ResponseChunks

Transmit each set of bytes emitted by the publisher as a chunk.

buffered() - Method in interface ratpack.core.sse.ServerSentEventsBuilder

Applies sensible buffering defaults, for low latency.

buffered(int, int, Duration) - Method in interface ratpack.core.sse.ServerSentEventsBuilder

Specifies how events should be buffered.

build() - Method in interface ratpack.config.ConfigDataBuilder

Creates the config data, based on the state of this builder.

build() - Method in interface ratpack.core.http.HttpUrlBuilder

Builds the URI based on this builder's current state.

build() - Method in interface ratpack.core.server.ServerConfigBuilder

Builds the server config.

build() - Method in interface ratpack.core.sse.ServerSentEventBuilder

Builds the event.

build() - Method in interface ratpack.exec.registry.RegistryBuilder

Builds the registry.

build() - Method in interface ratpack.exec.util.retry.AttemptRetryPolicyBuilder

Builds an AttemptRetryPolicy.

build() - Method in interface ratpack.exec.util.retry.DurationRetryPolicyBuilder

Builds a DurationRetryPolicy.

build(boolean) - Method in interface ratpack.core.path.PathBinderBuilder

Generate a PathBinder from the contents of the builder.

build(Class<T>) - Method in class ratpack.retrofit.RatpackRetrofit.Builder

Uses this builder to create a Retrofit client implementation.

build(Publisher<? extends ServerSentEvent>) - Method in interface ratpack.core.sse.ServerSentEventsBuilder

Builds the server sent events with the given publisher.

build(Registry) - Method in class ratpack.core.impose.UserRegistryImposition

Returns the registry of additions, taking the original user registry as the argument.

builder() - Static method in interface ratpack.config.ConfigData

 

builder() - Static method in interface ratpack.core.path.PathBinder

Creates a new path binder builder.

builder() - Method in interface ratpack.core.server.PublicAddress

Creates a URL builder using the public address as the base.

builder() - Static method in interface ratpack.core.server.ServerConfig

 

builder() - Static method in interface ratpack.core.sse.ServerSentEvent

Creates a builder for an event.

builder() - Static method in class ratpack.core.sse.ServerSentEvents

Creates a builder for an event stream.

builder() - Static method in interface ratpack.exec.registry.Registry

Creates a new registry builder.

builder(ObjectMapper) - Static method in interface ratpack.config.ConfigData

 

builder(Environment) - Static method in interface ratpack.config.ConfigData

 

builder(Environment, ObjectMapper) - Static method in interface ratpack.config.ConfigData

 

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

Groovy friendly overload of Context.byContent(Action).

byContent(Registry, Closure<?>) - Static method in class ratpack.groovy.Groovy

Builds a content negotiating handler.

byContent(Registry, Action<? super ByContentSpec>) - Static method in class ratpack.core.handling.Handlers

Builds a content negotiating handler.

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

Respond to the request based on the requested content type (i.e.

ByContentSpec - Interface in ratpack.core.handling

A specification of how to respond to a request, based on the requested content type (i.e.

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

Groovy friendly overload of Context.byMethod(Action).

byMethod(Registry, Closure<?>) - Static method in class ratpack.groovy.Groovy

Builds a multi method handler.

byMethod(Registry, Action<? super ByMethodSpec>) - Static method in class ratpack.core.handling.Handlers

Builds a multi method handler.

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

Respond to the request based on the request method.

ByMethodSpec - Interface in ratpack.core.handling

A specification of how to respond to a request, based on the requested method.

byteBufAllocator() - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig

 

byteBufAllocator(ByteBufAllocator) - Method in interface ratpack.core.http.client.HttpClientSpec

The buffer allocator to use.

byteBufAllocator(Action<? super ByteBufAllocatorConfig>) - Method in class ratpack.dropwizard.metrics.DropwizardMetricsConfig

Configure the byte buf allocator metric set.

ByteBufAllocatorConfig - Class in ratpack.dropwizard.metrics

Configuration for collecting metrics about ByteBufAllocator.

ByteBufAllocatorConfig() - Constructor for class ratpack.dropwizard.metrics.ByteBufAllocatorConfig

 

ByteBufRef - Class in ratpack.core.bytebuf

A byte buf that is backed by another, but has its own ref count lifecycle.

ByteBufRef(ByteBuf) - Constructor for class ratpack.core.bytebuf.ByteBufRef

 

ByteBufStreams - Class in ratpack.exec.stream.bytebuf

Utilities for dealing with streams of ByteBuf.

bytes(byte[]) - Method in interface ratpack.core.http.client.RequestSpec.Body

Specifies the request body as a byte array.

bytesBefore(byte) - Method in class ratpack.core.bytebuf.ByteBufRef

 

bytesBefore(int, byte) - Method in class ratpack.core.bytebuf.ByteBufRef

 

bytesBefore(int, int, byte) - Method in class ratpack.core.bytebuf.ByteBufRef