boltKey

Documentation

Overview

Package boltKey provides a Service that is using local BoltDB database to store Key data.

Index

• func NewDB(filename string, fileMode os.FileMode, boltOptions *bolt.Options) (db *bolt.DB, err error)
• type Logger
• type Service
  • func (s Service) CreateKey(ref string, o *key.Options) (k *key.Key, err error)
  • func (s Service) DataDump(ifModifiedSince *time.Time) (dump *dataDump.Dump, err error)
  • func (s Service) DeleteKey(ref string) error
  • func (s Service) KeyByRef(ref string) (k *key.Key, err error)
  • func (s Service) KeyBySecret(secret string) (k *key.Key, err error)
  • func (s Service) Keys(startName string, limit int) (page key.KeysPage, err error)
  • func (s Service) RegenerateSecret(ref string) (secret string, err error)
  • func (s Service) UpdateKey(ref string, o *key.Options) (k *key.Key, err error)

Functions

func NewDB

func NewDB(filename string, fileMode os.FileMode, boltOptions *bolt.Options) (db *bolt.DB, err error)

NewDB opens a new BoltDB database.

Types

type Logger

type Logger interface {
	Errorf(format string, a ...interface{})
}

Logger defines interface for logging messages with various severity levels.

type Service

type Service struct {
	DB     *bolt.DB
	Logger Logger
}

Service implements gopherpit.com/gopherpit/services/key.Service interface.

func (Service) CreateKey

func (s Service) CreateKey(ref string, o *key.Options) (k *key.Key, err error)

func (Service) DataDump

func (s Service) DataDump(ifModifiedSince *time.Time) (dump *dataDump.Dump, err error)

DataDump implements dataDump.Interface interface to extract database data in a safe and reliable way.

func (Service) DeleteKey

func (s Service) DeleteKey(ref string) error

func (Service) KeyByRef

func (s Service) KeyByRef(ref string) (k *key.Key, err error)

func (Service) KeyBySecret

func (s Service) KeyBySecret(secret string) (k *key.Key, err error)

func (Service) Keys

func (s Service) Keys(startName string, limit int) (page key.KeysPage, err error)

func (Service) RegenerateSecret

func (s Service) RegenerateSecret(ref string) (secret string, err error)

func (Service) UpdateKey

func (s Service) UpdateKey(ref string, o *key.Options) (k *key.Key, err error)