kalix.scalasdk.workflow.WorkflowProvider.scala Maven / Gradle / Ivy
/*
* Copyright 2024 Lightbend Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package kalix.scalasdk.workflow
import com.google.protobuf.Descriptors
import kalix.scalasdk.impl.workflow.WorkflowRouter
/**
* Register a workflow component in [[kalix.scalasdk.Kalix]] using a WorkflowProvider. The concrete
* WorkflowProvider is generated for the specific workflows defined in Protobuf, for example
* TransferWorkflowProvider.
*/
trait WorkflowProvider[S >: Null, E <: AbstractWorkflow[S]] {
def options: WorkflowOptions
def serviceDescriptor: Descriptors.ServiceDescriptor
def typeId: String
def newRouter(context: WorkflowContext): WorkflowRouter[S, E]
def additionalDescriptors: Seq[Descriptors.FileDescriptor]
}