domainservice

type BlueprintSpecRepository interface {
	// GetById returns a BlueprintSpec identified by its ID or
	// a NotFoundError if the BlueprintSpec was not found or
	// a domain.InvalidBlueprintError together with a BlueprintSpec without blueprint and mask if the BlueprintSpec could not be parsed or
	// an InternalError if there is any other error.
	GetById(ctx context.Context, blueprintId string) (*domain.BlueprintSpec, error)
	// Update updates a given BlueprintSpec.
	// returns a ConflictError if there were changes on the BlueprintSpec in the meantime or
	// returns an InternalError if there is any other error
	Update(ctx context.Context, blueprintSpec *domain.BlueprintSpec) error
}

type ComponentInstallationRepository interface {
	// GetByName loads an installed component from the ecosystem and returns
	//  - the ecosystem.ComponentInstallation or
	//  - a NotFoundError if the component is not installed or
	//  - an InternalError if there is any other error.
	GetByName(ctx context.Context, componentName common.SimpleComponentName) (*ecosystem.ComponentInstallation, error)
	// GetAll returns
	//  - the installation info of all installed components or
	//  - an InternalError if there is any other error.
	GetAll(ctx context.Context) (map[common.SimpleComponentName]*ecosystem.ComponentInstallation, error)
	// Delete deletes the component by name from the ecosystem.
	// returns an InternalError if there is an error.
	Delete(ctx context.Context, componentName common.SimpleComponentName) error
	// Create creates the ecosystem.ComponentInstallation in the ecosystem.
	// returns an InternalError if there is an error.
	Create(ctx context.Context, component *ecosystem.ComponentInstallation) error
	// Update updates the ecosystem.ComponentInstallation in the ecosystem.
	// returns an InternalError if anything went wrong.
	Update(ctx context.Context, component *ecosystem.ComponentInstallation) error
}

type ConfigEncryptionAdapter interface {
	// Encrypt encrypts the given value for a dogu.
	// It can throw an InternalError if the encryption did not succeed, public key is missing or config store is not reachable.
	// It can throw a NotFoundError if the encryption key is not found.
	Encrypt(context.Context, common.SimpleDoguName, common.SensitiveDoguConfigValue) (common.EncryptedDoguConfigValue, error)
	// EncryptAll encrypts the given values for a dogu.
	// If the encryption fails on a part of the values, the resulting error is returned along with a map that only holds
	// the values that could have been encrypted.
	// It can throw an InternalError if the encryption did not succeed or config store is not reachable.
	// It can throw a NotFoundError if the encryption key is not found.
	EncryptAll(context.Context, map[common.SensitiveDoguConfigKey]common.SensitiveDoguConfigValue) (map[common.SensitiveDoguConfigKey]common.EncryptedDoguConfigValue, error)
	// Decrypt decrypts sensitive dogu values.
	// It can throw
	//  - NotFoundError if decryption key is not found
	//  - InternalError in any other error case
	Decrypt(context.Context, common.SimpleDoguName, common.EncryptedDoguConfigValue) (common.SensitiveDoguConfigValue, error)
	// DecryptAll decrypts a map of sensitive dogu values.
	// If the decryption fails on a part of the values, the resulting error is returned along with a map that only holds
	// the values that could have been decrypted.
	// This method can throw
	//  - NotFoundError if decryption key is not found
	//  - InternalError in any other error case
	DecryptAll(context.Context, map[common.SensitiveDoguConfigKey]common.EncryptedDoguConfigValue) (map[common.SensitiveDoguConfigKey]common.SensitiveDoguConfigValue, error)
}

type ConflictError struct {
	WrappedError error
	Message      string
}

