eosclient

Documentation

Index

• Constants
• func AttrTypeToString(at AttrType) string
• type AttrType
  • func AttrStringToType(t string) (AttrType, error)
• type Attribute
  • func (a *Attribute) GetKey() string
• type Authorization
• type Checksum
• type DeletedEntry
• type EOSClient
• type FileInfo
• type QuotaInfo
• type Role
• type SetQuotaInfo

Constants

const (
	EndPosition   uint = 0
	StartPosition uint = 1
)

Constants for ACL position.

const AttrAlreadyExistsError = errtypes.BadRequest("attr already exists")

AttrAlreadyExistsError is the error raised when setting an already existing attr on a resource.

const AttrNotExistsError = errtypes.BadRequest("attr not exists")

AttrNotExistsError is the error raised when removing an attribute that does not exist.

Functions

func AttrTypeToString

func AttrTypeToString(at AttrType) string

AttrTypeToString converts a type to a string representation.

Types

type AttrType

type AttrType uint32

AttrType is the type of extended attribute, either system (sys) or user (user).

const (
	// SystemAttr is the system extended attribute.
	SystemAttr AttrType = iota
	// UserAttr is the user extended attribute.
	UserAttr
)

func AttrStringToType

func AttrStringToType(t string) (AttrType, error)

AttrStringToType converts a string to an AttrType.

type Attribute

type Attribute struct {
	Type     AttrType
	Key, Val string
}

Attribute represents an EOS extended attribute.

func (*Attribute) GetKey

func (a *Attribute) GetKey() string

GetKey returns the key considering the type of attribute.

type Authorization

type Authorization struct {
	Role  Role
	Token string
}

Authorization specifies the mechanisms through which EOS can be accessed. One of the data members must be set.

type Checksum

type Checksum struct {
	XSSum  string
	XSType string
}

Checksum represents a cheksum entry for a file returned by EOS.

type DeletedEntry

type DeletedEntry struct {
	RestorePath   string
	RestoreKey    string
	Size          uint64
	DeletionMTime uint64
	IsDir         bool
}

DeletedEntry represents an entry from the trashbin.

type EOSClient

type EOSClient interface {
	AddACL(ctx context.Context, auth, rootAuth Authorization, path string, position uint, a *acl.Entry) error
	RemoveACL(ctx context.Context, auth, rootAuth Authorization, path string, a *acl.Entry) error
	UpdateACL(ctx context.Context, auth, rootAuth Authorization, path string, position uint, a *acl.Entry) error
	GetACL(ctx context.Context, auth Authorization, path, aclType, target string) (*acl.Entry, error)
	ListACLs(ctx context.Context, auth Authorization, path string) ([]*acl.Entry, error)
	GetFileInfoByInode(ctx context.Context, auth Authorization, inode uint64) (*FileInfo, error)
	GetFileInfoByFXID(ctx context.Context, auth Authorization, fxid string) (*FileInfo, error)
	GetFileInfoByPath(ctx context.Context, auth Authorization, path string) (*FileInfo, error)
	SetAttr(ctx context.Context, auth Authorization, attr *Attribute, errorIfExists, recursive bool, path string) error
	UnsetAttr(ctx context.Context, auth Authorization, attr *Attribute, recursive bool, path string) error
	GetAttr(ctx context.Context, auth Authorization, key, path string) (*Attribute, error)
	GetAttrs(ctx context.Context, auth Authorization, path string) ([]*Attribute, error)
	GetQuota(ctx context.Context, username string, rootAuth Authorization, path string) (*QuotaInfo, error)
	SetQuota(ctx context.Context, rooAuth Authorization, info *SetQuotaInfo) error
	Touch(ctx context.Context, auth Authorization, path string) error
	Chown(ctx context.Context, auth, chownauth Authorization, path string) error
	Chmod(ctx context.Context, auth Authorization, mode, path string) error
	CreateDir(ctx context.Context, auth Authorization, path string) error
	Remove(ctx context.Context, auth Authorization, path string, noRecycle bool) error
	Rename(ctx context.Context, auth Authorization, oldPath, newPath string) error
	List(ctx context.Context, auth Authorization, path string) ([]*FileInfo, error)
	Read(ctx context.Context, auth Authorization, path string) (io.ReadCloser, error)
	Write(ctx context.Context, auth Authorization, path string, stream io.ReadCloser) error
	WriteFile(ctx context.Context, auth Authorization, path, source string) error
	ListDeletedEntries(ctx context.Context, auth Authorization, maxentries int, from, to time.Time) ([]*DeletedEntry, error)
	RestoreDeletedEntry(ctx context.Context, auth Authorization, key string) error
	PurgeDeletedEntries(ctx context.Context, auth Authorization) error
	ListVersions(ctx context.Context, auth Authorization, p string) ([]*FileInfo, error)
	RollbackToVersion(ctx context.Context, auth Authorization, path, version string) error
	ReadVersion(ctx context.Context, auth Authorization, p, version string) (io.ReadCloser, error)
	GenerateToken(ctx context.Context, auth Authorization, path string, a *acl.Entry) (string, error)
}

EOSClient is the interface which enables access to EOS instances through various interfaces.

type FileInfo

type FileInfo struct {
	IsDir      bool
	Inode      uint64            `json:"inode"`
	FID        uint64            `json:"fid"`
	UID        uint64            `json:"uid"`
	GID        uint64            `json:"gid"`
	TreeSize   uint64            `json:"tree_size"`
	MTimeSec   uint64            `json:"mtime_sec"`
	MTimeNanos uint32            `json:"mtime_nanos"`
	ATimeSec   uint64            `json:"atime_sec"`
	ATimeNanos uint32            `json:"atime_nanos"`
	CTimeSec   uint64            `json:"ctime_sec"`
	CTimeNanos uint32            `json:"ctime_nanos"`
	Size       uint64            `json:"size"`
	TreeCount  uint64            `json:"tree_count"`
	File       string            `json:"eos_file"`
	ETag       string            `json:"etag"`
	Instance   string            `json:"instance"`
	XS         *Checksum         `json:"xs"`
	SysACL     *acl.ACLs         `json:"sys_acl"`
	Attrs      map[string]string `json:"attrs"`
}

FileInfo represents the metadata information returned by querying the EOS namespace.

type QuotaInfo

type QuotaInfo struct {
	AvailableBytes, UsedBytes   uint64
	AvailableInodes, UsedInodes uint64
}

QuotaInfo reports the available bytes and inodes for a particular user. eos reports all quota values are unsigned long, see https://github.com/cern-eos/eos/blob/93515df8c0d5a858982853d960bec98f983c1285/mgm/Quota.hh#L135

type Role

type Role struct {
	UID, GID string
}

Role holds the attributes required to authenticate to EOS via role-based access.

type SetQuotaInfo

type SetQuotaInfo struct {
	Username  string
	UID       string
	GID       string
	QuotaNode string
	MaxBytes  uint64
	MaxFiles  uint64
}

SetQuotaInfo encapsulates the information needed to create a quota space in EOS for a user.