exchange

type Agbot struct {
	Token         string `json:"token"`
	Name          string `json:"name"`
	Owner         string `json:"owner"`
	MsgEndPoint   string `json:"msgEndPoint"`
	LastHeartbeat string `json:"lastHeartbeat"`
	PublicKey     []byte `json:"publicKey"`
}

type AgbotAgreement struct {
	Service     WorkloadAgreement `json:"service,omitempty"`
	State       string            `json:"state"`
	LastUpdated string            `json:"lastUpdated"`
}

type AgbotMessage struct {
	MsgId        int    `json:"msgId"`
	DeviceId     string `json:"nodeId"`
	DevicePubKey []byte `json:"nodePubKey"`
	Message      []byte `json:"message"`
	TimeSent     string `json:"timeSent"`
	TimeExpires  string `json:"timeExpires"`
}

type AgreementCommand struct {
}

type AgreementObject struct {
}

type AgreementProtocol struct {
	Name            string         `json:"name,omitempty"`            // The name of the agreement protocol to be used
	ProtocolVersion int            `json:"protocolVersion,omitempty"` // The max protocol version supported
	Blockchains     BlockchainList `json:"blockchains,omitempty"`     // The blockchain to be used if the protocol requires one.
}

type AllAgbotAgreementsResponse struct {
	Agreements map[string]AgbotAgreement `json:"agreements"`
	LastIndex  int                       `json:"lastIndex"`
}

type AllDeviceAgreementsResponse struct {
	Agreements map[string]DeviceAgreement `json:"agreements"`
	LastIndex  int                        `json:"lastIndex"`
}

type Blockchain struct {
	Type string `json:"type,omitempty"`         // The type of blockchain
	Name string `json:"name,omitempty"`         // The name of the blockchain instance in the exchange,it is specific to the value of the type
	Org  string `json:"organization,omitempty"` // The organization that owns the blockchain definition
}

type BlockchainList []Blockchain

type BusinessPoliciesHandler func(org string, policy_id string) (map[string]ExchangeBusinessPolicy, error)

type DataVerification struct {
	Enabled     bool   `json:"enabled,omitempty"`    // Whether or not data verification is enabled
	URL         string `json:"URL,omitempty"`        // The URL to be used for data receipt verification
	URLUser     string `json:"user,omitempty"`       // The user id to use when calling the verification URL
	URLPassword string `json:"password,omitempty"`   // The password to use when calling the verification URL
	Interval    int    `json:"interval,omitempty"`   // The number of seconds to check for data before deciding there isnt any data
	CheckRate   int    `json:"check_rate,omitempty"` // The number of seconds between checks for valid data being received
	Metering    Meter  `json:"metering,omitempty"`   // The metering configuration
}

type DeleteNodePolicyHandler func(deviceId string) error

type DeleteServicePolicyHandler func(sUrl string, sOrg string, sVersion string, sArch string) error

type DeleteServicePolicyWithIdHandler func(service_id string) error

type DestinationPolicy struct {
	// Properties is the set of properties for a particular policy
	Properties externalpolicy.PropertyList `json:"properties" bson:"properties"`

	// Constraints is a set of expressions that form the constraints for the policy
	Constraints externalpolicy.ConstraintExpression `json:"constraints" bson:"constraints"`

	// Services is the list of services this object has affinity for
	Services []common.ServiceID `json:"services" bson:"services"`

	// Timestamp indicates when the policy was last updated (result of time.Now().UnixNano())
	Timestamp int64 `json:"timestamp" bson:"timestamp"`
}

type Device struct {
	Token              string             `json:"token"`
	Name               string             `json:"name"`
	Owner              string             `json:"owner"`
	Pattern            string             `json:"pattern"`
	RegisteredServices []Microservice     `json:"registeredServices"`
	MsgEndPoint        string             `json:"msgEndPoint"`
	SoftwareVersions   SoftwareVersion    `json:"softwareVersions"`
	LastHeartbeat      string             `json:"lastHeartbeat"`
	PublicKey          []byte             `json:"publicKey"`
	Arch               string             `json:"arch"`
	UserInput          []policy.UserInput `json:"userInput"`
}

type DeviceAgreement struct {
	Service          []MSAgreementState `json:"services"`
	State            string             `json:"state"`
	AgreementService WorkloadAgreement  `json:"agrService"`
	LastUpdated      string             `json:"lastUpdated"`
}