type DoguConfigEntryRepository interface {
	// Get retrieves a key from the dogu's config.
	// It can throw the following errors:
	// 	- NotFoundError if the key is not found.
	// 	- InternalError if any other error happens.
	Get(context.Context, common.DoguConfigKey) (*ecosystem.DoguConfigEntry, error)
	// GetAllByKey retrieves all ecosystem.DoguConfigEntry's for the given ecosystem.DoguConfigKey's config.
	// It can trow the following errors:
	// 	- NotFoundError if there is no config for the dogu.
	// 	- InternalError if any other error happens.
	GetAllByKey(context.Context, []common.DoguConfigKey) (map[common.DoguConfigKey]*ecosystem.DoguConfigEntry, error)
	// Save persists the config for the given dogu. Config can be set even if the dogu is not yet installed.
	// It can throw the following errors:
	//	- ConflictError if there were concurrent write accesses.
	//	- InternalError if any other error happens.
	Save(context.Context, *ecosystem.DoguConfigEntry) error
	// SaveAll persists all given config keys. Configs can be set even if the dogus are not installed.
	// It can throw the following errors:
	//	- ConflictError if there were concurrent write accesses.
	//	- InternalError if any other error happens.
	SaveAll(context.Context, []*ecosystem.DoguConfigEntry) error
	// Delete deletes a dogu config key.
	// It can throw an InternalError if any error happens.
	// If the key is not existent no error will be returned.
	Delete(context.Context, common.DoguConfigKey) error
	// DeleteAllByKeys deletes all given dogu config keys.
	// It can throw an InternalError if any error happens.
	// If any key is not existent, no error will be returned for that case.
	DeleteAllByKeys(context.Context, []common.DoguConfigKey) error
}

type DoguInstallationRepository interface {
	// GetByName returns the ecosystem.DoguInstallation or
	// a NotFoundError if the dogu is not installed or
	// an InternalError if there is any other error.
	GetByName(ctx context.Context, doguName common.SimpleDoguName) (*ecosystem.DoguInstallation, error)
	// GetAll returns the installation info of all installed dogus or
	// an InternalError if there is any other error.
	GetAll(ctx context.Context) (map[common.SimpleDoguName]*ecosystem.DoguInstallation, error)
	// Create saves a new ecosystem.DoguInstallation. This initiates a dogu installation. It returns
	// a ConflictError if there is already a DoguInstallation with this name or
	// an InternalError if there is any error while saving the DoguInstallation
	Create(ctx context.Context, dogu *ecosystem.DoguInstallation) error
	// Update updates an ecosystem.DoguInstallation in the ecosystem.
	// returns a ConflictError if there were changes on the DoguInstallation in the meantime or
	// TODO: also return NotFoundErrors? Does k8s supply this error to us?
	// returns an InternalError if there is any other error
	Update(ctx context.Context, dogu *ecosystem.DoguInstallation) error
	// Delete removes the given ecosystem.DoguInstallation completely from the ecosystem.
	// We delete DoguInstallations with the object not just the name as this way we can detect concurrent updates.
	// returns a ConflictError if there were changes on the DoguInstallation in the meantime or
	// returns an InternalError if there is any other error
	Delete(ctx context.Context, doguName common.SimpleDoguName) error
}

type DoguRestartRepository interface {
	// RestartAll restarts all provided Dogus
	RestartAll(context.Context, []common.SimpleDoguName) error
}

type DoguToLoad struct {
	DoguName common.QualifiedDoguName
	Version  string
}

type GlobalConfigEntryRepository interface {
	// Get retrieves a key from the global config.
	// It can throw the following errors:
	// 	- NotFoundError if the key or the global config is not found.
	// 	- InternalError if any other error happens.
	Get(context.Context, common.GlobalConfigKey) (*ecosystem.GlobalConfigEntry, error)
	// GetAllByKey retrieves entries for the given keys from the global config.
	// It can throw the following errors:
	// 	- NotFoundError if a key or the global config is not found.
	// 	- InternalError if any other error happens.
	GetAllByKey(context.Context, []common.GlobalConfigKey) (map[common.GlobalConfigKey]*ecosystem.GlobalConfigEntry, error)
	// Save persists the global config.
	// It can throw the following errors:
	//  - ConflictError if there were concurrent write accesses.
	//  - InternalError if any other error happens.
	Save(context.Context, *ecosystem.GlobalConfigEntry) error
	// SaveAll persists all given config keys.
	// It can throw the following errors:
	//	- ConflictError if there were concurrent write accesses.
	//	- InternalError if any other error happens.
	SaveAll(context.Context, []*ecosystem.GlobalConfigEntry) error
	// Delete deletes a global config key.
	// It can throw an InternalError if any error happens.
	// If the key is not existent, no error will be returned.
	Delete(context.Context, common.GlobalConfigKey) error
	// DeleteAllByKeys deletes all given global config keys.
	// It can throw an InternalError if any error happens.
	// If any key is not existent, no error will be returned for that case.
	DeleteAllByKeys(context.Context, []common.GlobalConfigKey) error
}

