ocmd

Documentation

Index

• func GetProtocolName(p Protocol) string
• func New(ctx context.Context, m map[string]interface{}) (global.Service, error)
• type Datatx
  • func (w *Datatx) ToOCMProtocol() *ocm.Protocol
• type Protocol
• type Protocols
  • func (p Protocols) MarshalJSON() ([]byte, error)
  • func (p *Protocols) UnmarshalJSON(data []byte) error
• type WebDAV
  • func (w *WebDAV) ToOCMProtocol() *ocm.Protocol
• type Webapp
  • func (w *Webapp) ToOCMProtocol() *ocm.Protocol

Functions

func GetProtocolName

func GetProtocolName(p Protocol) string

GetProtocolName returns the name of the protocol by reflection.

func New

func New(ctx context.Context, m map[string]interface{}) (global.Service, error)

New returns a new ocmd object, that implements the OCM APIs specified in https://cs3org.github.io/OCM-API/docs.html

Types

type Datatx

type Datatx struct {
	SharedSecret string `json:"sharedSecret" validate:"required"`
	SourceURI    string `json:"srcUri"       validate:"required"`
	Size         uint64 `json:"size"         validate:"required"`
}

Datatx contains the parameters for the Datatx protocol.

func (*Datatx) ToOCMProtocol

func (w *Datatx) ToOCMProtocol() *ocm.Protocol

ToOCMProtocol convert the protocol to a ocm Protocol struct.

type Protocol

type Protocol interface {
	// ToOCMProtocol convert the protocol to a ocm Protocol struct
	ToOCMProtocol() *ocm.Protocol
}

Protocol represents the way of access the resource in the OCM share.

type Protocols

type Protocols []Protocol

Protocols is the list of protocols.

func (Protocols) MarshalJSON

func (p Protocols) MarshalJSON() ([]byte, error)

MarshalJSON implements the Marshaler interface.

func (*Protocols) UnmarshalJSON

func (p *Protocols) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the Unmarshaler interface.

type WebDAV

type WebDAV struct {
	SharedSecret string   `json:"sharedSecret" validate:"required"`
	Permissions  []string `json:"permissions"  validate:"required,dive,required,oneof=read write share"`
	URL          string   `json:"url"          validate:"required"`
}

WebDAV contains the parameters for the WebDAV protocol.

func (*WebDAV) ToOCMProtocol

func (w *WebDAV) ToOCMProtocol() *ocm.Protocol

ToOCMProtocol convert the protocol to a ocm Protocol struct.

type Webapp

type Webapp struct {
	URITemplate string `json:"uriTemplate" validate:"required"`
	ViewMode    string `json:"viewMode"    validate:"required,dive,required,oneof=view read write"`
}

Webapp contains the parameters for the Webapp protocol.

func (*Webapp) ToOCMProtocol

func (w *Webapp) ToOCMProtocol() *ocm.Protocol

ToOCMProtocol convert the protocol to a ocm Protocol struct.