storage

type Broker interface {
	// Create stores a broker in SM DB
	Create(ctx context.Context, broker *types.Broker) (string, error)

	// Get retrieves a broker using the provided id from SM DB
	Get(ctx context.Context, id string) (*types.Broker, error)

	// List retrieves all brokers from SM DB
	List(ctx context.Context, criteria ...query.Criterion) ([]*types.Broker, error)

	// Delete deletes a broker from SM DB
	Delete(ctx context.Context, criteria ...query.Criterion) error

	// Update updates a broker from SM DB
	Update(ctx context.Context, broker *types.Broker, labelChanges ...*query.LabelChange) error
}

type Credentials interface {
	// Get retrieves credentials using the provided username from SM DB
	Get(ctx context.Context, username string) (*types.Credentials, error)
}

type HealthIndicator struct {
	Pinger Pinger
}

type OpenCloser interface {
	// Open initializes the storage, e.g. opens a connection to the underlying storage
	Open(options *Settings) error

	// Close clears resources associated with this storage, e.g. closes the connection the underlying storage
	Close() error
}

type PingFunc func() error

type Pinger interface {
	// Ping verifies a connection to the database is still alive, establishing a connection if necessary.
	Ping() error
}

type Platform interface {
	// Create stores a platform in SM DB
	Create(ctx context.Context, platform *types.Platform) (string, error)

	// Get retrieves a platform using the provided id from SM DB
	Get(ctx context.Context, id string) (*types.Platform, error)

	// List retrieves all platforms from SM DB
	List(ctx context.Context, criteria ...query.Criterion) ([]*types.Platform, error)

	// Delete deletes a platform from SM DB
	Delete(ctx context.Context, criteria ...query.Criterion) error

	// Update updates a platform from SM DB
	Update(ctx context.Context, platform *types.Platform) error
}

type Repository interface {
	Warehouse

	// InTransaction initiates a transaction and allows passing a function to be executed within the transaction
	InTransaction(ctx context.Context, f func(ctx context.Context, storage Warehouse) error) error
}

type Security interface {
	// Lock locks the storage so that only one process can manipulate the encryption key.
	// Returns an error if the process has already acquired the lock
	Lock(ctx context.Context) error

	// Unlock releases the acquired lock.
	Unlock(ctx context.Context) error

	// Fetcher provides means to obtain the encryption key
	Fetcher() security.KeyFetcher

	// Setter provides means to change the encryption  key
	Setter() security.KeySetter
}

type ServiceOffering interface {
	// Create stores a service offering in SM DB
	Create(ctx context.Context, serviceOffering *types.ServiceOffering) (string, error)

	// Get retrieves a service offering using the provided id from SM DB
	Get(ctx context.Context, id string) (*types.ServiceOffering, error)

	// List retrieves all service offerings from SM DB
	List(ctx context.Context, criteria ...query.Criterion) ([]*types.ServiceOffering, error)

	// ListWithServicePlansByBrokerID retrieves all service offerings with their service plans from SM DB that match the specified broker ID
	ListWithServicePlansByBrokerID(ctx context.Context, brokerID string) ([]*types.ServiceOffering, error)

	// Delete deletes a service offering from SM DB
	Delete(ctx context.Context, criteria ...query.Criterion) error

	// Update updates a service offering from SM DB
	Update(ctx context.Context, serviceOffering *types.ServiceOffering) error
}

type ServicePlan interface {
	// Create stores a service plan in SM DB
	Create(ctx context.Context, servicePlan *types.ServicePlan) (string, error)

	// Get retrieves a service plan using the provided id from SM DB
	Get(ctx context.Context, id string) (*types.ServicePlan, error)

	// List retrieves all service plans from SM DB
	List(ctx context.Context, criteria ...query.Criterion) ([]*types.ServicePlan, error)

	// Delete deletes a  service plan from SM DB
	Delete(ctx context.Context, criteria ...query.Criterion) error

	// Update updates a service plan from SM DB
	Update(ctx context.Context, servicePlan *types.ServicePlan) error
}

type Settings struct {
	URI               string
	MigrationsURL     string `mapstructure:"migrations_url"`
	EncryptionKey     string `mapstructure:"encryption_key"`
	SkipSSLValidation bool   `mapstructure:"skip_ssl_validation"`
}

type Storage interface {
	OpenCloser
	Pinger
	Repository
}

type Visibility interface {
	// Create stores a visibility in SM DB
	Create(ctx context.Context, visibility *types.Visibility) (string, error)

	// Get retrieves a visibility using the provided id from SM DB
	Get(ctx context.Context, id string) (*types.Visibility, error)

	// List retrieves all visibilities from SM DB
	List(ctx context.Context, criteria ...query.Criterion) ([]*types.Visibility, error)

	// Delete deletes a visibility from SM DB
	Delete(ctx context.Context, criteria ...query.Criterion) error

	// Update updates a visibility from SM DB
	Update(ctx context.Context, visibility *types.Visibility, labelChanges ...*query.LabelChange) error
}

type Warehouse interface {
	// Broker provides access to service broker db operations
	Broker() Broker

	// ServiceOffering provides access to service offering db operations
	ServiceOffering() ServiceOffering

	// ServicePlan provides access to service plan db operations
	ServicePlan() ServicePlan

	// Visibility provides access to visibilities db operations
	Visibility() Visibility

	// Platform provides access to platform db operations
	Platform() Platform

	// Credentials provides access to credentials db operations
	Credentials() Credentials

	// Security provides access to encryption key management
	Security() Security
}