multiwatcher

type ActionInfo struct {
	ModelUUID      string
	ID             string
	Receiver       string
	Name           string
	Parameters     map[string]interface{}
	Parallel       bool
	ExecutionGroup string
	Status         string
	Message        string
	Results        map[string]interface{}
	Enqueued       time.Time
	Started        time.Time
	Completed      time.Time
}

type AnnotationInfo struct {
	ModelUUID   string
	Tag         string
	Annotations map[string]string
}

type ApplicationInfo struct {
	ModelUUID       string
	Name            string
	Exposed         bool
	CharmURL        string
	OwnerTag        string
	Life            life.Value
	MinUnits        int
	Constraints     constraints.Value
	Annotations     map[string]string
	Config          map[string]interface{}
	Subordinate     bool
	Status          StatusInfo
	OperatorStatus  StatusInfo // For CAAS models.
	WorkloadVersion string
	PodSpec         *PodSpec // For CAAS models.
}

type ApplicationOfferInfo struct {
	ModelUUID            string
	OfferName            string
	OfferUUID            string
	ApplicationName      string
	CharmName            string
	TotalConnectedCount  int
	ActiveConnectedCount int
}

type BlockInfo struct {
	ModelUUID string
	ID        string
	Type      model.BlockType
	Message   string
	Tag       string
}

type BranchInfo struct {
	ModelUUID     string
	ID            string
	Name          string
	AssignedUnits map[string][]string
	Config        map[string][]ItemChange
	Created       int64
	CreatedBy     string
	Completed     int64
	CompletedBy   string
	GenerationID  int
}

type CharmInfo struct {
	ModelUUID    string
	CharmURL     string
	CharmVersion string
	Life         life.Value
	LXDProfile   *Profile
	// DefaultConfig is derived from state-stored *charm.Config.
	DefaultConfig map[string]interface{}
}

type CharmRelation struct {
	Name      string
	Role      string
	Interface string
	Optional  bool
	Limit     int
	Scope     string
}

type Delta struct {
	// If Removed is true, the entity has been removed;
	// otherwise it has been created or changed.
	Removed bool
	// Entity holds data about the entity that has changed.
	Entity EntityInfo
}

type Endpoint struct {
	ApplicationName string
	Relation        CharmRelation
}

type EntityID struct {
	Kind      string
	ModelUUID string
	ID        string
}

type EntityInfo interface {
	// EntityID returns an identifier that will uniquely
	// identify the entity within its kind
	EntityID() EntityID

	// Clone returns a clone of the EntityInfo.
	Clone() EntityInfo
}

type Factory interface {
	// TODO: WatchUsersModels to filter just the user's models
	WatchModel(modelUUID string) Watcher
	WatchController() Watcher
}

type ItemChange struct {
	Type     int
	Key      string
	OldValue interface{}
	NewValue interface{}
}

type Logger interface {
	IsTraceEnabled() bool
	Tracef(string, ...interface{})
	Errorf(string, ...interface{})
	Criticalf(string, ...interface{})
}

type MachineInfo struct {
	ModelUUID                string
	ID                       string
	InstanceID               string
	AgentStatus              StatusInfo
	InstanceStatus           StatusInfo
	Life                     life.Value
	Annotations              map[string]string
	Config                   map[string]interface{}
	Series                   string
	ContainerType            string
	IsManual                 bool
	SupportedContainers      []instance.ContainerType
	SupportedContainersKnown bool
	HardwareCharacteristics  *instance.HardwareCharacteristics
	CharmProfiles            []string
	Jobs                     []model.MachineJob
	Addresses                []network.ProviderAddress
	HasVote                  bool
	WantsVote                bool

	// The preferred public and preferred private address are
	// only stored on the machine info to populate the unit info.
	PreferredPublicAddress  network.SpaceAddress
	PreferredPrivateAddress network.SpaceAddress

	// The machine's hostname reported by the machine agent when it started.
	Hostname string
}

type ModelInfo struct {
	ModelUUID       string
	Type            model.ModelType
	Name            string
	Life            life.Value
	Owner           string
	ControllerUUID  string
	IsController    bool
	Cloud           string
	CloudRegion     string
	CloudCredential string
	Annotations     map[string]string
	Config          map[string]interface{}
	Status          StatusInfo
	Constraints     constraints.Value
	SLA             ModelSLAInfo

	UserPermissions map[string]permission.Access
}

type ModelSLAInfo struct {
	Level string
	Owner string
}

type PodSpec struct {
	Spec    string
	Raw     bool
	Counter int
}

type Profile struct {
	Config      map[string]string
	Description string
	Devices     map[string]map[string]string
}

type RelationInfo struct {
	ModelUUID string
	Key       string
	ID        int
	Endpoints []Endpoint
}

type RemoteApplicationUpdate struct {
	ModelUUID string
	Name      string
	OfferUUID string
	OfferURL  string
	Life      life.Value
	Status    StatusInfo
}

type StatusInfo struct {
	Err     error
	Current status.Status
	Message string
	Since   *time.Time
	Version string
	Data    map[string]interface{}
}

type Store interface {
	All() []EntityInfo
	// ChangesSince takes revno. A zero implies that this is the first call for changes.
	// A slice of changes is returned along with the latest revno that the store has seen.
	ChangesSince(revno int64) ([]Delta, int64)

	// AddReference and DecReference are used for internal reference counting for the
	// watchers that have been notified.
	// TODO: determine if this is actually useful, and whether this is the right place for it.
	AddReference(revno int64)
	DecReference(revno int64)

	Get(id EntityID) EntityInfo
	Update(info EntityInfo)
	Remove(id EntityID)

	// Size returns the internal size of the store's list.
	// Used only for tests and metrics.
	Size() int
}

type UnitInfo struct {
	ModelUUID                string
	Name                     string
	Application              string
	Series                   string
	CharmURL                 string
	Life                     life.Value
	Annotations              map[string]string
	PublicAddress            string
	PrivateAddress           string
	MachineID                string
	OpenPortRangesByEndpoint network.GroupedPortRanges
	Principal                string
	Subordinate              bool
	// Workload and agent state are modelled separately.
	WorkloadStatus  StatusInfo
	AgentStatus     StatusInfo
	ContainerStatus StatusInfo // For CAAS models.
}

type Watcher interface {
	Stop() error
	Next() ([]Delta, error)
}