export

type DBClient interface {
	CloseSession()

	Connect() error

	// ********************** REGISTRATION FUNCTIONS *****************************
	// Return all the registrations
	// UnexpectedError - failed to retrieve registrations from the database
	Registrations() ([]Registration, error)

	// Add a new registration
	// UnexpectedError - failed to add to database
	AddRegistration(reg *Registration) (bson.ObjectId, error)

	// Update a registration
	// UnexpectedError - problem updating in database
	// NotFound - no registration with the ID was found
	UpdateRegistration(reg Registration) error

	// Get a registration by ID
	// UnexpectedError - problem getting in database
	// NotFound - no registration with the ID was found
	RegistrationById(id string) (Registration, error)

	// Get a registration by name
	// UnexpectedError - problem getting in database
	// NotFound - no registration with the name was found
	RegistrationByName(name string) (Registration, error)

	// Delete a registration by ID
	// UnexpectedError - problem getting in database
	// NotFound - no registration with the ID was found
	DeleteRegistrationById(id string) error

	// Delete a registration by name
	// UnexpectedError - problem getting in database
	// NotFound - no registration with the ID was found
	DeleteRegistrationByName(name string) error

	// Delete all registrations
	ScrubAllRegistrations() error
}

type EncryptionDetails struct {
	Algo       string `bson:"encryptionAlgorithm,omitempty" json:"encryptionAlgorithm,omitempty"`
	Key        string `bson:"encryptionKey,omitempty" json:"encryptionKey,omitempty"`
	InitVector string `bson:"initializingVector,omitempty" json:"initializingVector,omitempty"`
}

type Filter struct {
	DeviceIDs          []string `bson:"deviceIdentifiers,omitempty" json:"deviceIdentifiers,omitempty"`
	ValueDescriptorIDs []string `bson:"valueDescriptorIdentifiers,omitempty" json:"valueDescriptorIdentifiers,omitempty"`
}

type Registration struct {
	ID          bson.ObjectId      `bson:"_id,omitempty" json:"id,omitempty"`
	Created     int64              `json:"created"`
	Modified    int64              `json:"modified"`
	Origin      int64              `json:"origin"`
	Name        string             `json:"name,omitempty"`
	Addressable models.Addressable `json:"addressable,omitempty"`
	Format      string             `json:"format,omitempty"`
	Filter      Filter             `json:"filter,omitempty"`
	Encryption  EncryptionDetails  `json:"encryption,omitempty"`
	Compression string             `json:"compression,omitempty"`
	Enable      bool               `json:"enable"`
	Destination string             `json:"destination,omitempty"`
}