Package dev.restate.sdk.fake

Class FakeContext

java.lang.Object

dev.restate.sdk.fake.FakeContext

All Implemented Interfaces:

Context, ObjectContext, SharedObjectContext, SharedWorkflowContext, WorkflowContext

@Experimental
public class FakeContext
extends Object
implements Context, ObjectContext, SharedObjectContext, WorkflowContext, SharedWorkflowContext

Fake Context, see ContextExpectations for more details.

You can pass this to Restate handlers.

See Also:

• ContextExpectations

Constructor Summary

Constructors

Constructor	Description
FakeContext()	Fake Context with default expectations.
FakeContext(ContextExpectations expectations)	Fake Context, see ContextExpectations for more details.

Method Summary

Modifier and Type	Method	Description
<T> Awakeable<T>	awakeable(TypeTag<T> typeTag)	Create an Awakeable, addressable through Awakeable.id().
AwakeableHandle	awakeableHandle(String s)	Create a new AwakeableHandle for the provided identifier.
<T, R> CallDurableFuture<R>	call(Request<T,R> request)	Invoke another Restate service method.
void	clear(StateKey<?> stateKey)	Clears the state stored under key.
void	clearAll()	Clears all the state of this virtual object instance key-value state storage
<T> Optional<T>	get(StateKey<T> stateKey)	Gets the state stored under key, deserializing the raw value using the Serde in the StateKey.
<R> InvocationHandle<R>	invocationHandle(String s, TypeTag<R> typeTag)	Like Context.invocationHandle(String, Class)
String	key()
<T> DurablePromise<T>	promise(DurablePromiseKey<T> durablePromiseKey)	Create a DurablePromise for the given key.
<T> DurablePromiseHandle<T>	promiseHandle(DurablePromiseKey<T> durablePromiseKey)	Create a new DurablePromiseHandle for the provided key.
RestateRandom	random()	Returns a deterministic random.
HandlerRequest	request()
<T> DurableFuture<T>	runAsync(String s, TypeTag<T> typeTag, RetryPolicy retryPolicy, ThrowingSupplier<T> throwingSupplier)	Like Context.runAsync(String, TypeTag, ThrowingSupplier), but using a custom retry policy.
<T, R> InvocationHandle<R>	send(Request<T,R> request, Duration duration)	Invoke another Restate service without waiting for the response.
<T> void	set(StateKey<T> stateKey, T t)	Sets the given value under the given key, serializing the value using the Serde in the StateKey.
Collection<String>	stateKeys()	Gets all the known state keys for this virtual object instance.
DurableFuture<Void>	timer(String s, Duration duration)	Causes the start of a timer for the given duration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.restate.sdk.Context

awakeable, invocationHandle, invocationHandle, run, run, run, run, run, run, run, run, run, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, runAsync, send, sleep, timer

Constructor Details

FakeContext

@Experimental
public FakeContext()

Fake Context with default expectations.

See Also:

• ContextExpectations

FakeContext

@Experimental
public FakeContext(ContextExpectations expectations)

Fake Context, see ContextExpectations for more details.

See Also:

• ContextExpectations

Method Details

request

public HandlerRequest request()

Specified by:

request in interface Context

call

public <T,
R> CallDurableFuture<R> call(Request<T,R> request)

Description copied from interface: Context

Invoke another Restate service method.

Specified by:

call in interface Context

Parameters:

request - Request object. For each service, a class called <your_class_name>Handlers is generated containing the request builders.

Returns:

an DurableFuture that wraps the Restate service method result.

send

public <T,
R> InvocationHandle<R> send(Request<T,R> request,
 Duration duration)

Description copied from interface: Context

Invoke another Restate service without waiting for the response.

Specified by:

send in interface Context

Parameters:

request - Request object. For each service, a class called <your_class_name>Handlers is generated containing the request builders.

duration - the delay to send the request

Returns:

an InvocationHandle that can be used to retrieve the invocation id, cancel the invocation, attach to its result.

invocationHandle

public <R> InvocationHandle<R> invocationHandle(String s,
 TypeTag<R> typeTag)

Description copied from interface: Context

Like Context.invocationHandle(String, Class)

Specified by:

invocationHandle in interface Context

timer

public DurableFuture<Void> timer(String s,
 Duration duration)

