common

type AclAPI interface {
	// AclDetails retrieves the access control list details for one list
	AclDetails(string) (response.Acl, error)
	// CreateAcl creates the access control list
	CreateAcl(string, string, bool, []string) (response.Acl, error)
	// DeleteAcl deletes one access control list
	DeleteAcl(string) error
	// AllAcls fetches a list of all ACLs matching the given filter.
	AllAcls([]api.Filter) (response.AllAcls, error)
}

type ApplicationsAPI interface {
	// AllSecApplications returns all sec applications matching a filter. A nil valued
	// filter will return all entries in the API.
	AllSecApplications([]api.Filter) (response.AllSecApplications, error)
	// DefaultSecApplications returns all default security applications matching a filter.
	// A nil valued filter will return all entries in the API.
	DefaultSecApplications([]api.Filter) (response.AllSecApplications, error)
	// CreateSecApplications creates a security applications
	CreateSecApplication(api.SecApplicationParams) (response.SecApplication, error)
}

type AssociationAPI interface {
	// AllSecAssociations returns all security associations matching a filter. A nil valued
	// filter will return all entries in the API.
	AllSecAssociations([]api.Filter) (response.AllSecAssociations, error)
}

type Authenticater interface {
	Authenticate() error
}

type Composer interface {
	// ComposeName composes the name for a provider resource. The name
	// for an oracle API resource typically has the following form:
	//
	// /Compute-<Identity Domain>/<username>/<resource name>
	//
	// The Identity Domain in this case equates to what some other providers
	// like OpenStack refer to as tenants or projects.
	// This information is supplied by the user in the cloud configuration
	// information.
	// This function is generally needed
	ComposeName(string) string
}

type Imager interface {
	AllImageLists([]api.Filter) (response.AllImageLists, error)
	CreateImageList(def int, description string, name string) (resp response.ImageList, err error)
	CreateImageListEntry(name string, attributes map[string]interface{}, version int, machineImages []string) (resp response.ImageListEntryAdd, err error)
	DeleteImageList(name string) (err error)
}

type InstanceAPI interface {
	CreateInstance(api.InstanceParams) (response.LaunchPlan, error)
	AllInstances([]api.Filter) (response.AllInstances, error)
	DeleteInstance(string) error
}

type Instancer interface {
	// InstanceDetails retrieves information from the provider
	// about one instance
	InstanceDetails(string) (response.Instance, error)
}

type IpAddressPrefixSetAPI interface {
	// CreateIpAddressPrefixSet creates a new IP address prefix set inside the oracle
	// cloud, for the current user
	CreateIpAddressPrefixSet(
		api.IpAddressPrefixSetParams) (response.IpAddressPrefixSet, error)

	// AllIpAddressPrefixSets returns all IP address prefix sets that match the given filter.
	// A nil valued filter will return all entries in the API.
	AllIpAddressPrefixSets([]api.Filter) (response.AllIpAddressPrefixSets, error)
}

type IpAssociationAPI interface {
	CreateIpAssociation(common.IPPool, common.VcableID) (response.IpAssociation, error)
	DeleteIpAssociation(string) error
	AllIpAssociations([]api.Filter) (response.AllIpAssociations, error)
}

type IpNetworkExchanger interface {
	AllIpNetworkExchanges([]api.Filter) (response.AllIpNetworkExchanges, error)
}

type IpNetworker interface {
	AllIpNetworks([]api.Filter) (response.AllIpNetworks, error)
}

type IpReservationAPI interface {
	AllIpReservations([]api.Filter) (response.AllIpReservations, error)
	UpdateIpReservation(string, string,
		common.IPPool, bool, []string) (response.IpReservation, error)
	CreateIpReservation(string, common.IPPool,
		bool, []string) (response.IpReservation, error)
	DeleteIpReservation(string) error
}

type OracleInstancer interface {
	environs.Environ

	Details(id instance.Id) (response.Instance, error)
}

type RulesAPI interface {
	// AllSecRules returns all sec rules matching a filter. A nil valued
	// filter will return all entries in the API.
	AllSecRules([]api.Filter) (response.AllSecRules, error)
	// DeleteSecRule deletes the security rule with the given name
	DeleteSecRule(string) error
	// CreateSecRule creates the security rule inside oracle cloud
	// given the sec rule parameters
	CreateSecRule(api.SecRuleParams) (response.SecRule, error)
}

type SecIpAPI interface {
	// AllSecIpLists returns all sec IP lists that match a filter. A nil valued
	// filter will return all entries in the API.
	AllSecIpLists([]api.Filter) (response.AllSecIpLists, error)
	// CreateSecIpList creates the sec IP list under the oracle cloud endpoint
	CreateSecIpList(string, string, []string) (response.SecIpList, error)
	// AllDefaultSecIpLists retrieves all default sec IP lists from the
	// oracle cloud account. Default lists are defined by the cloud and cannot
	// be changed in any way.
	AllDefaultSecIpLists([]api.Filter) (response.AllSecIpLists, error)
}

type SecListAPI interface {
	// SecListDetails retrieves sec list details for the given list
	SecListDetails(string) (response.SecList, error)
	// DeleteSecList deletes one sec list
	DeleteSecList(string) error
	// CreateSecList creates a sec list
	CreateSecList(string, string,
		common.SecRuleAction, common.SecRuleAction) (response.SecList, error)
}

type SecRulesAPI interface {
	// AllSecurityRules returns all security rules matching a filter. A nil valued
	// filter will return all entries in the API.
	AllSecurityRules([]api.Filter) (response.AllSecurityRules, error)
	// DeleteSecurityRule deletes the security rule with the given name
	DeleteSecurityRule(string) error
	// CreateSecurityRule creates a security rule based on the security rule
	// parameters under the oracle cloud endpoint
	CreateSecurityRule(api.SecurityRuleParams) (response.SecurityRule, error)
}

type Shaper interface {
	AllShapes([]api.Filter) (response.AllShapes, error)
}

type StorageAttachmentAPI interface {
	// CreateStorageAttachment creates a storage attachment
	CreateStorageAttachment(p api.StorageAttachmentParams) (response.StorageAttachment, error)
	// DeleteStorageAttachment deletes the storage attachment
	DeleteStorageAttachment(name string) error
	// StorageAttachmentDetails retrieves details of the storage attachment
	StorageAttachmentDetails(name string) (response.StorageAttachment, error)
	// AllStorageAttachments retrieves all storage attachments matching a filter. A nil valued
	// filter will return all entries in the API.
	AllStorageAttachments(filter []api.Filter) (response.AllStorageAttachments, error)
}

type StorageVolumeAPI interface {
	// CreateStorageVolume creates a storage volume
	CreateStorageVolume(p api.StorageVolumeParams) (resp response.StorageVolume, err error)
	// DeleteStorageVolume deletes the storage volume
	DeleteStorageVolume(name string) (err error)
	// StorageVolumeDetails retrieves storage volume details
	StorageVolumeDetails(name string) (resp response.StorageVolume, err error)
	// AllStoragevolumes retrieves all storage volumes matching a filter. A nil valued
	// filter will return all entries in the API.
	AllStorageVolumes(filter []api.Filter) (resp response.AllStorageVolumes, err error)
	// UpdateStorageVolume updates the state of the storage volume
	UpdateStorageVolume(p api.StorageVolumeParams, currentName string) (resp response.StorageVolume, err error)
}

type VnicSetAPI interface {
	DeleteVnicSet(string) error
	VnicSetDetails(string) (response.VnicSet, error)
	CreateVnicSet(api.VnicSetParams) (response.VnicSet, error)
}