sparks

type Attributes = types.Params

type EncryptionProvider interface {
	// Decrypt descrypts the bytes
	Decrypt([]byte, Params) ([]byte, error)

	// Encrypt encrypts the bytes
	Encrypt([]byte, Params) ([]byte, error)
}

type NewFunc func(params Params) (Provider, error)

type ObjectProvider interface {
	// OpenObjectStore store returns an object store with the given name and parameter
	OpenObjectStore(name string, params ...Params) (ObjectStore, error)
}

type ObjectStore interface {
	// GetObject returns an io.Reader that allows for getting the object data
	GetObject(key string, params ...Params) (io.Reader, error)

	// GetObjectLink returns a secure http link to the object
	GetObjectLink(key string, timeout time.Duration, write ...bool) (*types.Link, error)

	// PutObject set the value
	PutObject(key string, r io.Reader, params ...Params) error

	// DeleteObject deletes and object
	DeleteObject(key string, params ...Params) error

	// StatObject returns properties of the object
	StatObject(key string) (types.StringMap, error)

	// ListObjects returns a list of object keys for the specified prefix
	ListObjects(prefix string) ([]os.FileInfo, error)

	// Name returns the object store name
	Name() string
}

type Params = types.Params

type Provider interface {
	// Name returns the provider name
	Name() string

	// Close is called to cleanup the provider
	Close()
}

type Queue interface {
	// Publish publishes the message body with optioanl attributes and return the id
	Publish(body []byte, attributes ...Attributes) (string, error)

	// Scan performs a canceleable scan on the queue
	Scan(ctx context.Context, handler func(msg QueueMessage) error) error
}

type QueueError error

type QueueMessage interface {
	// MessageID returns a unique message identifier
	MessageID() string

	// Body returns the message body as []byte
	Body() []byte

	// Attributes returns the message attributes as a map
	Attributes() types.StringMap
}

type QueueProvider interface {
	OpenQueue(name string, params Params) (Queue, error)
}

type User interface {
	// Login returns the user login i.e. username
	Login() string

	// Attributes returns a map of user attributes
	Attributes() types.StringMap

	// Status returns the user status as a string
	Status() string

	// Enabled represents the user's status
	Enabled() bool

	// Groups returns a list of groups the user belongs to
	Groups() []string
}

type UserPool interface {
	// AuthenticateUser authenticates the user and returns an AuthToken
	AuthenticateUser(username, password string) (keychain.AuthToken, error)

	// CreateUser creates a new user
	CreateUser(username, password string, attributes map[string]string, options ...Params) (User, error)

	// ChangeUserPassword attempts to change the users password from current to the proposed
	ChangeUserPassword(username, current, proposed string) error

	// GetUser returns a user
	GetUser(username string) (User, error)

	// UpdateUser updates a users attributes
	UpdateUser(username string, attributes types.StringMap) error

	// DeleteUser deletes a user record
	DeleteUser(username string) error

	// DisableUser disables a user account
	DisableUser(username string) error
}

type UserProvider interface {
	// OpenUserPool returns a user pool with the given name and parameters
	OpenUserPool(name string, options Params) (UserPool, error)
}