globalregistry

type LdapMember interface {
	ProjectMember
	GetDN() string
}

type Project interface {

	// GetName returns the name of the project.
	GetName() string

	// Delete removes the project from the registry.
	Delete() error

	// GetMembers returns the list of project members.
	GetMembers() ([]ProjectMember, error)

	// AssignMember method assigns a project member (user, group or robot)
	// to a project. When credentials are created by the registry provider,
	// they are returned. Otherwise, ProjectMemberCredentials is nil.
	AssignMember(ProjectMember) (*ProjectMemberCredentials, error)

	// UnassignMember removes a project member from the project.
	UnassignMember(ProjectMember) error

	// GetReplicationRules returns the list of replication rule concerning
	// the project of the registry.
	GetReplicationRules(*ReplicationTrigger, *ReplicationDirection) ([]ReplicationRule, error)

	// AssignReplicationRule assigns a replication rule to the project.
	AssignReplicationRule(RegistryConfig, ReplicationTrigger, ReplicationDirection) (ReplicationRule, error)

	// GetScanner returns the scanner assigned to the project.
	GetScanner() (Scanner, error)

	// AssignScanner assigns a scanner to the project.
	AssignScanner(Scanner) error

	// UnassignScanner removes a scanner from the project.
	UnassignScanner(Scanner) error

	Storage
}

type ProjectAPI interface {

	// List returns the list of the projects managed by the registry.
	List() ([]Project, error)

	// GetByName returns the project with the given name. If no project is
	// present with the given name (nil, nil) is returned.
	GetByName(name string) (Project, error)

	// Create creates a new project with the given name.
	Create(name string) (Project, error)
}

type ProjectMember interface {

	// GetName method returns with the name of the project member.
	GetName() string

	// GetType method returns with the type of the project member, e.g.
	// user, group, robot, etc.
	GetType() string

	// GetRole method returns with the role of the project member, e.g.
	// Maintainer, Administrator, etc.
	GetRole() string
}

type ProjectMemberCredentials struct {
	Username string
	Password string
}

type Registry interface {
	RegistryConfig
	ReplicationAPI() ReplicationAPI
	ProjectAPI() ProjectAPI
}

type RegistryConfig interface {
	GetProvider() string
	GetUsername() string
	GetPassword() string
	GetAPIEndpoint() string
	GetName() string
}

type RegistryCreator func(logr.Logger, RegistryConfig) (Registry, error)

type ReplicationAPI interface {
	// List method returns the replication rules of a registry.
	List() ([]ReplicationRule, error)
}

type ReplicationCapabilities interface {
	CanPull() bool
	CanPush() bool
}

type ReplicationDirection int

type ReplicationRule interface {

	// GetProjectName returns the name of the project that is subject to the
	// replication.
	GetProjectName() string

	// GetName returns the name of the replication rule.
	GetName() string

	// Trigger returns the event that starts the replication.
	Trigger() ReplicationTrigger

	// Direction returns the direction of the synchronization.
	Direction() ReplicationDirection

	// RemoteRegistry returns the remote registry which is subject to the
	// replication.
	RemoteRegistry() Registry

	// Delete method deletes the replication rule from the registry.
	Delete() error
}

type ReplicationTrigger int

type Scanner interface {

	// GetName returns the name of the vulnerability scanner.
	GetName() string

	// GetURL returns the URL of the vulnerability scanner.
	GetURL() string
}

type Storage interface {
	// GetUsedStorage returns the used storage in bytes.
	GetUsedStorage() (int, error)
}