type DeviceHandler func(id string, token string) (*Device, error)

type DeviceMessage struct {
	MsgId       int    `json:"msgId"`
	AgbotId     string `json:"agbotId"`
	AgbotPubKey []byte `json:"agbotPubKey"`
	Message     []byte `json:"message"`
	TimeSent    string `json:"timeSent"`
}

type EncryptedSymmetricValues []byte

type EncryptedWrappedMessage []byte

type ExchangeBusinessPolicy struct {
	businesspolicy.BusinessPolicy
	Created     string `json:"created,omitempty"`
	LastUpdated string `json:"lastUpdated,omitempty"`
}

type ExchangeContext interface {
	GetExchangeId() string
	GetExchangeToken() string
	GetExchangeURL() string
	GetCSSURL() string
	GetHTTPFactory() *config.HTTPClientFactory
}

type ExchangeMessage struct {
	WrappedMessage  EncryptedWrappedMessage  `json:"wrappedMessage"`
	SymmetricValues EncryptedSymmetricValues `json:"symmetricValues"`
}

type ExchangeMessageTarget struct {
	ReceiverExchangeId     string // in the form org/id
	ReceiverPublicKeyObj   *rsa.PublicKey
	ReceiverPublicKeyBytes []byte
	ReceiverMsgEndPoint    string
}

type ExchangeMessageWorker struct {
	worker.BaseWorker // embedded field
	// contains filtered or unexported fields
}

type ExchangePolicy struct {
	externalpolicy.ExternalPolicy
	LastUpdated string `json:"lastUpdated,omitempty"`
}

type ExchangeSurfaceError struct {
	ErrorList []persistence.SurfaceError `json:"errors"`
}

type ExchangeVersionHandler func(id string, token string) (string, error)

type GetAgbotMessageResponse struct {
	Messages  []AgbotMessage `json:"messages"`
	LastIndex int            `json:"lastIndex"`
}

type GetAgbotsBusinessPolsResponse struct {
	BusinessPols map[string]ServedBusinessPolicy `json:"businessPols"`
}

type GetAgbotsPatternsResponse struct {
	Patterns map[string]ServedPattern `json:"patterns"`
}

type GetAgbotsResponse struct {
	Agbots    map[string]Agbot `json:"agbots"`
	LastIndex int              `json:"lastIndex"`
}

type GetBusinessPolicyResponse struct {
	BusinessPolicy map[string]ExchangeBusinessPolicy `json:"businessPolicy,omitempty"` // map of all defined business policies
	LastIndex      int                               `json:"lastIndex.omitempty"`
}

type GetDeviceMessageResponse struct {
	Messages  []DeviceMessage `json:"messages"`
	LastIndex int             `json:"lastIndex"`
}

type GetDevicesResponse struct {
	Devices   map[string]Device `json:"nodes"`
	LastIndex int               `json:"lastIndex"`
}

type GetOrganizationResponse struct {
	Orgs      map[string]Organization `json:"orgs"`
	LastIndex int                     `json:"lastIndex"`
}

type GetPatternResponse struct {
	Patterns  map[string]Pattern `json:"patterns,omitempty"` // map of all defined patterns
	LastIndex int                `json:"lastIndex.omitempty"`
}

type GetServicesResponse struct {
	Services  map[string]ServiceDefinition `json:"services"`
	LastIndex int                          `json:"lastIndex"`
}

type HardwareRequirement map[string]interface{}

type ImageDockerAuth struct {
	DockAuthId  int    `json:"dockAuthId"`
	Registry    string `json:"registry"`
	UserName    string `json:"username"`
	Token       string `json:"token"`
	LastUpdated string `json:"lastUpdated"`
}

type MSAgreementState struct {
	Org string `json:"orgid"`
	URL string `json:"url"`
}

type MSProp struct {
	Name     string `json:"name"`
	Value    string `json:"value"`
	PropType string `json:"propType"`
	Op       string `json:"op"`
}

type Meter struct {
	Tokens                uint64 `json:"tokens,omitempty"`                // The number of tokens per time_unit
	PerTimeUnit           string `json:"per_time_unit,omitempty"`         // The per time units: min, hour and day are supported
	NotificationIntervalS int    `json:"notification_interval,omitempty"` // The number of seconds between metering notifications
}

