operation

package

v0.1.1 Latest Latest Go to latest Published: Jan 31, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/trustbloc/edv

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type DataVaultConfiguration
type Handler
type IDTypePair
type Operation
- func New(provider storage.Provider) *Operation
- func (c *Operation) GetRESTHandlers() []Handler
type StructuredDocument
type VaultCollection

Constants ¶

View Source

const (

	// VaultNotFoundErrMsg is the message returned by the EDV server when a vault can't be found.
	VaultNotFoundErrMsg = "specified vault does not exist"
	// DocumentNotFoundErrMsg is the message returned by the EDV server when a document can't be found
	// within the given vault.
	DocumentNotFoundErrMsg = "specified document does not exist"
	// DuplicateVaultErrMsg is the message returned by the EDV server when an attempt is made to create a vault with
	// the same ID as an already existing vault.
	DuplicateVaultErrMsg = "vault already exists"
	// DuplicateDocumentErrMsg is the message returned by the EDV server when an attempt is made to create a document with
	// the same ID as an already existing document inside the vault.
	DuplicateDocumentErrMsg = "a document with the given id already exists"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DataVaultConfiguration ¶ added in v0.1.1

type DataVaultConfiguration struct {
	Sequence    int        `json:"sequence"`
	Controller  string     `json:"controller"`
	Invoker     string     `json:"invoker"`
	Delegator   string     `json:"delegator"`
	ReferenceID string     `json:"referenceId"`
	KEK         IDTypePair `json:"kek"`
	HMAC        IDTypePair `json:"hmac"`
}

DataVaultConfiguration represents a Data Vault Configuration. For use with an EDV.

type Handler ¶

type Handler interface {
	Path() string
	Method() string
	Handle() http.HandlerFunc
}

Handler http handler for each controller API endpoint

type IDTypePair ¶ added in v0.1.1

type IDTypePair struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

IDTypePair represents an ID+type pair. Used in the DataVaultConfiguration struct.

type Operation ¶

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

Operation defines handlers for EDV service

func New ¶

func New(provider storage.Provider) *Operation

New returns EDV instance

func (*Operation) GetRESTHandlers ¶

func (c *Operation) GetRESTHandlers() []Handler

GetRESTHandlers get all controller API handler available for this service

type StructuredDocument ¶ added in v0.1.1

type StructuredDocument struct {
	ID      string                 `json:"id"`
	Meta    map[string]interface{} `json:"meta"`
	Content map[string]interface{} `json:"content"`
}

StructuredDocument represents a Structured Document. For use with an EDV.

type VaultCollection ¶

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

VaultCollection represents EDV storage.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL