didexchange

Documentation

Index

• Constants
• type ConnectionMsg
• type Operation
  • func New(ctx provider, notifier webhook.Notifier, defaultLabel string, autoAccept bool) (*Operation, error)
  • func (c *Operation) AcceptExchangeRequest(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) AcceptInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) CreateImplicitInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) CreateInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) GetRESTHandlers() []operation.Handler
  • func (c *Operation) QueryConnectionByID(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) QueryConnections(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) ReceiveInvitation(rw http.ResponseWriter, req *http.Request)
  • func (c *Operation) RemoveConnection(rw http.ResponseWriter, req *http.Request)

Constants

const (
	// InvalidRequestErrorCode is typically a code for validation errors
	// for invalid didexchange controller requests
	InvalidRequestErrorCode = resterrors.Code(iota + resterrors.DIDExchange)

	// CreateInvitationErrorCode is for failures in create invitation endpoint
	CreateInvitationErrorCode

	// CreateImplicitInvitationErrorCode is for failures in create implicit invitation endpoint
	CreateImplicitInvitationErrorCode

	// ReceiveInvitationErrorCode is for failures in receive invitation endpoint
	ReceiveInvitationErrorCode

	// AcceptInvitationErrorCode is for failures in accept invitation endpoint
	AcceptInvitationErrorCode

	// AcceptExchangeRequestErrorCode is for failures in accept exchange request endpoint
	AcceptExchangeRequestErrorCode

	// QueryConnectionsErrorCode is for failures in query connection endpoints
	QueryConnectionsErrorCode

	// RemoveConnectionErrorCode is for failures in remove connection endpoint
	RemoveConnectionErrorCode
)

Types

type ConnectionMsg

type ConnectionMsg struct {
	ConnectionID        string `json:"connection_id"`
	State               string `json:"state"`
	MyDid               string `json:"myDid"`
	TheirDid            string `json:"theirDid"`
	TheirLabel          string `json:"theirLabel"`
	TheirRole           string `json:"theirRole"`
	InboundConnectionID string `json:"inbound_connection_id"`
	Initiator           string `json:"initiator"`
	InvitationKey       string `json:"invitation_key"`
	RequestID           string `json:"request_id"`
	RoutingState        string `json:"routing_state"`
	Accept              string `json:"accept"`
	ErrorMsg            string `json:"error_msg"`
	InvitationMode      string `json:"invitation_mode"`
	Alias               string `json:"alias"`
}

ConnectionMsg is sent when a pairwise connection record is updated.

type Operation

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

Operation is controller REST service controller for DID Exchange

func New

func New(ctx provider, notifier webhook.Notifier, defaultLabel string, autoAccept bool) (*Operation, error)

New returns new DID Exchange rest client protocol instance

func (*Operation) AcceptExchangeRequest

func (c *Operation) AcceptExchangeRequest(rw http.ResponseWriter, req *http.Request)

AcceptExchangeRequest swagger:route POST /connections/{id}/accept-request did-exchange acceptRequest

Accepts a stored connection request.

Responses:

default: genericError
    200: acceptExchangeResponse

func (*Operation) AcceptInvitation

func (c *Operation) AcceptInvitation(rw http.ResponseWriter, req *http.Request)

AcceptInvitation swagger:route POST /connections/{id}/accept-invitation did-exchange acceptInvitation

Accept a stored connection invitation....

Responses:

default: genericError
    200: acceptInvitationResponse

func (*Operation) CreateImplicitInvitation

func (c *Operation) CreateImplicitInvitation(rw http.ResponseWriter, req *http.Request)

CreateImplicitInvitation swagger:route POST /connections/create-implicit-invitation did-exchange implicitInvitation

Create implicit invitation using inviter DID.

Responses:

default: genericError
    200: implicitInvitationResponse

func (*Operation) CreateInvitation

func (c *Operation) CreateInvitation(rw http.ResponseWriter, req *http.Request)

CreateInvitation swagger:route POST /connections/create-invitation did-exchange createInvitation

Creates a new connection invitation....

Responses:

default: genericError
    200: createInvitationResponse

func (*Operation) GetRESTHandlers

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

GetRESTHandlers get all controller API handler available for this protocol service

func (*Operation) QueryConnectionByID

func (c *Operation) QueryConnectionByID(rw http.ResponseWriter, req *http.Request)

QueryConnectionByID swagger:route GET /connections/{id} did-exchange getConnection

Fetch a single connection record.

Responses:

default: genericError
    200: queryConnectionResponse

func (*Operation) QueryConnections

func (c *Operation) QueryConnections(rw http.ResponseWriter, req *http.Request)

QueryConnections swagger:route GET /connections did-exchange queryConnections

query agent to agent connections.

Responses:

default: genericError
    200: queryConnectionsResponse

func (*Operation) ReceiveInvitation

func (c *Operation) ReceiveInvitation(rw http.ResponseWriter, req *http.Request)

ReceiveInvitation swagger:route POST /connections/receive-invitation did-exchange receiveInvitation

Receive a new connection invitation....

Responses:

default: genericError
    200: receiveInvitationResponse

func (*Operation) RemoveConnection

func (c *Operation) RemoveConnection(rw http.ResponseWriter, req *http.Request)

RemoveConnection swagger:route POST /connections/{id}/remove did-exchange removeConnection

Removes given connection record.

Responses:

default: genericError
200: removeConnectionResponse