objectstorage

type Bucket interface {
	// ListObjects list object names in a GetBucket
	ListObjects(context.Context, string, string) ([]string, fail.Error)
	// Browse browses inside the GetBucket and execute a callback on each Object found
	Browse(context.Context, string, string, func(Object) fail.Error) fail.Error
	// Clear deletes all the objects in path inside a bucket
	Clear(ctx context.Context, path, prefix string) fail.Error
	// CreateObject creates a new object in the bucket
	CreateObject(context.Context, string) (Object, fail.Error)
	// InspectObject returns Object instance of an object in the GetBucket
	InspectObject(context.Context, string) (Object, fail.Error)
	// DeleteObject delete an object from a stowContainer
	DeleteObject(context.Context, string) fail.Error
	// ReadObject reads the content of an object
	ReadObject(context.Context, string, io.Writer, int64, int64) (Object, fail.Error)
	// WriteObject writes into an object
	WriteObject(context.Context, string, io.Reader, int64, abstract.ObjectStorageItemMetadata) (Object, fail.Error)

	// GetName returns the name of the bucket
	GetName() (string, fail.Error)
	// GetCount returns the number of objects in the GetBucket
	GetCount(context.Context, string, string) (int64, fail.Error)
	// GetSize returns the total size of all objects in the bucket
	GetSize(context.Context, string, string) (int64, string, fail.Error)
}

type Config struct {
	Type             string
	EnvAuth          bool
	AuthVersion      int
	AuthURL          string
	EndpointType     string
	Endpoint         string
	TenantDomain     string
	Tenant           string
	Domain           string
	User             string
	Key              string
	SecretKey        string
	Region           string
	AvailabilityZone string
	ProjectID        string
	Credentials      string
	BucketName       string
	DNS              string
	Direct           bool // if true, no stow cache is used
	Suffix           string
}

type Location interface {
	// Protocol returns the name of the Object Storage protocol corresponding used by the location
	Protocol() (string, fail.Error)
	Configuration() (Config, fail.Error) // returns the configuration used to create Location
	// ListBuckets returns all bucket prefixed by a string given as a parameter
	ListBuckets(context.Context, string) ([]string, fail.Error)
	// FindBucket returns true of bucket exists in stowLocation
	FindBucket(context.Context, string) (bool, fail.Error)
	// InspectBucket returns info of the GetBucket
	InspectBucket(context.Context, string) (abstract.ObjectStorageBucket, fail.Error)
	// CreateBucket creates a bucket
	CreateBucket(context.Context, string) (abstract.ObjectStorageBucket, fail.Error)
	// DeleteBucket removes a bucket (need to be cleared before)
	DeleteBucket(context.Context, string) fail.Error
	// DownloadBucket downloads a bucket
	DownloadBucket(ctx context.Context, bucketName, decryptionKey string) ([]byte, fail.Error)

	// UploadBucket uploads a bucket
	UploadBucket(ctx context.Context, bucketName, localDirectory string) (ferr fail.Error)

	// ClearBucket empties a Bucket
	ClearBucket(context.Context, string, string, string) fail.Error

	// ListObjects lists the objects in a Bucket
	ListObjects(context.Context, string, string, string) ([]string, fail.Error)

	// InvalidateObject ...
	InvalidateObject(context.Context, string, string) fail.Error

	// InspectObject ...
	InspectObject(context.Context, string, string) (abstract.ObjectStorageItem, fail.Error)
	// HasObject ...
	HasObject(context.Context, string, string) (bool, fail.Error)
	// ReadObject ...
	ReadObject(context.Context, string, string, io.Writer, int64, int64) (bytes.Buffer, fail.Error)
	// WriteObject ...
	WriteObject(
		context.Context, string, string, io.Reader, int64, abstract.ObjectStorageItemMetadata,
	) (abstract.ObjectStorageItem, fail.Error)
	// DeleteObject delete an object from a stowContainer
	DeleteObject(context.Context, string, string) fail.Error
	// ItemEtag returns the Etag of an item
	ItemEtag(context.Context, string, string) (string, fail.Error)
}

type Object interface {
	Read(context.Context, io.Writer, int64, int64) fail.Error
	Write(context.Context, io.Reader, int64) fail.Error
	Reload(context.Context) fail.Error
	Delete(context.Context) fail.Error
	AddMetadata(context.Context, abstract.ObjectStorageItemMetadata) fail.Error
	GetID(context.Context) (string, fail.Error)
	GetName(context.Context) (string, fail.Error)
	GetLastUpdate(context.Context) (time.Time, fail.Error)
	GetSize(context.Context) (int64, fail.Error)
	GetETag(context.Context) (string, fail.Error)
	GetMetadata(context.Context) (abstract.ObjectStorageItemMetadata, fail.Error)
}