dataaccess

README

Contains the data access layer, used by the API to interact with the database.

The current implementation is 100% in local memory. The database support will be added later.

Documentation

Index

• func Updates() <-chan State
• type DataAccess
  • func Get() (DataAccess, error)
• type State
  • func CurrentState() State
  • func (s State) String() string

Functions

func Updates

func Updates() <-chan State

Updates returns a channel that blocks emits a signal whenever the data access layer state changes, typically on startup and whenever the configuration changes. Upon creation, it will emit the current state, so it never blocks.

Types

type DataAccess

type DataAccess interface {
	bundles.CommandEntryFinder

	Initialize(context.Context) error

	RequestBegin(ctx context.Context, request *data.CommandRequest) error
	RequestUpdate(ctx context.Context, request data.CommandRequest) error
	RequestError(ctx context.Context, request data.CommandRequest, err error) error
	RequestClose(ctx context.Context, result data.CommandResponse) error

	BundleCreate(ctx context.Context, bundle data.Bundle) error
	BundleDelete(ctx context.Context, name string, version string) error
	BundleDisable(ctx context.Context, name string) error
	BundleEnable(ctx context.Context, name string, version string) error
	BundleEnabledVersion(ctx context.Context, name string) (string, error)
	BundleExists(ctx context.Context, name string, version string) (bool, error)
	BundleGet(ctx context.Context, name string, version string) (data.Bundle, error)
	BundleList(ctx context.Context) ([]data.Bundle, error)
	BundleVersionList(ctx context.Context, name string) ([]data.Bundle, error)
	BundleUpdate(ctx context.Context, bundle data.Bundle) error

	GroupCreate(ctx context.Context, group rest.Group) error
	GroupDelete(ctx context.Context, groupname string) error
	GroupExists(ctx context.Context, groupname string) (bool, error)
	GroupGet(ctx context.Context, groupname string) (rest.Group, error)
	GroupList(ctx context.Context) ([]rest.Group, error)
	GroupPermissionList(ctx context.Context, groupname string) (rest.RolePermissionList, error)
	GroupRoleAdd(ctx context.Context, groupname, rolename string) error
	GroupRoleDelete(ctx context.Context, groupname, rolename string) error
	GroupRoleList(ctx context.Context, groupname string) ([]rest.Role, error)
	GroupUpdate(ctx context.Context, group rest.Group) error
	GroupUserAdd(ctx context.Context, groupname string, username string) error
	GroupUserDelete(ctx context.Context, groupname string, username string) error
	GroupUserList(ctx context.Context, groupname string) ([]rest.User, error)

	RoleCreate(ctx context.Context, rolename string) error
	RoleDelete(ctx context.Context, rolename string) error
	RoleGet(ctx context.Context, rolename string) (rest.Role, error)
	RoleGroupAdd(ctx context.Context, rolename, groupname string) error
	RoleGroupDelete(ctx context.Context, rolename, groupname string) error
	RoleGroupExists(ctx context.Context, rolename, groupname string) (bool, error)
	RoleGroupList(ctx context.Context, rolename string) ([]rest.Group, error)
	RoleList(ctx context.Context) ([]rest.Role, error)
	RoleExists(ctx context.Context, rolename string) (bool, error)
	RolePermissionAdd(ctx context.Context, rolename, bundlename, permission string) error
	RolePermissionDelete(ctx context.Context, rolename, bundlename, permission string) error
	RolePermissionExists(ctx context.Context, rolename, bundlename, permission string) (bool, error)
	RolePermissionList(ctx context.Context, rolename string) (rest.RolePermissionList, error)

	TokenEvaluate(ctx context.Context, token string) bool
	TokenGenerate(ctx context.Context, username string, duration time.Duration) (rest.Token, error)
	TokenInvalidate(ctx context.Context, token string) error
	TokenRetrieveByUser(ctx context.Context, username string) (rest.Token, error)
	TokenRetrieveByToken(ctx context.Context, token string) (rest.Token, error)

	UserAuthenticate(ctx context.Context, username string, password string) (bool, error)
	UserCreate(ctx context.Context, user rest.User) error
	UserDelete(ctx context.Context, username string) error
	UserExists(ctx context.Context, username string) (bool, error)
	UserGet(ctx context.Context, username string) (rest.User, error)
	UserGetByEmail(ctx context.Context, email string) (rest.User, error)
	UserGroupList(ctx context.Context, username string) ([]rest.Group, error)
	UserGroupAdd(ctx context.Context, username string, groupname string) error
	UserGroupDelete(ctx context.Context, username string, groupname string) error
	UserList(ctx context.Context) ([]rest.User, error)
	UserPermissionList(ctx context.Context, username string) (rest.RolePermissionList, error)
	UserRoleList(ctx context.Context, username string) ([]rest.Role, error)
	UserUpdate(ctx context.Context, user rest.User) error
}

DataAccess represents a common DataAccessObject, backed either by a database or an in-memory datastore.

func Get

func Get() (DataAccess, error)

Get provides an interface to the data access layer. If the state is not 'initialized', this will return an error.

type State

type State byte

State represents a possible state of the data access layer.

const (
	// StateUninitialized is the default state of the data access
	// layer, before initialization begins.
	StateUninitialized State = iota

	// StateInitializing indicates that the data access layer is
	// initializing, either because it's new or because something has
	// changed (config updated, database disconnected, etc)
	StateInitializing

	// StateInitialized indicates the data access layer is fully
	// initialized and (presumably) functional.
	StateInitialized

	// StateError indicated that some kind of error is preventing the
	// data access layer from initializing correctly.
	StateError
)

func CurrentState

func CurrentState() State

CurrentState returns the current state of the data access layer.

func (State) String

func (s State) String() string