common

Documentation

Index

• Constants
• type CreatePublicDIDParams
• type CreatePublicDIDRequest
• type CreatePublicDIDResponse
• type Operation
  • func New(ctx provider, registrar operation.MessageHandler, notifier webhook.Notifier) (*Operation, error)
  • func (o *Operation) CreatePublicDID(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) GetRESTHandlers() []operation.Handler
  • func (o *Operation) RegisterHTTPMessageService(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) RegisterMessageService(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) RegisteredServices(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) SendNewMessage(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) SendReplyMessage(rw http.ResponseWriter, req *http.Request)
  • func (o *Operation) UnregisterMessageService(rw http.ResponseWriter, req *http.Request)
• type RegisterHTTPMessageServiceRequest
• type RegisterHTTPMsgSvcParams
• type RegisterMessageServiceRequest
• type RegisterMsgSvcParams
• type RegisteredServicesResponse
• type SendNewMessageParams
• type SendNewMessageRequest
• type SendReplyMessageParams
• type SendReplyMessageRequest
• type ServiceEndpointDestinationParams
• type UnregisterMessageServiceRequest
• type UnregisterMsgSvcParams

Constants

const (
	// InvalidRequestErrorCode is typically a code for invalid requests
	InvalidRequestErrorCode = resterrors.Code(iota + resterrors.Common)

	// CreatePublicDIDError is for failures while creating public DIDs
	CreatePublicDIDError

	// RegisterMsgSvcError is for failures while registering new message service
	RegisterMsgSvcError

	// UnregisterMsgSvcError is for failures while unregistering a message service
	UnregisterMsgSvcError

	// SendMsgError is for failures while sending messages
	SendMsgError

	// SendMsgReplyError is for failures while sending message replies
	SendMsgReplyError
)

Error codes

Types

type CreatePublicDIDParams

type CreatePublicDIDParams struct {
	// Params for creating public DID
	Method string `json:"method"`

	// RequestHeader to be included while submitting request to http binding URL
	RequestHeader string `json:"header"`
}

CreatePublicDIDParams contains parameters for creating new public DID

type CreatePublicDIDRequest

type CreatePublicDIDRequest struct {
	// Params for creating public DID
	//
	// in: path
	*CreatePublicDIDParams
}

CreatePublicDIDRequest model

This is used for operation to create public DID

swagger:parameters createPublicDID

type CreatePublicDIDResponse

type CreatePublicDIDResponse struct {

	// in: body
	// TODO return base64-encoded raw bytes of the DID doc [Issue: #855]
	DID *did.Doc `json:"did"`
}

CreatePublicDIDResponse model

This is used for returning public DID created

swagger:response createPublicDIDResponse

type Operation

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

Operation contains basic common operations provided by controller REST API

func New

func New(ctx provider, registrar operation.MessageHandler, notifier webhook.Notifier) (*Operation, error)

New returns new common operations rest client instance

func (*Operation) CreatePublicDID

func (o *Operation) CreatePublicDID(rw http.ResponseWriter, req *http.Request)

CreatePublicDID swagger:route POST /vdri/create-public-did vdri createPublicDID

Creates a new Public DID....

Responses:

default: genericError
    200: createPublicDIDResponse

func (*Operation) GetRESTHandlers

func (o *Operation) GetRESTHandlers() []operation.Handler

GetRESTHandlers get all controller API handler available for this service

func (*Operation) RegisterHTTPMessageService

func (o *Operation) RegisterHTTPMessageService(rw http.ResponseWriter, req *http.Request)

RegisterHTTPMessageService swagger:route POST /http-over-didcomm/register http-over-didcomm registerHttpMsgSvc

registers new http over didcomm service to message handler registrar

Responses:

default: genericError

func (*Operation) RegisterMessageService

func (o *Operation) RegisterMessageService(rw http.ResponseWriter, req *http.Request)

RegisterMessageService swagger:route POST /message/register-service message registerMsgSvc

registers new message service to message handler registrar

Responses:

default: genericError

func (*Operation) RegisteredServices

func (o *Operation) RegisteredServices(rw http.ResponseWriter, req *http.Request)

RegisteredServices swagger:route GET /message/services message http-over-didcomm services

returns list of registered service names

Responses:

default: genericError
200: registeredServicesResponse

func (*Operation) SendNewMessage

func (o *Operation) SendNewMessage(rw http.ResponseWriter, req *http.Request)

SendNewMessage swagger:route POST /message/send message sendNewMessage

sends new message to destination provided

Responses:

default: genericError

func (*Operation) SendReplyMessage

func (o *Operation) SendReplyMessage(rw http.ResponseWriter, req *http.Request)

SendReplyMessage swagger:route POST /message/reply message sendReplyMessage

sends reply to existing message

Responses:

default: genericError

func (*Operation) UnregisterMessageService

func (o *Operation) UnregisterMessageService(rw http.ResponseWriter, req *http.Request)

UnregisterMessageService swagger:route POST /message/unregister-service message http-over-didcomm unregisterMsgSvc

unregisters given message service handler registrar

Responses:

default: genericError

