Package dev.restate.sdk

Class HandlerRunner.Options

java.lang.Object

dev.restate.sdk.HandlerRunner.Options

All Implemented Interfaces:

HandlerRunner.Options

Enclosing class:

HandlerRunner<REQ,RES>

public static final class HandlerRunner.Options
extends Object
implements HandlerRunner.Options

HandlerRunner options, to configure the executor to use to run your services, and the interceptors.

By default, executor will be configured to use virtual threads on Java 21+, or fallback to Executors.newCachedThreadPool() for Java < 21. The bounded pool is shared among all HandlerRunner instances, and is used by Restate.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>)/Context.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>) as well.

HandlerInterceptor.Factory and RunInterceptor.Factory registered via SPI are also loaded by default.

Field Summary

Fields

Modifier and Type	Field	Description
static final HandlerRunner.Options	DEFAULT	Deprecated, for removal: This API element is subject to removal in a future version. Create a new instance of Options instead.

Constructor Summary

Constructors

Constructor	Description
Options()	Create new options, check HandlerRunner.Options for the defaults documentation.

Method Summary

Modifier and Type	Method	Description
HandlerRunner.Options	addHandlerInterceptorFactory(HandlerInterceptor.Factory factory)	Append a HandlerInterceptor.Factory to the factories, as innermost in the chain.
HandlerRunner.Options	addRunContextPropagator(RunContextPropagator propagator)	Append a RunContextPropagator.
HandlerRunner.Options	addRunInterceptorFactory(RunInterceptor.Factory factory)	Append a RunInterceptor.Factory to the factories, as innermost in the chain.
Executor	executor()
List<HandlerInterceptor.Factory>	handlerInterceptorFactories()
List<RunContextPropagator>	runContextPropagators()
List<RunInterceptor.Factory>	runInterceptorFactories()
HandlerRunner.Options	setExecutor(Executor executor)	Set the given executor as the handler executor.
HandlerRunner.Options	setHandlerInterceptorFactories(List<HandlerInterceptor.Factory> newFactories)	Overwrite the HandlerInterceptor.Factory chain with a new chain.
HandlerRunner.Options	setRunContextPropagators(List<RunContextPropagator> newPropagators)	Overwrite the RunContextPropagator list.
HandlerRunner.Options	setRunInterceptorFactories(List<RunInterceptor.Factory> newFactories)	Overwrite the RunInterceptor.Factory chain with a new chain.
static HandlerRunner.Options	withExecutor(Executor executor)	Create an instance of HandlerRunner.Options with the given executor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

@Deprecated(forRemoval=true)
public static final HandlerRunner.Options DEFAULT

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new instance of Options instead.

Constructor Details

Options

public Options()

Create new options, check HandlerRunner.Options for the defaults documentation.

Method Details

withExecutor

public static HandlerRunner.Options withExecutor(Executor executor)

Create an instance of HandlerRunner.Options with the given executor.

The given executor is used for running the handler code, and Restate.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>)/Context.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>) as well.

setExecutor

public HandlerRunner.Options setExecutor(Executor executor)

Set the given executor as the handler executor.

The given executor is used for running the handler code, and Restate.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>)/Context.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>) as well.

Returns:

self for fluency

addHandlerInterceptorFactory

public HandlerRunner.Options addHandlerInterceptorFactory(HandlerInterceptor.Factory factory)

Append a HandlerInterceptor.Factory to the factories, as innermost in the chain.

Returns:

self for fluency

addRunInterceptorFactory

public HandlerRunner.Options addRunInterceptorFactory(RunInterceptor.Factory factory)

Append a RunInterceptor.Factory to the factories, as innermost in the chain.

Returns:

self for fluency

setHandlerInterceptorFactories

public HandlerRunner.Options setHandlerInterceptorFactories(List<HandlerInterceptor.Factory> newFactories)

Overwrite the HandlerInterceptor.Factory chain with a new chain.

Returns:

self for fluency

setRunInterceptorFactories

public HandlerRunner.Options setRunInterceptorFactories(List<RunInterceptor.Factory> newFactories)

Overwrite the RunInterceptor.Factory chain with a new chain.

Returns:

self for fluency

addRunContextPropagator

public HandlerRunner.Options addRunContextPropagator(RunContextPropagator propagator)

Append a RunContextPropagator. Propagators capture thread-local state at Restate.run(java.lang.String, java.lang.Class<T>, dev.restate.common.function.ThrowingSupplier<T>) submission and restore it around the closure execution on the worker thread. The first registered propagator captures/restores outermost.

Returns:

self for fluency

setRunContextPropagators

public HandlerRunner.Options setRunContextPropagators(List<RunContextPropagator> newPropagators)

Overwrite the RunContextPropagator list.

Returns:

self for fluency

executor

public Executor executor()

handlerInterceptorFactories

public List<HandlerInterceptor.Factory> handlerInterceptorFactories()

runInterceptorFactories

public List<RunInterceptor.Factory> runInterceptorFactories()

runContextPropagators

public List<RunContextPropagator> runContextPropagators()