type HealthWaitConfigProvider interface {
	GetWaitConfig(ctx context.Context) (ecosystem.WaitConfig, error)
}

type InternalError struct {
	WrappedError error
	Message      string
}

type MaintenanceMode interface {
	// Activate enables the maintenance mode with the given page model.
	// May throw a generic InternalError or a ConflictError if another party activated the maintenance mode.
	Activate(content MaintenancePageModel) error
	// Deactivate disables the maintenance mode if it is active.
	// May throw a generic InternalError or a ConflictError if another party holds the maintenance mode lock.
	Deactivate() error
}

type MaintenancePageModel struct {
	Title string
	Text  string
}

type NotFoundError struct {
	WrappedError error
	Message      string
}

type RemoteDoguRegistry interface {
	// GetDogu returns the dogu specification for the given dogu and version or
	// an NotFoundError indicating that there was no dogu spec found or
	// an InternalError indicating that the caller has no fault.
	GetDogu(doguName common.QualifiedDoguName, version string) (*core.Dogu, error)

	// GetDogus returns the all requested dogu specifications or
	// an NotFoundError indicating that any dogu spec was not found or
	// an InternalError indicating that the caller has no fault.
	GetDogus(dogusToLoad []DoguToLoad) (map[common.QualifiedDoguName]*core.Dogu, error)
}

type RequiredComponentsProvider interface {
	GetRequiredComponents(ctx context.Context) ([]ecosystem.RequiredComponent, error)
}

type SensitiveDoguConfigEntryRepository interface {
	// Get retrieves a key from the dogu's sensitive config.
	// It can throw the following errors:
	// 	- NotFoundError if the key is not found.
	// 	- InternalError if any other error happens.
	Get(context.Context, common.SensitiveDoguConfigKey) (*ecosystem.SensitiveDoguConfigEntry, error)
	// GetAllByKey retrieves a dogu's sensitive config for the given keys.
	// It can trow the following errors:
	// 	- NotFoundError if there is no config for the dogu.
	// 	- InternalError if any other error happens.
	GetAllByKey(context.Context, []common.SensitiveDoguConfigKey) (map[common.SensitiveDoguConfigKey]*ecosystem.SensitiveDoguConfigEntry, error)
	// Save persists the sensitive config for the given dogu. Config can be set even if the dogu is not yet installed.
	// It can throw the following errors:
	//	- ConflictError if there were concurrent write accesses.
	//	- InternalError if any other error happens.
	Save(context.Context, *ecosystem.SensitiveDoguConfigEntry) error
	// SaveForNotInstalledDogu persists the config for the given dogu. In contrast to Save or SaveAll the dogu is not
	// already installed and no public key exists. However, the value should be encrypted and the repository must decide how.
	SaveForNotInstalledDogu(ctx context.Context, entry *ecosystem.SensitiveDoguConfigEntry) error
	// SaveAllForNotInstalledDogu persists all given configs for the given dogu. In contrast to Save or SaveAll the dogu is not
	// already installed and no public key exists. However, the value should be encrypted and the repository must decide how.
	// It can throw the following errors:
	//  - InternalError if any error happens.
	SaveAllForNotInstalledDogu(context.Context, common.SimpleDoguName, []*ecosystem.SensitiveDoguConfigEntry) error
	// SaveAllForNotInstalledDogus persists all given configs for the given sensitive dogu entries.
	// It can throw the following errors:
	//  - InternalError if any error happens.
	SaveAllForNotInstalledDogus(context.Context, []*ecosystem.SensitiveDoguConfigEntry) error
	// SaveAll persists all given sensitive config keys. sensitive configs can be set even if the dogus are not installed.
	// It can throw the following errors:
	//	- ConflictError if there were concurrent write accesses.
	//	- InternalError if any other error happens.
	SaveAll(context.Context, []*ecosystem.SensitiveDoguConfigEntry) error
	// Delete deletes a sensitive dogu config key.
	// It can throw an InternalError if any error happens.
	// If the key is not existent no error will be returned.
	Delete(context.Context, common.SensitiveDoguConfigKey) error
	// DeleteAllByKeys deletes all given sensitive dogu config keys.
	// It can throw an InternalError if any error happens.
	// If any key is not existent, no error will be returned for that case.
	DeleteAllByKeys(context.Context, []common.SensitiveDoguConfigKey) error
}

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