cs3

Documentation

Index

• func NewDefault(m map[string]interface{}) (share.Manager, error)
• type Manager
  • func New(gatewayClient gatewayv1beta1.GatewayAPIClient, s metadata.Storage, ...) (*Manager, error)
  • func (m *Manager) Dump(ctx context.Context, shareChan chan<- *collaboration.Share, ...) error
  • func (m *Manager) GetReceivedShare(ctx context.Context, ref *collaboration.ShareReference) (*collaboration.ReceivedShare, error)
  • func (m *Manager) GetShare(ctx context.Context, ref *collaboration.ShareReference) (*collaboration.Share, error)
  • func (m *Manager) ListReceivedShares(ctx context.Context, filters []*collaboration.Filter, forUser *userpb.UserId) ([]*collaboration.ReceivedShare, error)
  • func (m *Manager) ListShares(ctx context.Context, filters []*collaboration.Filter) ([]*collaboration.Share, error)
  • func (m *Manager) Load(ctx context.Context, shareChan <-chan *collaboration.Share, ...) error
  • func (m *Manager) Share(ctx context.Context, md *provider.ResourceInfo, g *collaboration.ShareGrant) (*collaboration.Share, error)
  • func (m *Manager) Unshare(ctx context.Context, ref *collaboration.ShareReference) error
  • func (m *Manager) UpdateReceivedShare(ctx context.Context, rshare *collaboration.ReceivedShare, ...) (*collaboration.ReceivedShare, error)
  • func (m *Manager) UpdateShare(ctx context.Context, ref *collaboration.ShareReference, ...) (*collaboration.Share, error)
• type ReceivedShareMetadata

Functions

func NewDefault

func NewDefault(m map[string]interface{}) (share.Manager, error)

NewDefault returns a new manager instance with default dependencies

Types

type Manager

type Manager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Manager implements a share manager using a cs3 storage backend

func New

func New(gatewayClient gatewayv1beta1.GatewayAPIClient, s metadata.Storage, indexer indexer.Indexer) (*Manager, error)

New returns a new manager instance

func (*Manager) Dump

func (m *Manager) Dump(ctx context.Context, shareChan chan<- *collaboration.Share, receivedShareChan chan<- share.ReceivedShareWithUser) error

Dump exports shares and received shares to channels (e.g. during migration)

func (*Manager) GetReceivedShare

func (m *Manager) GetReceivedShare(ctx context.Context, ref *collaboration.ShareReference) (*collaboration.ReceivedShare, error)

GetReceivedShare returns the information for a received share.

func (*Manager) GetShare

func (m *Manager) GetShare(ctx context.Context, ref *collaboration.ShareReference) (*collaboration.Share, error)

GetShare gets the information for a share by the given ref.

func (*Manager) ListReceivedShares

func (m *Manager) ListReceivedShares(ctx context.Context, filters []*collaboration.Filter, forUser *userpb.UserId) ([]*collaboration.ReceivedShare, error)

ListReceivedShares returns the list of shares the user has access to.

func (*Manager) ListShares

func (m *Manager) ListShares(ctx context.Context, filters []*collaboration.Filter) ([]*collaboration.Share, error)

ListShares returns the shares created by the user

func (*Manager) Load

func (m *Manager) Load(ctx context.Context, shareChan <-chan *collaboration.Share, receivedShareChan <-chan share.ReceivedShareWithUser) error

Load imports shares and received shares from channels (e.g. during migration)

func (*Manager) Share

func (m *Manager) Share(ctx context.Context, md *provider.ResourceInfo, g *collaboration.ShareGrant) (*collaboration.Share, error)

Share creates a new share

func (*Manager) Unshare

func (m *Manager) Unshare(ctx context.Context, ref *collaboration.ShareReference) error

Unshare deletes the share pointed by ref.

func (*Manager) UpdateReceivedShare

func (m *Manager) UpdateReceivedShare(ctx context.Context, rshare *collaboration.ReceivedShare, fieldMask *field_mask.FieldMask, forUser *userpb.UserId) (*collaboration.ReceivedShare, error)

UpdateReceivedShare updates the received share with share state.

func (*Manager) UpdateShare

func (m *Manager) UpdateShare(ctx context.Context, ref *collaboration.ShareReference, p *collaboration.SharePermissions, updated *collaboration.Share, fieldMask *field_mask.FieldMask) (*collaboration.Share, error)

UpdateShare updates the mode of the given share.

type ReceivedShareMetadata

type ReceivedShareMetadata struct {
	State      collaboration.ShareState `json:"state"`
	MountPoint *provider.Reference      `json:"mountpoint"`
}

ReceivedShareMetadata hold the state information or a received share