roles

Documentation

Index

• func ReadRoleIDsFromContext(ctx context.Context) (roleIDs []string, ok bool)
• type Manager
  • func NewManager(o ...Option) Manager
  • func (m *Manager) FindPermissionByID(ctx context.Context, roleIDs []string, permissionID string) *settings.Setting
  • func (m *Manager) List(ctx context.Context, roleIDs []string) []*settings.Bundle
• type Option
  • func CacheSize(s int) Option
  • func CacheTTL(ttl time.Duration) Option
  • func Logger(logger log.Logger) Option
  • func RoleService(rs settings.RoleService) Option
• type Options

Functions

func ReadRoleIDsFromContext

func ReadRoleIDsFromContext(ctx context.Context) (roleIDs []string, ok bool)

ReadRoleIDsFromContext extracts roleIDs from the metadata context and returns them as []string

Types

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager manages a cache of roles by fetching unknown roles from the settings.RoleService.

func NewManager

func NewManager(o ...Option) Manager

NewManager returns a new instance of Manager.

func (*Manager) FindPermissionByID

func (m *Manager) FindPermissionByID(ctx context.Context, roleIDs []string, permissionID string) *settings.Setting

FindPermissionByID searches for a permission-setting by the permissionID, but limited to the given roleIDs

func (*Manager) List

func (m *Manager) List(ctx context.Context, roleIDs []string) []*settings.Bundle

List returns all roles that match the given roleIDs.

type Option

type Option func(*Options)

Option mutates option

func CacheSize

func CacheSize(s int) Option

CacheSize configures the size of the cache in items.

func CacheTTL

func CacheTTL(ttl time.Duration) Option

CacheTTL rebuilds the cache after the configured duration.

func Logger

func Logger(logger log.Logger) Option

Logger sets a preconfigured logger

func RoleService

func RoleService(rs settings.RoleService) Option

RoleService provides endpoints for fetching roles.

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options are all the possible options.