object

Documentation

Index

• func AddressOf(obj *objectSDK.Object) oid.Address
• func IsECSupported(obj *objectSDK.Object) bool
• func LookupKeyInContainer(nm *netmap.NetMap, pkey, idCnr []byte, cnr container.Container) (bool, error)
• type ClassifyResult
• type ContentMeta
  • func (i ContentMeta) Objects() []oid.ID
  • func (i ContentMeta) Type() objectSDK.Type
• type DeleteHandler
• type ECInfo
• type FormatValidator
  • func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator
  • func (v *FormatValidator) Validate(ctx context.Context, obj *objectSDK.Object, unprepared bool) error
  • func (v *FormatValidator) ValidateContent(o *objectSDK.Object) (ContentMeta, error)
• type FormatValidatorOption
  • func WithContainersSource(cs container.Source) FormatValidatorOption
  • func WithInnerRing(ir InnerRing) FormatValidatorOption
  • func WithLockSource(e LockSource) FormatValidatorOption
  • func WithLogger(l *logger.Logger) FormatValidatorOption
  • func WithNetState(netState netmap.State) FormatValidatorOption
  • func WithNetmapSource(ns netmap.Source) FormatValidatorOption
  • func WithVerifySessionTokenIssuer(verifySessionTokenIssuer bool) FormatValidatorOption
• type Info
  • func (v Info) String() string
• type InnerRing
• type LockSource
• type Locker
• type SenderClassifier
  • func NewSenderClassifier(innerRing InnerRing, netmap core.Source, log *logger.Logger) SenderClassifier
  • func (c SenderClassifier) Classify(ownerID *user.ID, ownerKey *keys.PublicKey, idCnr cid.ID, ...) (res *ClassifyResult, err error)
  • func (c SenderClassifier) IsInnerRingOrContainerNode(ownerKeyInBytes []byte, idCnr cid.ID, cnr container.Container) (*ClassifyResult, error)

Functions

func AddressOf

func AddressOf(obj *objectSDK.Object) oid.Address

AddressOf returns the address of the object.

func IsECSupported

func IsECSupported(obj *objectSDK.Object) bool

IsECSupported returns True if EC supported for object.

EC supported only for regular, not linking objects.

func LookupKeyInContainer

func LookupKeyInContainer(
	nm *netmap.NetMap,
	pkey, idCnr []byte,
	cnr container.Container,
) (bool, error)

Types

type ClassifyResult

type ClassifyResult struct {
	Role acl.Role
	Key  []byte
}

type ContentMeta

type ContentMeta struct {
	// contains filtered or unexported fields
}

ContentMeta describes FrostFS meta information that brings object's payload if the object is one of:

• object.TypeTombstone;
• object.TypeLock.

func (ContentMeta) Objects

func (i ContentMeta) Objects() []oid.ID

Objects returns objects that the original object's payload affects:

• inhumed objects, if the original object is a Tombstone;
• locked objects, if the original object is a Lock;
• nil, if the original object is a Regular object.

func (ContentMeta) Type

func (i ContentMeta) Type() objectSDK.Type

Type returns object's type.

type DeleteHandler

type DeleteHandler interface {
	// DeleteObjects places objects to a removal queue.
	//
	// Returns apistatus.LockNonRegularObject if at least one object
	// is locked.
	DeleteObjects(oid.Address, ...oid.Address) error
}

DeleteHandler is an interface of delete queue processor.

type ECInfo

type ECInfo struct {
	ParentID oid.ID
	Index    uint32
	Total    uint32
}

type FormatValidator

type FormatValidator struct {
	// contains filtered or unexported fields
}

FormatValidator represents an object format validator.

func NewFormatValidator

func NewFormatValidator(opts ...FormatValidatorOption) *FormatValidator

NewFormatValidator creates, initializes and returns FormatValidator instance.

func (*FormatValidator) Validate

func (v *FormatValidator) Validate(ctx context.Context, obj *objectSDK.Object, unprepared bool) error

Validate validates object format.

Does not validate payload checksum and content. If unprepared is true, only fields set by user are validated.

Returns nil error if the object has valid structure.

func (*FormatValidator) ValidateContent

func (v *FormatValidator) ValidateContent(o *objectSDK.Object) (ContentMeta, error)

ValidateContent validates payload content according to the object type.

type FormatValidatorOption

type FormatValidatorOption func(*cfg)

FormatValidatorOption represents a FormatValidator constructor option.

func WithContainersSource

func WithContainersSource(cs container.Source) FormatValidatorOption

WithContainersSource return option to set Containers source.

func WithInnerRing

func WithInnerRing(ir InnerRing) FormatValidatorOption

WithInnerRing return option to set Inner Ring source.

func WithLockSource

func WithLockSource(e LockSource) FormatValidatorOption

WithLockSource return option to set the Storage Engine.

func WithLogger

func WithLogger(l *logger.Logger) FormatValidatorOption

WithLogger return option to set logger.

func WithNetState

func WithNetState(netState netmap.State) FormatValidatorOption

WithNetState returns options to set the network state interface.

func WithNetmapSource

func WithNetmapSource(ns netmap.Source) FormatValidatorOption

WithNetmapSource return option to set Netmap source.

func WithVerifySessionTokenIssuer

func WithVerifySessionTokenIssuer(verifySessionTokenIssuer bool) FormatValidatorOption

WithVerifySessionTokenIssuer return option to set verify session token issuer value.

type Info

type Info struct {
	Address         oid.Address
	Type            objectSDK.Type
	IsLinkingObject bool
	ECInfo          *ECInfo
}

Info groups object address with its FrostFS object info.

func (Info) String

func (v Info) String() string

type InnerRing

type InnerRing interface {
	InnerRingKeys() ([][]byte, error)
}

type LockSource

type LockSource interface {
	// IsLocked must clarify object's lock status.
	IsLocked(ctx context.Context, address oid.Address) (bool, error)
}

LockSource is a source of lock relations between the objects.

type Locker

type Locker interface {
	// Lock list of objects as locked by locker in the specified container.
	//
	// Returns apistatus.LockNonRegularObject if at least object in locked
	// list is irregular (not type of REGULAR).
	Lock(idCnr cid.ID, locker oid.ID, locked []oid.ID) error
}

Locker is an object lock storage interface.

type SenderClassifier

type SenderClassifier struct {
	// contains filtered or unexported fields
}

func NewSenderClassifier

func NewSenderClassifier(innerRing InnerRing, netmap core.Source, log *logger.Logger) SenderClassifier

func (SenderClassifier) Classify

func (c SenderClassifier) Classify(
	ownerID *user.ID,
	ownerKey *keys.PublicKey,
	idCnr cid.ID,
	cnr container.Container,
) (res *ClassifyResult, err error)

func (SenderClassifier) IsInnerRingOrContainerNode

func (c SenderClassifier) IsInnerRingOrContainerNode(ownerKeyInBytes []byte, idCnr cid.ID, cnr container.Container) (*ClassifyResult, error)