Package io.temporal.spring.boot

Interface WorkflowImplementationOptionsCustomizer

  • All Superinterfaces:
    TemporalOptionsCustomizer<io.temporal.worker.WorkflowImplementationOptions.Builder>
    public interface WorkflowImplementationOptionsCustomizer
extends TemporalOptionsCustomizer<io.temporal.worker.WorkflowImplementationOptions.Builder>
    Bean of this class can be added to Spring context to get a fine control over WorkflowImplementationOptions objects that are created by Temporal Spring Boot Autoconfigure module.

    Only one bean of this or TemporalOptionsCustomizer<WorkflowImplementationOptions.Builder> type can be added to Spring context.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default io.temporal.worker.WorkflowImplementationOptions.Builder customize​(io.temporal.worker.WorkflowImplementationOptions.Builder optionsBuilder)
      This method can modify some fields of the provided builder or create a new builder altogether and return it back to be used.
      io.temporal.worker.WorkflowImplementationOptions.Builder customize​(io.temporal.worker.WorkflowImplementationOptions.Builder optionsBuilder, io.temporal.worker.Worker worker, java.lang.Class<?> clazz, io.temporal.common.metadata.POJOWorkflowMethodMetadata workflowMethod)
      This method can modify some fields of the provided WorkflowImplementationOptions.Builder or create a new builder altogether and return it back to be used.

    • Method Detail

      • customize

        @Nonnull
default io.temporal.worker.WorkflowImplementationOptions.Builder customize​(@Nonnull
                                                                           io.temporal.worker.WorkflowImplementationOptions.Builder optionsBuilder)
        Description copied from interface: TemporalOptionsCustomizer
        This method can modify some fields of the provided builder or create a new builder altogether and return it back to be used. This method is called after the *Options.Builder is initialized by the Temporal Spring Boot module, so changes done by this method will override Spring Boot configuration values.
        Specified by:
        customize in interface TemporalOptionsCustomizer<io.temporal.worker.WorkflowImplementationOptions.Builder>
        Parameters:
        optionsBuilder - *Options.Builder to customize
        Returns:
        modified optionsBuilder or a new builder to be used by the caller code.

      • customize

        @Nonnull
io.temporal.worker.WorkflowImplementationOptions.Builder customize​(@Nonnull
                                                                   io.temporal.worker.WorkflowImplementationOptions.Builder optionsBuilder,
                                                                   @Nonnull
                                                                   io.temporal.worker.Worker worker,
                                                                   @Nonnull
                                                                   java.lang.Class<?> clazz,
                                                                   @Nullable
                                                                   io.temporal.common.metadata.POJOWorkflowMethodMetadata workflowMethod)
        This method can modify some fields of the provided WorkflowImplementationOptions.Builder or create a new builder altogether and return it back to be used. This method is called after the WorkflowImplementationOptions.Builder is initialized by the Temporal Spring Boot module, so changes done by this method will override Spring Boot configuration values.
        Parameters:
        optionsBuilder - *Options.Builder to customize
        worker - the worker that the workflow implementation is being registered to.
        clazz - the class of the workflow implementation that is being registered.
        workflowMethod - the metadata of the workflow method on the interface that is being registered. null if the class is a DynamicWorkflow.
        Returns:
        modified optionsBuilder or a new builder instance to be used by the caller code