backend

type Backend ¶

type Backend interface {
	Logging
	FlagsProvider
	ClientReader
	ClientGetter
	ClientSetter
	ClientDeleter
	Locker
	ConfigStore
	RoleStore
	EventSender
	WriteSafeReplicationState
}

type ClientDeleter ¶

type ClientDeleter interface {
	DeleteClient(name string)
}

ClientDeleter removes a client from the cache.

type ClientGetter ¶

type ClientGetter interface {
	GetClient(name string) gitlab.Client
}

ClientGetter provides direct cache access to a stored client.

type ClientReader ¶

type ClientReader interface {
	GetClientByName(ctx context.Context, s logical.Storage, name string) (gitlab.Client, error)
}

ClientReader provides read-only client access by config name.

type ClientSetter ¶

type ClientSetter interface {
	SetClient(client gitlab.Client, name string)
}

ClientSetter stores a client in the cache.

type ConfigStore ¶

type ConfigStore interface {
	GetConfig(ctx context.Context, s logical.Storage, name string) (*config.EntryConfig, error)
	SaveConfig(ctx context.Context, s logical.Storage, cfg *config.EntryConfig) error
}

ConfigStore provides config CRUD operations.

type EventSender ¶

type EventSender interface {
	SendEvent(ctx context.Context, eventType event.EventType, metadata map[string]string) error
}

EventSender abstracts sending audit/events from the backend.

type FlagsProvider ¶

type FlagsProvider interface {
	Flags() flags.Flags
	UpdateFlags(fn func(*flags.Flags))
}

FlagsProvider provides read and update access to runtime flags.

type Impl ¶

type Impl struct {
	*framework.Backend
	// contains filtered or unexported fields
}

Impl is the concrete implementation of the Backend interface.

func New(f flags.Flags) *Impl

func (b *Impl) DeleteClient(name string)

func (b *Impl) Flags() flags.Flags

func (b *Impl) GetClient(name string) g.Client

func (b *Impl) GetClientByName(ctx context.Context, s logical.Storage, name string) (client g.Client, err error)

func (b *Impl) GetConfig(ctx context.Context, s logical.Storage, name string) (*modelConfig.EntryConfig, error)

func (b *Impl) GetRole(ctx context.Context, s logical.Storage, name string) (*role.Role, error)

func (b *Impl) Init(ctx context.Context, conf *logical.BackendConfig, opts ...InitOption) error

func (b *Impl) LockForKey(path, key string) *locksutil.LockEntry

func (b *Impl) SaveConfig(ctx context.Context, s logical.Storage, config *modelConfig.EntryConfig) error

func (b *Impl) SendEvent(ctx context.Context, eventType event.EventType, metadata map[string]string) error

func (b *Impl) SetClient(client g.Client, name string)

func (b *Impl) UpdateFlags(fn func(*flags.Flags))

type InitOption ¶

type InitOption func(*initConfig)

InitOption is a functional option for configuring backend initialization.

func WithHelp(h string) InitOption

func WithLocalStorage(paths ...string) InitOption

func WithProviders(p ...PathProvider) InitOption

func WithSealWrapStorage(paths ...string) InitOption

func WithSecrets(s ...*framework.Secret) InitOption

func WithVersion(v string) InitOption

type InvalidateHandler ¶

type InvalidateHandler interface {
	Invalidate(ctx context.Context, key string)
}

InvalidateHandler is optionally implemented by PathProviders that need to react to storage key invalidation events.

type Locker ¶

type Locker interface {
	LockForKey(path, key string) *locksutil.LockEntry
}

Locker provides per-key locking scoped by a path prefix.

type Logging ¶

type Logging interface {
	Logger() hclog.Logger
}

Logging provides access to the backend logger.

type PathProvider ¶

type PathProvider interface {
	Name() string
	Paths() []*framework.Path
}

PathProvider provides framework paths to register with the backend.

type PeriodicHandler ¶

type PeriodicHandler interface {
	PeriodicFunc(ctx context.Context, req *logical.Request) error
}

PeriodicHandler is optionally implemented by PathProviders that need periodic work. The backend checks WriteSafeReplicationState() centrally before dispatching — handlers are only called when writes are safe.

type RoleStore ¶

type RoleStore interface {
	GetRole(ctx context.Context, s logical.Storage, name string) (*role.Role, error)
}

RoleStore provides role read operations.

type WriteSafeReplicationState ¶

type WriteSafeReplicationState interface {
	WriteSafeReplicationState() bool
}