Interface HandlerContext

public interface HandlerContext

Internal interface to access Restate functionalities. Users can use the ad-hoc RestateContext interfaces provided by the various implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	HandlerContext.Awakeable
static final record	HandlerContext.CallResult
static interface	HandlerContext.RunCompleter

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AsyncResult<Slice>>	attachInvocation(String invocationId)
HeadersAccessor	attemptHeaders()	Restate-protocol-level HTTP headers received on the current invocation attempt.
CompletableFuture<HandlerContext.Awakeable>	awakeable()
CompletableFuture<HandlerContext.CallResult>	call(Target target, Slice parameter, @Nullable String idempotencyKey, @Nullable String limitKey, @Nullable Collection<Map.Entry<String,String>> headers)
default CompletableFuture<HandlerContext.CallResult>	call(Target target, Slice parameter, @Nullable String idempotencyKey, @Nullable Collection<Map.Entry<String,String>> headers)	Deprecated.
CompletableFuture<Void>	cancelInvocation(String invocationId)
boolean	canReadPromises()
boolean	canReadState()
boolean	canWritePromises()
boolean	canWriteState()
CompletableFuture<Void>	clear(String name)
CompletableFuture<Void>	clearAll()
AsyncResult<Void>	createAllAsyncResult(List<AsyncResult<?>> children)
AsyncResult<Integer>	createAnyAsyncResult(List<AsyncResult<?>> children)
void	fail(Throwable cause)
CompletableFuture<AsyncResult<Optional<Slice>>>	get(String name)
CompletableFuture<AsyncResult<Output<Slice>>>	getInvocationOutput(String invocationId)
CompletableFuture<AsyncResult<Collection<String>>>	getKeys()
String	objectKey()
CompletableFuture<AsyncResult<Output<Slice>>>	peekPromise(String key)
CompletableFuture<AsyncResult<Slice>>	promise(String key)
CompletableFuture<Void>	rejectAwakeable(String id, TerminalException reason)
CompletableFuture<AsyncResult<Void>>	rejectPromise(String key, TerminalException reason)
CompletableFuture<Void>	rejectSignal(String invocationId, String name, TerminalException reason)
HandlerRequest	request()
CompletableFuture<Void>	resolveAwakeable(String id, Slice payload)
CompletableFuture<AsyncResult<Void>>	resolvePromise(String key, Slice payload)
CompletableFuture<Void>	resolveSignal(String invocationId, String name, Slice payload)
CompletableFuture<AsyncResult<String>>	send(Target target, Slice parameter, @Nullable String idempotencyKey, @Nullable String limitKey, @Nullable Collection<Map.Entry<String,String>> headers, @Nullable Duration delay)
default CompletableFuture<AsyncResult<String>>	send(Target target, Slice parameter, @Nullable String idempotencyKey, @Nullable Collection<Map.Entry<String,String>> headers, @Nullable Duration delay)	Deprecated.
CompletableFuture<Void>	set(String name, Slice value)
CompletableFuture<AsyncResult<Slice>>	signal(String name)
CompletableFuture<AsyncResult<Slice>>	submitRun(@Nullable String name, Consumer<HandlerContext.RunCompleter> closure)
CompletableFuture<AsyncResult<Void>>	timer(Duration duration, @Nullable String name)
CompletableFuture<Void>	writeOutput(Slice value)	Deprecated, for removal: This API element is subject to removal in a future version.
CompletableFuture<Void>	writeOutput(TerminalException exception)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

objectKey

String objectKey()

request

HandlerRequest request()

attemptHeaders

HeadersAccessor attemptHeaders()

Restate-protocol-level HTTP headers received on the current invocation attempt. Differs across retries.

canReadState

boolean canReadState()

canWriteState

boolean canWriteState()

canReadPromises

boolean canReadPromises()

canWritePromises

boolean canWritePromises()

writeOutput

@Deprecated(forRemoval=true)
CompletableFuture<Void> writeOutput(Slice value)

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

writeOutput

@Deprecated(forRemoval=true)
CompletableFuture<Void> writeOutput(TerminalException exception)

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

get

CompletableFuture<AsyncResult<Optional<Slice>>> get(String name)

getKeys

CompletableFuture<AsyncResult<Collection<String>>> getKeys()

clear

CompletableFuture<Void> clear(String name)

clearAll

CompletableFuture<Void> clearAll()

set

CompletableFuture<Void> set(String name,
 Slice value)

timer

CompletableFuture<AsyncResult<Void>> timer(Duration duration,
 @Nullable String name)

call

@Deprecated
default CompletableFuture<HandlerContext.CallResult> call(Target target,
 Slice parameter,
 @Nullable String idempotencyKey,
 @Nullable Collection<Map.Entry<String,String>> headers)

Deprecated.

call

CompletableFuture<HandlerContext.CallResult> call(Target target,
 Slice parameter,
 @Nullable String idempotencyKey,
 @Nullable String limitKey,
 @Nullable Collection<Map.Entry<String,String>> headers)

send

@Deprecated
default CompletableFuture<AsyncResult<String>> send(Target target,
 Slice parameter,
 @Nullable String idempotencyKey,
 @Nullable Collection<Map.Entry<String,String>> headers,
 @Nullable Duration delay)

Deprecated.

send

CompletableFuture<AsyncResult<String>> send(Target target,
 Slice parameter,
 @Nullable String idempotencyKey,
 @Nullable String limitKey,
 @Nullable Collection<Map.Entry<String,String>> headers,
 @Nullable Duration delay)

submitRun

CompletableFuture<AsyncResult<Slice>> submitRun(@Nullable String name,
 Consumer<HandlerContext.RunCompleter> closure)

awakeable

CompletableFuture<HandlerContext.Awakeable> awakeable()

resolveAwakeable

CompletableFuture<Void> resolveAwakeable(String id,
 Slice payload)

rejectAwakeable

CompletableFuture<Void> rejectAwakeable(String id,
 TerminalException reason)

promise

CompletableFuture<AsyncResult<Slice>> promise(String key)

peekPromise

CompletableFuture<AsyncResult<Output<Slice>>> peekPromise(String key)

resolvePromise

CompletableFuture<AsyncResult<Void>> resolvePromise(String key,
 Slice payload)

rejectPromise

CompletableFuture<AsyncResult<Void>> rejectPromise(String key,
 TerminalException reason)

signal

CompletableFuture<AsyncResult<Slice>> signal(String name)

resolveSignal

CompletableFuture<Void> resolveSignal(String invocationId,
 String name,
 Slice payload)

rejectSignal

CompletableFuture<Void> rejectSignal(String invocationId,
 String name,
 TerminalException reason)

cancelInvocation

CompletableFuture<Void> cancelInvocation(String invocationId)

attachInvocation

CompletableFuture<AsyncResult<Slice>> attachInvocation(String invocationId)

getInvocationOutput

CompletableFuture<AsyncResult<Output<Slice>>> getInvocationOutput(String invocationId)

fail

void fail(Throwable cause)

createAnyAsyncResult

AsyncResult<Integer> createAnyAsyncResult(List<AsyncResult<?>> children)

createAllAsyncResult

AsyncResult<Void> createAllAsyncResult(List<AsyncResult<?>> children)