go.uber.org/cadence@v1.2.9/interceptors/workflow_interceptor.go (about)

     1  // Modifications Copyright (c) 2020 Uber Technologies Inc.
     2  // Copyright (c) 2020 Temporal Technologies, Inc.
     3  //
     4  // Permission is hereby granted, free of charge, to any person obtaining a copy
     5  // of this software and associated documentation files (the "Software"), to deal
     6  // in the Software without restriction, including without limitation the rights
     7  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8  // copies of the Software, and to permit persons to whom the Software is
     9  // furnished to do so, subject to the following conditions:
    10  //
    11  // The above copyright notice and this permission notice shall be included in
    12  // all copies or substantial portions of the Software.
    13  //
    14  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    20  // THE SOFTWARE.
    21  
    22  package interceptors
    23  
    24  import (
    25  	"go.uber.org/cadence/internal"
    26  )
    27  
    28  type (
    29  	// WorkflowInterceptorFactory is used to create a single link in the interceptor chain
    30  	WorkflowInterceptorFactory = internal.WorkflowInterceptorFactory
    31  
    32  	// WorkflowInterceptor is an interface that can be implemented to intercept calls to the workflow function
    33  	// as well calls done by the workflow code.
    34  	// Use worker.WorkflowInterceptorBase as a base struct for implementations that do not want to implement every method.
    35  	// Interceptor implementation must forward calls to the next in the interceptor chain.
    36  	// All code in the interceptor is executed in the workflow.Context of a workflow. So all the rules and restrictions
    37  	// that apply to the workflow code should be obeyed by the interceptor implementation.
    38  	// Use workflow.IsReplaying(ctx) to filter out duplicated calls.
    39  	WorkflowInterceptor = internal.WorkflowInterceptor
    40  
    41  	// WorkflowInterceptorBase is a noop implementation of WorkflowInterceptor that just forwards requests
    42  	// to the next link in an interceptor chain. To be used as base implementation of interceptors.
    43  	WorkflowInterceptorBase = internal.WorkflowInterceptorBase
    44  )