github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/pkg/identity/plugin.go (about)

     1  // Copyright © 2021 Kaleido, Inc.
     2  //
     3  // SPDX-License-Identifier: Apache-2.0
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package identity
    18  
    19  import (
    20  	"context"
    21  
    22  	"github.com/kaleido-io/firefly/internal/config"
    23  	"github.com/kaleido-io/firefly/pkg/fftypes"
    24  )
    25  
    26  // Plugin is the interface implemented by each identity plugin
    27  type Plugin interface {
    28  	fftypes.Named
    29  
    30  	// InitPrefix initializes the set of configuration options that are valid, with defaults. Called on all plugins.
    31  	InitPrefix(prefix config.Prefix)
    32  
    33  	// Init initializes the plugin, with configuration
    34  	// Returns the supported featureset of the interface
    35  	Init(ctx context.Context, prefix config.Prefix, callbacks Callbacks) error
    36  
    37  	// Blockchain interface must not deliver any events until start is called
    38  	Start() error
    39  
    40  	// Capabilities returns capabilities - not called until after Init
    41  	Capabilities() *Capabilities
    42  
    43  	// Resolve maps an identity identifier passed in a message to a full identity that includes the signing identity
    44  	Resolve(ctx context.Context, identifier string) (identity *fftypes.Identity, err error)
    45  }
    46  
    47  // Callbacks is the interface provided to the identity plugin, to allow it to request information from firefly, or pass events.
    48  type Callbacks interface {
    49  }
    50  
    51  // Capabilities the supported featureset of the identity
    52  // interface implemented by the plugin, with the specified config
    53  type Capabilities struct {
    54  }