Class POJOWorkflowInterfaceMetadata

java.lang.Object

io.temporal.common.metadata.POJOWorkflowInterfaceMetadata

public final class POJOWorkflowInterfaceMetadata
extends Object

Metadata of a workflow interface.

Rules:

• A workflow implementation must implement at least one non empty interface annotated with WorkflowInterface
• An interface annotated with WorkflowInterface can extend zero or more interfaces.
• An interface annotated with WorkflowInterface defines workflow methods for all methods it inherited from interfaces which are not annotated with WorkflowInterface.
• Each method name can be defined only once across all interfaces annotated with WorkflowInterface. So if annotated interface A has method foo() and an annotated interface B extends A it cannot also declare foo() even with a different signature.

Method Summary

Modifier and Type	Method	Description
Class<?>	getInterfaceClass()	Java interface Class that backs this workflow interface.
POJOWorkflowMethodMetadata	getMethodMetadata(Method method)	Return metadata for a method of a workflow interface.
List<POJOWorkflowMethodMetadata>	getMethodsMetadata()
Optional<POJOWorkflowMethodMetadata>	getWorkflowMethod()
Optional<String>	getWorkflowType()	Workflow type the workflow interface defines.
static POJOWorkflowInterfaceMetadata	newInstance(Class<?> anInterface)	Use this method to create a metadata for an WorkflowInterface annotated interface.
static POJOWorkflowInterfaceMetadata	newInstance(Class<?> anInterface, boolean validateWorkflowAnnotation)	Use this method to create a metadata for an WorkflowInterface annotated interface or some of its partial base classes that me have some workflow methods but not be a full annotated WorkflowInterface.
static POJOWorkflowInterfaceMetadata	newInstanceSkipWorkflowAnnotationCheck(Class<?> anInterface)	Deprecated. use newInstance(Class, boolean) with validateWorkflowAnnotation==false.

Methods inherited from class java.lang.Object

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

Method Details

newInstanceSkipWorkflowAnnotationCheck

@Deprecated
public static POJOWorkflowInterfaceMetadata newInstanceSkipWorkflowAnnotationCheck(Class<?> anInterface)

Deprecated.

use newInstance(Class, boolean) with validateWorkflowAnnotation==false.

newInstance

public static POJOWorkflowInterfaceMetadata newInstance(Class<?> anInterface)

Use this method to create a metadata for an WorkflowInterface annotated interface.

Requires

• anInterface to be annotated with WorkflowInterface
• All methods of anInterface to be annotated with WorkflowMethod, QueryMethod, UpdateMethod, UpdateValidatorMethod or SignalMethod

Parameters:

anInterface - interface to create metadata for

Returns:

metadata for the interface

Throws:

IllegalArgumentException - if anInterface fails validation

newInstance

public static POJOWorkflowInterfaceMetadata newInstance(Class<?> anInterface,
 boolean validateWorkflowAnnotation)

Use this method to create a metadata for an WorkflowInterface annotated interface or some of its partial base classes that me have some workflow methods but not be a full annotated WorkflowInterface.

Requires

• All methods of anInterface to be annotated with WorkflowMethod, QueryMethod or SignalMethod

Parameters:

anInterface - interface to create metadata for

validateWorkflowAnnotation - if false, allows anInterface to not be annotated with WorkflowInterface. This to support invoking workflow signal and query methods through a base interface without such an annotation.

Returns:

metadata for the interface

Throws:

IllegalArgumentException - if anInterface fails validation

getWorkflowMethod

public Optional<POJOWorkflowMethodMetadata> getWorkflowMethod()

getInterfaceClass

public Class<?> getInterfaceClass()

Java interface Class that backs this workflow interface.

getWorkflowType

public Optional<String> getWorkflowType()

Workflow type the workflow interface defines. It is empty for interfaces that contain only signal and query methods.

getMethodMetadata

public POJOWorkflowMethodMetadata getMethodMetadata(Method method)

Return metadata for a method of a workflow interface.

Throws:

IllegalArgumentException - if method doesn't belong to the workflow interface.

getMethodsMetadata

public List<POJOWorkflowMethodMetadata> getMethodsMetadata()