type Microservice struct {
	Url           string   `json:"url"`
	Properties    []MSProp `json:"properties"`
	NumAgreements int      `json:"numAgreements"`
	Policy        string   `json:"policy"`
	ConfigState   string   `json:"configState"`
}

type NodeHealth struct {
	MissingHBInterval    int `json:"missing_heartbeat_interval,omitempty"` // How long a heartbeat can be missing until it is considered missing (in seconds)
	CheckAgreementStatus int `json:"check_agreement_status,omitempty"`     // How often to check that the node agreement entry still exists in the exchange (in seconds)
}

type NodeHealthStatus struct {
	Nodes map[string]NodeInfo `json:"nodes"`
}

type NodeHealthStatusRequest struct {
	NodeOrgIds []string `json:"nodeOrgids,omitempty"`
	LastCall   string   `json:"lastTime"`
}

type NodeInfo struct {
	LastHeartbeat string                     `json:"lastHeartbeat"`
	Agreements    map[string]AgreementObject `json:"agreements"`
}

type NodePolicyHandler func(deviceId string) (*ExchangePolicy, error)

type ObjectDestinationPolicies []ObjectDestinationPolicy

type ObjectDestinationPolicy struct {
	// OrgID is the organization ID of the object (an object belongs to exactly one organization).
	//   required: true
	OrgID string `json:"orgID"`

	// ObjectType is the type of the object.
	// The type is used to group multiple objects, for example when checking for object updates.
	//   required: true
	ObjectType string `json:"objectType"`

	// ObjectID is a unique identifier of the object
	//   required: true
	ObjectID string `json:"objectID"`

	// DestinationPolicy is the policy specification that should be used to distribute this object
	// to the appropriate set of destinations.
	DestinationPolicy DestinationPolicy `json:"destinationPolicy,omitempty"`

	//Destinations is the list of the object's current destinations
	Destinations []common.DestinationsStatus `json:"destinations"`
}

type ObjectDestinationQueryHandler func(org string, objID string, objType string) (*ObjectDestinationStatuses, error)

type ObjectDestinationStatuses []common.DestinationsStatus

type ObjectPolicyQueryHandler func(org string, serviceId string) (*ObjectDestinationPolicies, error)

type ObjectPolicyUpdateReceivedHandler func(objPol *ObjectDestinationPolicy) error

type ObjectPolicyUpdatesQueryHandler func(org string, since int64) (*ObjectDestinationPolicies, error)

type ObjectQueryHandler func(org string, objID string, objType string) (*common.MetaData, error)

type ObjectSigningKeysHandler func(oType, oUrl string, oOrg string, oVersion string, oArch string) (map[string]string, error)

type OrgHandler func(org string) (*Organization, error)

type OrgHandlerWithContext func(org string, id string, token string) (*Organization, error)

type Organization struct {
	Label       string `json:"label"`
	Description string `json:"description"`
	LastUpdated string `json:"lastUpdated"`
}

type PatchAgbotPublicKey struct {
	PublicKey []byte `json:"publicKey"`
}

type PatchDeviceHandler func(deviceId string, deviceToken string, pdr *PatchDeviceRequest) error

type PatchDeviceRequest struct {
	UserInput          *[]policy.UserInput `json:"userInput,omitempty"`
	Pattern            string              `json:"pattern,omitempty"`
	Arch               string              `json:"arch,omitempty"`
	RegisteredServices *[]Microservice     `json:"registeredServices,omitempty"`
}

type Pattern struct {
	Owner              string              `json:"owner"`
	Label              string              `json:"label"`
	Description        string              `json:"description"`
	Public             bool                `json:"public"`
	Services           []ServiceReference  `json:"services"`
	AgreementProtocols []AgreementProtocol `json:"agreementProtocols"`
	UserInput          []policy.UserInput  `json:"userInput,omitempty"`
}

type PatternHandler func(org string, pattern string) (map[string]Pattern, error)

type PatternHandlerWithContext func(org string, pattern string, id string, token string) (map[string]Pattern, error)

type PostDeviceResponse struct {
	Code string `json:"code"`
	Msg  string `json:"msg"`
}

type PostDeviceServicesConfigStateHandler func(deviceId string, deviceToken string, svcsConfigState *ServiceConfigState) error

type PostMessage struct {
	Message []byte `json:"message"`
	TTL     int    `json:"ttl"`
}

type PutAgbotAgreementState struct {
	Service WorkloadAgreement `json:"service,omitempty"`
	State   string            `json:"state"`
}

type PutAgreementState struct {
	State            string             `json:"state"`
	Services         []MSAgreementState `json:"services,omitempty"`
	AgreementService WorkloadAgreement  `json:"agreementService,omitempty"`
}

type PutDestinationListRequest []string

type PutDeviceHandler func(deviceId string, deviceToken string, pdr *PutDeviceRequest) (*PutDeviceResponse, error)

type PutDeviceRequest struct {
	Token              string          `json:"token"`
	Name               string          `json:"name"`
	Pattern            string          `json:"pattern"`
	RegisteredServices []Microservice  `json:"registeredServices"`
	MsgEndPoint        string          `json:"msgEndPoint"`
	SoftwareVersions   SoftwareVersion `json:"softwareVersions"`
	PublicKey          []byte          `json:"publicKey"`
	Arch               string          `json:"arch"`
}

type PutDeviceResponse map[string]string

type PutNodePolicyHandler func(deviceId string, ep *ExchangePolicy) (*PutDeviceResponse, error)

type PutServicePolicyHandler func(sUrl string, sOrg string, sVersion string, sArch string, ep *ExchangePolicy) (*PutDeviceResponse, error)

type PutServicePolicyWithIdHandler func(service_id string, ep *ExchangePolicy) (*PutDeviceResponse, error)

type PutSurfaceErrorsHandler func(deviceId string, errorList *ExchangeSurfaceError) (*PutDeviceResponse, error)

type ResetIntervalCommand struct {
}

type SearchExchBusinessPolRequest struct {
	NodeOrgIds   []string `json:"nodeOrgids,omitempty"`
	ChangedSince uint64   `json:"changedSince"`
}

type SearchExchBusinessPolResponse struct {
	Devices   []SearchResultDevice `json:"nodes"`
	LastIndex int                  `json:"lastIndex"`
}

type SearchExchangeMSRequest struct {
	DesiredServices    []Microservice `json:"desiredServices"`
	SecondsStale       int            `json:"secondsStale"`
	PropertiesToReturn []string       `json:"propertiesToReturn"`
	StartIndex         int            `json:"startIndex"`
	NumEntries         int            `json:"numEntries"`
}

type SearchExchangeMSResponse struct {
	Devices   []SearchResultDevice `json:"nodes"`
	LastIndex int                  `json:"lastIndex"`
}

type SearchExchangePatternRequest struct {
	ServiceURL   string   `json:"serviceUrl,omitempty"`
	NodeOrgIds   []string `json:"nodeOrgids,omitempty"`
	SecondsStale int      `json:"secondsStale"`
	StartIndex   int      `json:"startIndex"`
	NumEntries   int      `json:"numEntries"`
}

type SearchExchangePatternResponse struct {
	Devices   []SearchResultDevice `json:"nodes"`
	LastIndex int                  `json:"lastIndex"`
}

type SearchResultDevice struct {
	Id          string         `json:"id"`
	Name        string         `json:"name"`
	Services    []Microservice `json:"services"`
	MsgEndPoint string         `json:"msgEndPoint"`
	PublicKey   []byte         `json:"publicKey"`
}

type ServedBusinessPolicy struct {
	BusinessPolOrg string `json:"businessPolOrgid"` // defaults to nodeOrgid
	BusinessPol    string `json:"businessPol"`      // '*' means all
	NodeOrg        string `json:"nodeOrgid"`
	LastUpdated    string `json:"lastUpdated"`
}

type ServedPattern struct {
	PatternOrg  string `json:"patternOrgid"` // defaults to NodeOrg
	Pattern     string `json:"pattern"`      // '*' means all
	NodeOrg     string `json:"nodeOrgid"`
	LastUpdated string `json:"lastUpdated"`
}

type ServiceConfigState struct {
	Url         string `json:"url"`
	Org         string `json:"org"`
	ConfigState string `json:"configState"`
}

type ServiceDefinition struct {
	Owner               string              `json:"owner"`
	Label               string              `json:"label"`
	Description         string              `json:"description"`
	Public              bool                `json:"public"`
	URL                 string              `json:"url"`
	Version             string              `json:"version"`
	Arch                string              `json:"arch"`
	Sharable            string              `json:"sharable"`
	MatchHardware       HardwareRequirement `json:"matchHardware"`
	RequiredServices    []ServiceDependency `json:"requiredServices"`
	UserInputs          []UserInput         `json:"userInput"`
	Deployment          string              `json:"deployment"`
	DeploymentSignature string              `json:"deploymentSignature"`
	LastUpdated         string              `json:"lastUpdated"`
}