type RegisterHTTPMessageServiceRequest

type RegisterHTTPMessageServiceRequest struct {
	// Params for registering http over did comm message service.
	//
	// in: body
	Params *RegisterHTTPMsgSvcParams
}

RegisterHTTPMessageServiceRequest model

This is used for operation to register a HTTP over DIDComm message service to message handler

swagger:parameters registerHttpMsgSvc

type RegisterHTTPMsgSvcParams

type RegisterHTTPMsgSvcParams struct {
	// Name of the HTTP over DIDComm message service
	// required: true
	Name string `json:"name"`

	// Acceptance criteria for http over did comm message service based on message purpose.
	// In case of multiple purposes, operation will follow `A tagging system` purpose field validation from RFC-0351
	// If not provided then all incoming messages of HTTP over DIDComm type will be handled by operation.
	Purpose []string `json:"purpose"`
}

RegisterHTTPMsgSvcParams contains parameters for registering a HTTP over DIDComm message service to message handler.

type RegisterMessageServiceRequest

type RegisterMessageServiceRequest struct {
	// Params for registering message service
	//
	// in: body
	Params *RegisterMsgSvcParams
}

RegisterMessageServiceRequest model

This is used for operation to register a message service to message handler

swagger:parameters registerMsgSvc

type RegisterMsgSvcParams

type RegisterMsgSvcParams struct {
	// Name of the message service
	// required: true
	Name string `json:"name"`

	// Acceptance criteria for message service based on message purpose
	// in case of multiple purposes, message will be dispatched if any one of the purpose matches
	// with the purpose of incoming message.
	// Can be provided in conjunction with other acceptance criteria.
	Purpose []string `json:"purpose"`

	// Acceptance criteria for message service based on message type.
	// Can be provided in conjunction with other acceptance criteria.
	Type string `json:"type"`
}

RegisterMsgSvcParams contains parameters for registering a message service to message handler

type RegisteredServicesResponse

type RegisteredServicesResponse struct {
	// Registered service names
	//
	// in: body
	Names []string `json:"names"`
}

RegisteredServicesResponse model

This is used for returning list of registered service names

swagger:response registeredServicesResponse

type SendNewMessageParams

type SendNewMessageParams struct {

	// Connection ID of the message destination
	// This parameter takes precedence over all the other destination parameters.
	ConnectionID string `json:"connection_ID,omitempty"`

	// DID of the destination.
	// This parameter takes precedence over `ServiceEndpoint` destination parameter.
	TheirDID string `json:"their_did,omitempty"`

	// ServiceEndpointDestination service endpoint destination.
	// This param can be used to send messages outside connection.
	ServiceEndpointDestination *ServiceEndpointDestinationParams `json:"service_endpoint,omitempty"`

	// Message body of the message
	// required: true
	MessageBody json.RawMessage `json:"message_body"`
}

SendNewMessageParams contains parameters for sending new message with one of three destination options below,

1. ConnectionID - ID of the connection between sender and receiver of this message.
2. TheirDID - TheirDID of the DID exchange connection record between sender and receiver of this message.
3. ServiceEndpoint (With recipient Keys, endpoint and optional routing keys) - To Send message outside connection.

Note: Precedence logic when multiple destination options are provided are according to above order.

type SendNewMessageRequest

type SendNewMessageRequest struct {
	// Params for sending new message
	//
	// in: body
	Params *SendNewMessageParams
}

SendNewMessageRequest model

This is used for operation to send new message

swagger:parameters sendNewMessage

type SendReplyMessageParams

type SendReplyMessageParams struct {
	// ID of the message replying to
	// required: true
	MessageID string `json:"message_ID"`

	// Message body of the reply message
	// required: true
	MessageBody json.RawMessage `json:"message_body"`
}

SendReplyMessageParams contains parameters for sending message reply

type SendReplyMessageRequest

type SendReplyMessageRequest struct {
	// Params for sending message reply
	//
	// in: body
	Params *SendReplyMessageParams
}

SendReplyMessageRequest model

This is used for operation to send reply to message

swagger:parameters sendReplyMessage

type ServiceEndpointDestinationParams

type ServiceEndpointDestinationParams struct {
	// Recipient keys of service endpoint
	RecipientKeys []string `json:"recipientKeys,omitempty"`

	// Service endpoint
	ServiceEndpoint string `json:"serviceEndpoint,omitempty"`

	// Routing Keys of service endpoint
	RoutingKeys []string `json:"routingKeys,omitempty"`
}

ServiceEndpointDestinationParams contains service endpoint params

type UnregisterMessageServiceRequest

type UnregisterMessageServiceRequest struct {
	// Params for unregistering a message service
	//
	// in: body
	Params *UnregisterMsgSvcParams
}

UnregisterMessageServiceRequest model

This is used for operation to unregister a message service from message handler

swagger:parameters unregisterMsgSvc

type UnregisterMsgSvcParams

type UnregisterMsgSvcParams struct {
	// Name of the message service to be unregistered
	// required: true
	Name string `json:"name"`
}

UnregisterMsgSvcParams contains parameters for unregistering a message service from message handler