Description copied from interface: Context

Causes the start of a timer for the given duration. You can await on the timer end by invoking DurableFuture.await().

Specified by:

timer in interface Context

Parameters:

s - name used for observability

duration - for which to sleep.

runAsync

public <T> DurableFuture<T> runAsync(String s,
 TypeTag<T> typeTag,
 RetryPolicy retryPolicy,
 ThrowingSupplier<T> throwingSupplier)
                              throws TerminalException

Description copied from interface: Context

Like Context.runAsync(String, TypeTag, ThrowingSupplier), but using a custom retry policy.

When a retry policy is not specified, the run will be retried using the Restate invoker retry policy, which by default retries indefinitely.

Specified by:

runAsync in interface Context

Throws:

TerminalException

See Also:

• Context.runAsync(String, Class, ThrowingSupplier)
• RetryPolicy

awakeable

public <T> Awakeable<T> awakeable(TypeTag<T> typeTag)

Description copied from interface: Context

Create an Awakeable, addressable through Awakeable.id().

You can use this feature to implement external asynchronous systems interactions, for example you can send a Kafka record including the Awakeable.id(), and then let another service consume from Kafka the responses of given external system interaction by using Context.awakeableHandle(String).

Specified by:

awakeable in interface Context

Parameters:

typeTag - the response type tag to use for deserializing the Awakeable result.

Returns:

the Awakeable to await on.

See Also:

• Awakeable

awakeableHandle

public AwakeableHandle awakeableHandle(String s)

Description copied from interface: Context

Create a new AwakeableHandle for the provided identifier. You can use it to AwakeableHandle.resolve(TypeTag, Object) or AwakeableHandle.reject(String) the linked Awakeable.

Specified by:

awakeableHandle in interface Context

See Also:

• Awakeable

random

public RestateRandom random()

Description copied from interface: Context

Returns a deterministic random.

Specified by:

random in interface Context

See Also:

• RestateRandom

clear

public void clear(StateKey<?> stateKey)

Description copied from interface: ObjectContext

Clears the state stored under key.

Specified by:

clear in interface ObjectContext

Parameters:

stateKey - identifying the state to clear.

clearAll

public void clearAll()

Description copied from interface: ObjectContext

Clears all the state of this virtual object instance key-value state storage

Specified by:

clearAll in interface ObjectContext

set

public <T> void set(StateKey<T> stateKey,
 T t)

Description copied from interface: ObjectContext

Sets the given value under the given key, serializing the value using the Serde in the StateKey.

Specified by:

set in interface ObjectContext

Parameters:

stateKey - identifying the value to store and its type.

t - to store under the given key. MUST NOT be null.

promise

public <T> DurablePromise<T> promise(DurablePromiseKey<T> durablePromiseKey)

Description copied from interface: SharedWorkflowContext

Create a DurablePromise for the given key.

You can use this feature to implement interaction between different workflow handlers, e.g. to send a signal from a shared handler to the workflow handler.

Specified by:

promise in interface SharedWorkflowContext

Returns:

the DurablePromise.

See Also:

• DurablePromise

promiseHandle

public <T> DurablePromiseHandle<T> promiseHandle(DurablePromiseKey<T> durablePromiseKey)

Description copied from interface: SharedWorkflowContext

Create a new DurablePromiseHandle for the provided key. You can use it to DurablePromiseHandle.resolve(Object) or DurablePromiseHandle.reject(String) the given DurablePromise.

Specified by:

promiseHandle in interface SharedWorkflowContext

See Also:

• DurablePromise

key

public String key()

Specified by:

key in interface SharedObjectContext

Returns:

the key of this object

get

public <T> Optional<T> get(StateKey<T> stateKey)

Description copied from interface: SharedObjectContext

Gets the state stored under key, deserializing the raw value using the Serde in the StateKey.

Specified by:

get in interface SharedObjectContext

Parameters:

stateKey - identifying the state to get and its type.

Returns:

an Optional containing the stored state deserialized or an empty Optional if not set yet.

stateKeys

public Collection<String> stateKeys()

Description copied from interface: SharedObjectContext

Gets all the known state keys for this virtual object instance.

Specified by:

stateKeys in interface SharedObjectContext

Returns:

the immutable collection of known state keys.