rpccontextdefinition

Documentation

Index

• type RPCContextDefinition
  • func ProvideRPCContextDefinitionFromHeaders(options RPCContextDefinitionOptions) (*RPCContextDefinition, error)
  • func (middleware *RPCContextDefinition) DefineAction(next http.Handler) http.Handler
  • func (middleware *RPCContextDefinition) DefineApplication(next http.Handler) http.Handler
  • func (middleware *RPCContextDefinition) DefineUser(next http.Handler) http.Handler
• type RPCContextDefinitionOptions
• type RPCRequest

Types

type RPCContextDefinition

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

RPCContextDefinition defines authorization configuration for an application and a user

func ProvideRPCContextDefinitionFromHeaders

func ProvideRPCContextDefinitionFromHeaders(options RPCContextDefinitionOptions) (*RPCContextDefinition, error)

ProvideRPCContextDefinitionFromHeaders returns RPCContextDefinition with the given options

func (*RPCContextDefinition) DefineAction

func (middleware *RPCContextDefinition) DefineAction(next http.Handler) http.Handler

DefineAction defines the action within the context of the request

func (*RPCContextDefinition) DefineApplication

func (middleware *RPCContextDefinition) DefineApplication(next http.Handler) http.Handler

DefineApplication defines the application within the context of the request

func (*RPCContextDefinition) DefineUser

func (middleware *RPCContextDefinition) DefineUser(next http.Handler) http.Handler

DefineUser defines the user within the context of the request

type RPCContextDefinitionOptions

type RPCContextDefinitionOptions struct {
	// AuthHeadersConfiguration configure the auth headers of the requests
	AuthHeadersConfiguration contextdefinition.AuthHeadersConfiguration
	// ResponseHandler exposes functionality to handle HTTP responses
	ResponseHandler httpinfra.HTTPResponseHandler
	// RPCRouter are a set of methods to set up an RPC Router
	RPCRouter rpcinfra.RPCRouter
}

RPCContextDefinitionOptions configures RPCContextDefinition

type RPCRequest

type RPCRequest struct {
	// RPCVersion specifies the version of the JSON-RPC protocol. Must be exactly "2.0".
	RPCVersion string `json:"jsonrpc"`
	// ID defines a unique identifier established by the client.
	ID any `json:"id"`
	// Method defines the name of the method to be invoked.
	Method string `json:"method"`
	// Params defines a structured value that holds the parameter values to be used during the invocation of the method.
	Params json.RawMessage `json:"params"`
}

RPCRequest represents a JSON-RPC request object as defined in: https://www.jsonrpc.org/specification