plugin

Documentation

Index

• Variables
• func Backend(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
• type PluginBackend
  • func (b *PluginBackend) HandleExistenceCheck(ctx context.Context, req *logical.Request) (checkFound bool, exists bool, err error)
  • func (b *PluginBackend) HandleRequest(ctx context.Context, req *logical.Request) (resp *logical.Response, err error)
  • func (b *PluginBackend) Initialize(ctx context.Context, req *logical.InitializationRequest) error

Variables

var (
	ErrMismatchType  = fmt.Errorf("mismatch on mounted backend and plugin backend type")
	ErrMismatchPaths = fmt.Errorf("mismatch on mounted backend and plugin backend special paths")
)

Functions

func Backend

func Backend(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Backend returns an instance of the backend, either as a plugin if external or as a concrete implementation if builtin, casted as logical.Backend.

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

Factory returns a configured plugin logical.Backend.

Types

type PluginBackend

type PluginBackend struct {
	logical.Backend
	sync.RWMutex
	// contains filtered or unexported fields
}

PluginBackend is a thin wrapper around plugin.BackendPluginClient

func (*PluginBackend) HandleExistenceCheck

func (b *PluginBackend) HandleExistenceCheck(ctx context.Context, req *logical.Request) (checkFound bool, exists bool, err error)

HandleExistenceCheck is a thin wrapper implementation of HandleExistenceCheck that includes automatic plugin reload.

func (*PluginBackend) HandleRequest

func (b *PluginBackend) HandleRequest(ctx context.Context, req *logical.Request) (resp *logical.Response, err error)

HandleRequest is a thin wrapper implementation of HandleRequest that includes automatic plugin reload.

func (*PluginBackend) Initialize

func (b *PluginBackend) Initialize(ctx context.Context, req *logical.InitializationRequest) error

Initialize is intentionally a no-op here, the backend will instead be initialized when it is lazily loaded.