251 lines
8.3 KiB
Go
251 lines
8.3 KiB
Go
package layer
|
|
|
|
import (
|
|
"context"
|
|
"crypto/ecdsa"
|
|
"errors"
|
|
"io"
|
|
"time"
|
|
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/bearer"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/acl"
|
|
cid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/eacl"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/netmap"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object"
|
|
oid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/object/id"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/session"
|
|
"git.frostfs.info/TrueCloudLab/frostfs-sdk-go/user"
|
|
)
|
|
|
|
// PrmContainerCreate groups parameters of FrostFS.CreateContainer operation.
|
|
type PrmContainerCreate struct {
|
|
// FrostFS identifier of the container creator.
|
|
Creator user.ID
|
|
|
|
// Container placement policy.
|
|
Policy netmap.PlacementPolicy
|
|
|
|
// Name for the container.
|
|
Name string
|
|
|
|
// CreationTime value for Timestamp attribute
|
|
CreationTime time.Time
|
|
|
|
// Token of the container's creation session. Nil means session absence.
|
|
SessionToken *session.Container
|
|
|
|
// Basic ACL of the container.
|
|
BasicACL acl.Basic
|
|
|
|
// Attributes for optional parameters.
|
|
AdditionalAttributes [][2]string
|
|
}
|
|
|
|
// PrmAuth groups authentication parameters for the FrostFS operation.
|
|
type PrmAuth struct {
|
|
// Bearer token to be used for the operation. Overlaps PrivateKey. Optional.
|
|
BearerToken *bearer.Token
|
|
|
|
// Private key used for the operation if BearerToken is missing (in this case non-nil).
|
|
PrivateKey *ecdsa.PrivateKey
|
|
}
|
|
|
|
// PrmObjectRead groups parameters of FrostFS.ReadObject operation.
|
|
type PrmObjectRead struct {
|
|
// Authentication parameters.
|
|
PrmAuth
|
|
|
|
// Container to read the object header from.
|
|
Container cid.ID
|
|
|
|
// ID of the object for which to read the header.
|
|
Object oid.ID
|
|
|
|
// Flag to read object header.
|
|
WithHeader bool
|
|
|
|
// Flag to read object payload. False overlaps payload range.
|
|
WithPayload bool
|
|
|
|
// Offset-length range of the object payload to be read.
|
|
PayloadRange [2]uint64
|
|
}
|
|
|
|
// ObjectPart represents partially read FrostFS object.
|
|
type ObjectPart struct {
|
|
// Object header with optional in-memory payload part.
|
|
Head *object.Object
|
|
|
|
// Object payload part encapsulated in io.Reader primitive.
|
|
// Returns ErrAccessDenied on read access violation.
|
|
Payload io.ReadCloser
|
|
}
|
|
|
|
// PrmObjectCreate groups parameters of FrostFS.CreateObject operation.
|
|
type PrmObjectCreate struct {
|
|
// Authentication parameters.
|
|
PrmAuth
|
|
|
|
// Container to store the object.
|
|
Container cid.ID
|
|
|
|
// Key-value object attributes.
|
|
Attributes [][2]string
|
|
|
|
// Value for Timestamp attribute (optional).
|
|
CreationTime time.Time
|
|
|
|
// List of ids to lock (optional).
|
|
Locks []oid.ID
|
|
|
|
// Full payload size (optional).
|
|
PayloadSize uint64
|
|
|
|
// Associated filepath (optional).
|
|
Filepath string
|
|
|
|
// Object payload encapsulated in io.Reader primitive.
|
|
Payload io.Reader
|
|
|
|
// Number of object copies that is enough to consider put successful.
|
|
CopiesNumber []uint32
|
|
|
|
// Enables client side object preparing.
|
|
ClientCut bool
|
|
}
|
|
|
|
// PrmObjectDelete groups parameters of FrostFS.DeleteObject operation.
|
|
type PrmObjectDelete struct {
|
|
// Authentication parameters.
|
|
PrmAuth
|
|
|
|
// Container to delete the object from.
|
|
Container cid.ID
|
|
|
|
// Identifier of the removed object.
|
|
Object oid.ID
|
|
}
|
|
|
|
// PrmObjectSearch groups parameters of FrostFS.sear SearchObjects operation.
|
|
type PrmObjectSearch struct {
|
|
// Authentication parameters.
|
|
PrmAuth
|
|
|
|
// Container to select the objects from.
|
|
Container cid.ID
|
|
|
|
// Key-value object attribute which should be
|
|
// presented in selected objects. Optional, empty key means any.
|
|
ExactAttribute [2]string
|
|
|
|
// File prefix of the selected objects. Optional, empty value means any.
|
|
FilePrefix string
|
|
}
|
|
|
|
var (
|
|
// ErrAccessDenied is returned from FrostFS in case of access violation.
|
|
ErrAccessDenied = errors.New("access denied")
|
|
|
|
// ErrGatewayTimeout is returned from FrostFS in case of timeout, deadline exceeded etc.
|
|
ErrGatewayTimeout = errors.New("gateway timeout")
|
|
)
|
|
|
|
// FrostFS represents virtual connection to FrostFS network.
|
|
type FrostFS interface {
|
|
// CreateContainer creates and saves parameterized container in FrostFS.
|
|
// It sets 'Timestamp' attribute to the current time.
|
|
// It returns the ID of the saved container.
|
|
//
|
|
// Created container is public with enabled ACL extension.
|
|
//
|
|
// It returns exactly one non-zero value. It returns any error encountered which
|
|
// prevented the container from being created.
|
|
CreateContainer(context.Context, PrmContainerCreate) (cid.ID, error)
|
|
|
|
// Container reads a container from FrostFS by ID.
|
|
//
|
|
// It returns exactly one non-nil value. It returns any error encountered which
|
|
// prevented the container from being read.
|
|
Container(context.Context, cid.ID) (*container.Container, error)
|
|
|
|
// UserContainers reads a list of the containers owned by the specified user.
|
|
//
|
|
// It returns exactly one non-nil value. It returns any error encountered which
|
|
// prevented the containers from being listed.
|
|
UserContainers(context.Context, user.ID) ([]cid.ID, error)
|
|
|
|
// SetContainerEACL saves the eACL table of the container in FrostFS. The
|
|
// extended ACL is modified within session if session token is not nil.
|
|
//
|
|
// It returns any error encountered which prevented the eACL from being saved.
|
|
SetContainerEACL(context.Context, eacl.Table, *session.Container) error
|
|
|
|
// ContainerEACL reads the container eACL from FrostFS by the container ID.
|
|
//
|
|
// It returns exactly one non-nil value. It returns any error encountered which
|
|
// prevented the eACL from being read.
|
|
ContainerEACL(context.Context, cid.ID) (*eacl.Table, error)
|
|
|
|
// DeleteContainer marks the container to be removed from FrostFS by ID.
|
|
// Request is sent within session if the session token is specified.
|
|
// Successful return does not guarantee actual removal.
|
|
//
|
|
// It returns any error encountered which prevented the removal request from being sent.
|
|
DeleteContainer(context.Context, cid.ID, *session.Container) error
|
|
|
|
// ReadObject reads a part of the object from the FrostFS container by identifier.
|
|
// Exact part is returned according to the parameters:
|
|
// * with header only: empty payload (both in-mem and reader parts are nil);
|
|
// * with payload only: header is nil (zero range means full payload);
|
|
// * with header and payload: full in-mem object, payload reader is nil.
|
|
//
|
|
// WithHeader or WithPayload is true. Range length is positive if offset is positive.
|
|
//
|
|
// Payload reader should be closed if it is no longer needed.
|
|
//
|
|
// It returns ErrAccessDenied on read access violation.
|
|
//
|
|
// It returns exactly one non-nil value. It returns any error encountered which
|
|
// prevented the object header from being read.
|
|
ReadObject(context.Context, PrmObjectRead) (*ObjectPart, error)
|
|
|
|
// CreateObject creates and saves a parameterized object in the FrostFS container.
|
|
// It sets 'Timestamp' attribute to the current time.
|
|
// It returns the ID of the saved object.
|
|
//
|
|
// Creation time should be written into the object (UTC).
|
|
//
|
|
// It returns ErrAccessDenied on write access violation.
|
|
//
|
|
// It returns exactly one non-zero value. It returns any error encountered which
|
|
// prevented the container from being created.
|
|
CreateObject(context.Context, PrmObjectCreate) (oid.ID, error)
|
|
|
|
// DeleteObject marks the object to be removed from the FrostFS container by identifier.
|
|
// Successful return does not guarantee actual removal.
|
|
//
|
|
// It returns ErrAccessDenied on remove access violation.
|
|
//
|
|
// It returns any error encountered which prevented the removal request from being sent.
|
|
DeleteObject(context.Context, PrmObjectDelete) error
|
|
|
|
// SearchObjects performs object search from the NeoFS container according
|
|
// to the specified parameters. It searches user's objects only.
|
|
//
|
|
// It returns ErrAccessDenied on selection access violation.
|
|
//
|
|
// It returns exactly one non-nil value. It returns any error encountered which
|
|
// prevented the objects from being selected.
|
|
SearchObjects(context.Context, PrmObjectSearch) ([]oid.ID, error)
|
|
|
|
// TimeToEpoch computes current epoch and the epoch that corresponds to the provided now and future time.
|
|
// Note:
|
|
// * future time must be after the now
|
|
// * future time will be ceil rounded to match epoch
|
|
//
|
|
// It returns any error encountered which prevented computing epochs.
|
|
TimeToEpoch(ctx context.Context, now time.Time, future time.Time) (uint64, uint64, error)
|
|
}
|