type ServiceDependency struct {
	URL          string `json:"url"`
	Org          string `json:"org"`
	Version      string `json:"version,omitempty"`
	VersionRange string `json:"versionRange"`
	Arch         string `json:"arch"`
}

type ServiceDockerAuthsHandler func(sUrl string, sOrg string, sVersion string, sArch string) ([]ImageDockerAuth, error)

type ServiceDockerAuthsWithIdHandler func(sId string) ([]ImageDockerAuth, error)

type ServiceHandler func(wUrl string, wOrg string, wVersion string, wArch string) (*ServiceDefinition, string, error)

type ServicePolicyHandler func(sUrl string, sOrg string, sVersion string, sArch string) (*ExchangePolicy, string, error)

type ServicePolicyWithIdHandler func(service_id string) (*ExchangePolicy, error)

type ServiceReference struct {
	ServiceURL      string           `json:"serviceUrl,omitempty"`      // refers to a service definition in the exchange
	ServiceOrg      string           `json:"serviceOrgid,omitempty"`    // the org holding the service definition
	ServiceArch     string           `json:"serviceArch,omitempty"`     // the hardware architecture of the service definition
	ServiceVersions []WorkloadChoice `json:"serviceVersions,omitempty"` // a list of service version for rollback
	DataVerify      DataVerification `json:"dataVerification"`          // policy for verifying that the node is sending data
	NodeH           NodeHealth       `json:"nodeHealth"`                // policy for determining when a node's health is violating its agreements
	AgreementLess   bool             `json:"agreementLess"`             // This service should get started on the node without an agreement to start it
}

type ServiceResolverHandler func(wUrl string, wOrg string, wVersion string, wArch string) (*policy.APISpecList, *ServiceDefinition, []string, error)

type ServicesConfigStateHandler func(id string, token string) ([]ServiceConfigState, error)

type SoftwareVersion map[string]string

type SurfaceErrorsHandler func(deviceId string) (*ExchangeSurfaceError, error)

type SymmetricValues struct {
	Key   []byte `json:"key"`
	Nonce []byte `json:"nonce"`
}

type UpdateObjectDestinationHandler func(org string, objPol *ObjectDestinationPolicy, dests *PutDestinationListRequest) error

type UpgradePolicy struct {
	Lifecycle string `json:"lifecycle,omitempty"` // immediate, never, agreement
	Time      string `json:"time,omitempty"`      // the time of the upgrade
}

type UserInput struct {
	Name         string `json:"name"`
	Label        string `json:"label"`
	Type         string `json:"type"` // Valid values are "string", "int", "float", "boolean", "list of strings"
	DefaultValue string `json:"defaultValue"`
}

type WorkloadAgreement struct {
	Org     string `json:"orgid,omitempty"` // the org of the pattern
	Pattern string `json:"pattern"`         // pattern - without the org prefix on it
	URL     string `json:"url,omitempty"`   // workload URL
}

type WorkloadChoice struct {
	Version                      string           `json:"version,omitempty"`  // the version of the workload
	Priority                     WorkloadPriority `json:"priority,omitempty"` // the highest priority workload is tried first for an agreement, if it fails, the next priority is tried. Priority 1 is the highest, priority 2 is next, etc.
	Upgrade                      UpgradePolicy    `json:"upgradePolicy,omitempty"`
	DeploymentOverrides          string           `json:"deployment_overrides"`           // env var overrides for the workload
	DeploymentOverridesSignature string           `json:"deployment_overrides_signature"` // signature of env var overrides
}

type WorkloadPriority struct {
	PriorityValue     int `json:"priority_value,omitempty"`     // The priority of the workload
	Retries           int `json:"retries,omitempty"`            // The number of retries before giving up and moving to the next priority
	RetryDurationS    int `json:"retry_durations,omitempty"`    // The number of seconds in which the specified number of retries must occur in order for the next priority workload to be attempted.
	VerifiedDurationS int `json:"verified_durations,omitempty"` // The number of second in which verified data must exist before the rollback retry feature is turned off
}

type WrappedMessage struct {
	Msg          []byte `json:"msg"`
	Signature    []byte `json:"signature"`
	SignerPubKey []byte `json:"signerPubkey"`
}