io.temporal.internal.sync

Class WorkflowInternal

java.lang.Object

io.temporal.internal.sync.WorkflowInternal

public final class WorkflowInternal
extends java.lang.Object

Never reference directly. It is public only because Java doesn't have internal package support.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VERSION

Method Summary

Modifier and Type	Method and Description
static boolean	await(java.time.Duration timeout, java.lang.String reason, java.util.function.Supplier<java.lang.Boolean> unblockCondition)
static void	await(java.lang.String reason, java.util.function.Supplier<java.lang.Boolean> unblockCondition)
static Promise<java.lang.Void>	cancelWorkflow(io.temporal.api.common.v1.WorkflowExecution execution)
static void	continueAsNew(java.util.Optional<java.lang.String> workflowType, java.util.Optional<ContinueAsNewOptions> options, java.lang.Object[] args)
static void	continueAsNew(java.util.Optional<java.lang.String> workflowType, java.util.Optional<ContinueAsNewOptions> options, java.lang.Object[] args, WorkflowOutboundCallsInterceptor outboundCallsInterceptor)
static io.temporal.internal.sync.CancellationScopeImpl	currentCancellationScope()
static long	currentTimeMillis() Should be used to get current time instead of System.currentTimeMillis()
static <R> R	executeActivity(java.lang.String name, ActivityOptions options, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.lang.Object... args) Execute activity by name.
static DataConverter	getDataConverter()
static <R> R	getLastCompletionResult(java.lang.Class<R> resultClass, java.lang.reflect.Type resultType)
static org.slf4j.Logger	getLogger(java.lang.Class<?> clazz)
static org.slf4j.Logger	getLogger(java.lang.String name)
static com.uber.m3.tally.Scope	getMetricsScope()
static java.util.Optional<java.lang.Exception>	getPreviousRunFailure()
static int	getVersion(java.lang.String changeId, int minSupported, int maxSupported)
static Promise<io.temporal.api.common.v1.WorkflowExecution>	getWorkflowExecution(java.lang.Object workflowStub)
static WorkflowInfo	getWorkflowInfo()
static java.lang.String	getWorkflowType(java.lang.Class<?> workflowInterfaceClass) Name of the workflow type the interface defines.
static boolean	isReplaying() Returns false if not under workflow code.
static <R> R	mutableSideEffect(java.lang.String id, java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, java.util.function.BiPredicate<R,R> updated, Functions.Func<R> func)
static <T> T	newActivityStub(java.lang.Class<T> activityInterface, ActivityOptions options) Creates client stub to activities that implement given interface.
static CancellationScope	newCancellationScope(boolean detached, Functions.Proc1<CancellationScope> proc)
static CancellationScope	newCancellationScope(boolean detached, java.lang.Runnable runnable)
static <T> T	newChildWorkflowStub(java.lang.Class<T> workflowInterface, ChildWorkflowOptions options)
static <E> CompletablePromise<E>	newCompletablePromise()
static <T> T	newContinueAsNewStub(java.lang.Class<T> workflowInterface, ContinueAsNewOptions options) Creates client stub that can be used to continue this workflow as new.
static <T> T	newExternalWorkflowStub(java.lang.Class<T> workflowInterface, io.temporal.api.common.v1.WorkflowExecution execution)
static <E> Promise<E>	newFailedPromise(java.lang.Exception failure)
static <T> T	newLocalActivityStub(java.lang.Class<T> activityInterface, LocalActivityOptions options) Creates client stub to local activities that implement given interface.
static <E> Promise<E>	newPromise(E value)
static <E> WorkflowQueue<E>	newQueue(int capacity)
static java.util.Random	newRandom()
static io.temporal.internal.sync.WorkflowThread	newThread(boolean ignoreParentCancellation, java.lang.Runnable runnable)
static io.temporal.internal.sync.WorkflowThread	newThread(boolean ignoreParentCancellation, java.lang.String name, java.lang.Runnable runnable)
static Promise<java.lang.Void>	newTimer(java.time.Duration duration)
static ActivityStub	newUntypedActivityStub(ActivityOptions options)
static ChildWorkflowStub	newUntypedChildWorkflowStub(java.lang.String workflowType, ChildWorkflowOptions options)
static ExternalWorkflowStub	newUntypedExternalWorkflowStub(io.temporal.api.common.v1.WorkflowExecution execution)
static ActivityStub	newUntypedLocalActivityStub(LocalActivityOptions options)
static <V> Promise<java.lang.Void>	promiseAllOf(java.lang.Iterable<Promise<V>> promises)
static Promise<java.lang.Void>	promiseAllOf(Promise<?>... promises)
static <V> Promise<V>	promiseAnyOf(java.lang.Iterable<Promise<V>> promises)
static Promise<java.lang.Object>	promiseAnyOf(Promise<?>... promises)
static java.util.UUID	randomUUID()
static void	registerListener(java.lang.Object implementation) Register query or queries implementation object.
static <R> R	retry(RetryOptions options, java.util.Optional<java.time.Duration> expiration, Functions.Func<R> fn)
static <R> R	sideEffect(java.lang.Class<R> resultClass, java.lang.reflect.Type resultType, Functions.Func<R> func)
static void	sleep(java.time.Duration duration)
static java.lang.Throwable	unwrap(java.lang.Throwable e)
static void	upsertSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)
static java.lang.RuntimeException	wrap(java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

Method Detail

newThread

public static io.temporal.internal.sync.WorkflowThread newThread(boolean ignoreParentCancellation,
                                                                 java.lang.Runnable runnable)

newThread

public static io.temporal.internal.sync.WorkflowThread newThread(boolean ignoreParentCancellation,
                                                                 java.lang.String name,
                                                                 java.lang.Runnable runnable)

newTimer

public static Promise<java.lang.Void> newTimer(java.time.Duration duration)

newQueue

public static <E> WorkflowQueue<E> newQueue(int capacity)

newCompletablePromise

public static <E> CompletablePromise<E> newCompletablePromise()

newPromise

public static <E> Promise<E> newPromise(E value)

newFailedPromise

public static <E> Promise<E> newFailedPromise(java.lang.Exception failure)

registerListener

public static void registerListener(java.lang.Object implementation)

Register query or queries implementation object. There is no need to register top level workflow implementation object as it is done implicitly. Only methods annotated with @QueryMethod are registered.

currentTimeMillis

public static long currentTimeMillis()

Should be used to get current time instead of System.currentTimeMillis()

newActivityStub

public static <T> T newActivityStub(java.lang.Class<T> activityInterface,
                                    ActivityOptions options)

Creates client stub to activities that implement given interface.

Parameters:

activityInterface - interface type implemented by activities

newLocalActivityStub

public static <T> T newLocalActivityStub(java.lang.Class<T> activityInterface,
                                         LocalActivityOptions options)

Creates client stub to local activities that implement given interface.

Parameters:

activityInterface - interface type implemented by activities

newUntypedActivityStub

public static ActivityStub newUntypedActivityStub(ActivityOptions options)

newUntypedLocalActivityStub

public static ActivityStub newUntypedLocalActivityStub(LocalActivityOptions options)

newChildWorkflowStub

public static <T> T newChildWorkflowStub(java.lang.Class<T> workflowInterface,
                                         ChildWorkflowOptions options)

newExternalWorkflowStub

public static <T> T newExternalWorkflowStub(java.lang.Class<T> workflowInterface,
                                            io.temporal.api.common.v1.WorkflowExecution execution)

getWorkflowExecution

public static Promise<io.temporal.api.common.v1.WorkflowExecution> getWorkflowExecution(java.lang.Object workflowStub)

newUntypedChildWorkflowStub

public static ChildWorkflowStub newUntypedChildWorkflowStub(java.lang.String workflowType,
                                                            ChildWorkflowOptions options)

newUntypedExternalWorkflowStub

public static ExternalWorkflowStub newUntypedExternalWorkflowStub(io.temporal.api.common.v1.WorkflowExecution execution)

newContinueAsNewStub

public static <T> T newContinueAsNewStub(java.lang.Class<T> workflowInterface,
                                         ContinueAsNewOptions options)

Creates client stub that can be used to continue this workflow as new.

Parameters:

workflowInterface - interface type implemented by the next generation of workflow

executeActivity

public static <R> R executeActivity(java.lang.String name,
                                    ActivityOptions options,
                                    java.lang.Class<R> resultClass,
                                    java.lang.reflect.Type resultType,
                                    java.lang.Object... args)

Execute activity by name.

Type Parameters:

R - activity return type

Parameters:

name - name of the activity

resultClass - activity return type

args - list of activity arguments

Returns:

activity result

await

public static void await(java.lang.String reason,
                         java.util.function.Supplier<java.lang.Boolean> unblockCondition)
                  throws io.temporal.internal.sync.DestroyWorkflowThreadError

Throws:

io.temporal.internal.sync.DestroyWorkflowThreadError

await

public static boolean await(java.time.Duration timeout,
                            java.lang.String reason,
                            java.util.function.Supplier<java.lang.Boolean> unblockCondition)
                     throws io.temporal.internal.sync.DestroyWorkflowThreadError

Throws:

io.temporal.internal.sync.DestroyWorkflowThreadError

sideEffect

public static <R> R sideEffect(java.lang.Class<R> resultClass,
                               java.lang.reflect.Type resultType,
                               Functions.Func<R> func)

mutableSideEffect

public static <R> R mutableSideEffect(java.lang.String id,
                                      java.lang.Class<R> resultClass,
                                      java.lang.reflect.Type resultType,
                                      java.util.function.BiPredicate<R,R> updated,
                                      Functions.Func<R> func)

getVersion

public static int getVersion(java.lang.String changeId,
                             int minSupported,
                             int maxSupported)

promiseAllOf

public static <V> Promise<java.lang.Void> promiseAllOf(java.lang.Iterable<Promise<V>> promises)

promiseAllOf

public static Promise<java.lang.Void> promiseAllOf(Promise<?>... promises)

promiseAnyOf

public static <V> Promise<V> promiseAnyOf(java.lang.Iterable<Promise<V>> promises)

promiseAnyOf

public static Promise<java.lang.Object> promiseAnyOf(Promise<?>... promises)

newCancellationScope

public static CancellationScope newCancellationScope(boolean detached,
                                                     java.lang.Runnable runnable)

newCancellationScope

public static CancellationScope newCancellationScope(boolean detached,
                                                     Functions.Proc1<CancellationScope> proc)

currentCancellationScope

public static io.temporal.internal.sync.CancellationScopeImpl currentCancellationScope()

wrap

public static java.lang.RuntimeException wrap(java.lang.Throwable e)

unwrap

public static java.lang.Throwable unwrap(java.lang.Throwable e)

isReplaying

public static boolean isReplaying()

Returns false if not under workflow code.

getWorkflowInfo

public static WorkflowInfo getWorkflowInfo()

retry

public static <R> R retry(RetryOptions options,
                          java.util.Optional<java.time.Duration> expiration,
                          Functions.Func<R> fn)

continueAsNew

public static void continueAsNew(java.util.Optional<java.lang.String> workflowType,
                                 java.util.Optional<ContinueAsNewOptions> options,
                                 java.lang.Object[] args)

continueAsNew

public static void continueAsNew(java.util.Optional<java.lang.String> workflowType,
                                 java.util.Optional<ContinueAsNewOptions> options,
                                 java.lang.Object[] args,
                                 WorkflowOutboundCallsInterceptor outboundCallsInterceptor)

cancelWorkflow

public static Promise<java.lang.Void> cancelWorkflow(io.temporal.api.common.v1.WorkflowExecution execution)

sleep

public static void sleep(java.time.Duration duration)

getMetricsScope

public static com.uber.m3.tally.Scope getMetricsScope()

randomUUID

public static java.util.UUID randomUUID()

newRandom

public static java.util.Random newRandom()

getLogger

public static org.slf4j.Logger getLogger(java.lang.Class<?> clazz)

getLogger

public static org.slf4j.Logger getLogger(java.lang.String name)

getLastCompletionResult

public static <R> R getLastCompletionResult(java.lang.Class<R> resultClass,
                                            java.lang.reflect.Type resultType)

upsertSearchAttributes

public static void upsertSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)

getDataConverter

public static DataConverter getDataConverter()

getWorkflowType

public static java.lang.String getWorkflowType(java.lang.Class<?> workflowInterfaceClass)

Name of the workflow type the interface defines. It is either the interface short name * or value of WorkflowMethod.name() parameter.

Parameters:

workflowInterfaceClass - interface annotated with @WorkflowInterface

getPreviousRunFailure

public static java.util.Optional<java.lang.Exception> getPreviousRunFailure()