github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/pkg/publicstorage/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 publicstorage
    18  
    19  import (
    20  	"context"
    21  	"io"
    22  
    23  	"github.com/kaleido-io/firefly/internal/config"
    24  	"github.com/kaleido-io/firefly/pkg/fftypes"
    25  )
    26  
    27  // Plugin is the interface implemented by each Public Storage plugin
    28  type Plugin interface {
    29  	fftypes.Named
    30  
    31  	// InitPrefix initializes the set of configuration options that are valid, with defaults. Called on all plugins.
    32  	InitPrefix(prefix config.Prefix)
    33  
    34  	// Init initializes the plugin, with configuration
    35  	// Returns the supported featureset of the interface
    36  	Init(ctx context.Context, prefix config.Prefix, callbacks Callbacks) error
    37  
    38  	// Capabilities returns capabilities - not called until after Init
    39  	Capabilities() *Capabilities
    40  
    41  	// PublishData publishes data to the Public Storage, and returns a Bytes32 payload reference ID
    42  	PublishData(ctx context.Context, data io.Reader) (payloadRef *fftypes.Bytes32, backendID string, err error)
    43  
    44  	// RetrieveData reads data back from IPFS using the payload reference format returned from PublishData
    45  	RetrieveData(ctx context.Context, payloadRef *fftypes.Bytes32) (data io.ReadCloser, err error)
    46  }
    47  
    48  type Callbacks interface {
    49  }
    50  
    51  type Capabilities struct {
    52  }