connector

package module

Go to main page

Versions in this module

v0

v0.4.5

Dec 1, 2022

Changes in this version

+ var ErrorMappingNotFound = NewError("MAPPING_NOT_FOUND", "Mapping not found", http.StatusNotFound)

type Database

+ GetInstancesInstallationConfiguration func(ctx context.Context, instanceID string) ([]*Configuration, error)

+ GetMappingByExternalId func(ctx context.Context, instanceId string, externalID string) (*ThingMapping, error)

+ RemoveThingMapping func(ctx context.Context, instanceID string, thingID string) error

v0.4.4

Nov 8, 2022

v0.4.3

Nov 8, 2022

v0.4.2

Aug 31, 2022

v0.4.1

Aug 30, 2022

v0.4.0

Aug 29, 2022

v0.3.0

Jan 20, 2022

Changes in this version

type Instance

+ func (i *Instance) ExternalIdByThingId(thingID string) (string, bool)

v0.2.2

Jan 19, 2022

Changes in this version

type Instance

+ func (i *Instance) ThingIdByExternalId(externalID string) (string, bool)

v0.2.1

Jan 19, 2022

Changes in this version

type InstallationRequest

+ func (i *InstallationRequest) GetConfig(id string) (*Configuration, bool)

type InstantiationRequest

+ func (i *InstantiationRequest) GetConfig(id string) (*Configuration, bool)

v0.2.0

Jan 18, 2022

Changes in this version

+ type ThingTemplate struct

+ ExternalID string

+ Thing connctd.Thing

v0.1.0

Jan 17, 2022

Changes in this version

+ const APIBaseURL

+ var DefaultLogger = stdr.New(stdlog.New(os.Stderr, "", stdlog.LstdFlags | stdlog.Lshortfile))

+ var ErrorBadContentType = NewError("BAD_CONTENT_TYPE", "Expected content type to be application/json", ...)

+ var ErrorBadRequestBody = NewError("BAD_REQUEST_BODY", "Empty or malformed request body", http.StatusBadRequest)

+ var ErrorBadSignature = NewError("BAD_SIGNATURE", "Signature seems to be invalid", http.StatusBadRequest)

+ var ErrorForbidden = NewError("FORBIDDEN", "Insufficient rights", http.StatusForbidden)

+ var ErrorInstallationNotFound = NewError("INSTALLATION_NOT_FOUND", "Installation not found", http.StatusNotFound)

+ var ErrorInstanceNotFound = NewError("INSTANCE_NOT_FOUND", "Instance not found", http.StatusNotFound)

+ var ErrorInternal = NewError("INTERNAL_SERVER_ERROR", "Internal server error", ...)

+ var ErrorInvalidBaseURL = errors.New("the base url needs to end with a slash")

+ var ErrorInvalidBody = NewError("INVALID_BODY", "Unable to read message body", http.StatusBadRequest)

+ var ErrorInvalidJsonBody = NewError("INVALID_JSON_BODY", "Request body does not contain valid json", ...)

+ var ErrorMissingHeader = NewError("MISSING_HEADER", ...)

+ var ErrorMissingInstallationID = NewError("MISSING_INSTALLATION_ID", "Installation ID is missing", http.StatusBadRequest)

+ var ErrorMissingInstanceID = NewError("MISSING_INSTANCE_ID", "Instance ID is missing", http.StatusBadRequest)

+ var ErrorMissingLogger = errors.New("a logger needs to be passed")

+ var ErrorSigningFailed = NewError("SIGNING_FAILED", "Failed to sign the request", http.StatusBadRequest)

+ var ErrorUnauthorized = NewError("NOT_AUTHORIZED", "Not authorized", http.StatusUnauthorized)

+ var ErrorUnexpectedResponse = errors.New("remote site replied with unexpected contents")

+ var ErrorUnexpectedStatusCode = errors.New("the resulting status code does not match with expectation")

+ func AddInstallation(service ConnectorService) http.HandlerFunc

+ func AddInstance(service ConnectorService) http.HandlerFunc

+ func NewSignatureValidationHandler(validationPreProcessor ValidationPreProcessor, publicKey ed25519.PublicKey, ...) http.Handler

+ func PerformAction(service ConnectorService) http.HandlerFunc

+ func RemoveInstallation(service ConnectorService) http.HandlerFunc

+ func RemoveInstance(service ConnectorService) http.HandlerFunc

+ type APIClient struct

+ func (a *APIClient) CreateThing(ctx context.Context, token InstantiationToken, thing connctd.Thing) (result connctd.Thing, err error)

+ func (a *APIClient) DeleteThing(ctx context.Context, token InstantiationToken, thingID string) error

+ func (a *APIClient) UpdateActionStatus(ctx context.Context, token InstantiationToken, actionRequestID string, ...) error

+ func (a *APIClient) UpdateInstallationState(ctx context.Context, token InstallationToken, state InstallationState, ...) error

+ func (a *APIClient) UpdateInstanceState(ctx context.Context, token InstantiationToken, state InstantiationState, ...) error

+ func (a *APIClient) UpdateThingPropertyValue(ctx context.Context, token InstantiationToken, thingID string, ...) error

+ func (a *APIClient) UpdateThingStatus(ctx context.Context, token InstantiationToken, thingID string, ...) error

+ type ActionEvent struct

+ InstanceId string

+ RequestId string

+ Response *ActionResponse

+ type ActionRequest struct

+ ActionID string

+ ComponentID string

+ ID string

+ Parameters map[string]string

+ Status ActionRequestStatus

+ ThingID string

+ type ActionRequestStatus string

+ const ActionRequestStatusCanceled

+ const ActionRequestStatusCompleted

+ const ActionRequestStatusFailed

+ const ActionRequestStatusPending

+ type ActionRequestStatusUpdate struct

+ Error string

+ Status ActionRequestStatus

+ type ActionResponse struct

+ Error string

+ Status ActionRequestStatus

+ type AddThingRequest struct

+ Thing connctd.Thing

+ type AddThingResponse struct

+ ID string

+ type Client interface

+ CreateThing func(ctx context.Context, token InstantiationToken, thing connctd.Thing) (result connctd.Thing, err error)

+ DeleteThing func(ctx context.Context, token InstantiationToken, thingID string) error

+ UpdateActionStatus func(ctx context.Context, token InstantiationToken, actionRequestID string, ...) error

+ UpdateInstallationState func(ctx context.Context, token InstallationToken, state InstallationState, ...) error

+ UpdateInstanceState func(ctx context.Context, token InstantiationToken, state InstantiationState, ...) error

+ UpdateThingPropertyValue func(ctx context.Context, token InstantiationToken, thingID string, ...) error

+ UpdateThingStatus func(ctx context.Context, token InstantiationToken, thingID string, ...) error

+ func NewClient(opts *ClientOptions, logger logr.Logger) (Client, error)

+ type ClientOptions struct

+ ConnctdBaseURL *url.URL

+ HTTPClient *http.Client

+ func DefaultOptions() *ClientOptions

+ type Configuration struct

+ ID string

+ Value string

+ type ConnectorHandler struct

+ func NewConnectorHandler(subrouter *mux.Router, service ConnectorService, publicKey ed25519.PublicKey) *ConnectorHandler

+ func NewProxiedConnectorHandler(subrouter *mux.Router, service ConnectorService, host string, ...) *ConnectorHandler

+ func (c *ConnectorHandler) ServeHTTP(w http.ResponseWriter, request *http.Request)

+ type ConnectorService interface

+ AddInstallation func(ctx context.Context, request InstallationRequest) (*InstallationResponse, error)

+ AddInstance func(ctx context.Context, request InstantiationRequest) (*InstantiationResponse, error)

+ PerformAction func(ctx context.Context, request ActionRequest) (*ActionResponse, error)

+ RemoveInstallation func(ctx context.Context, installationId string) error

+ RemoveInstance func(ctx context.Context, instanceId string) error

+ type Database interface

+ AddInstallation func(ctx context.Context, installationRequest InstallationRequest) error

+ AddInstallationConfiguration func(ctx context.Context, installationId string, config []Configuration) error

+ AddInstance func(ctx context.Context, instantiationRequest InstantiationRequest) error

+ AddInstanceConfiguration func(ctx context.Context, instanceId string, config []Configuration) error

+ AddThingMapping func(ctx context.Context, instanceID string, thingID string, externalId string) error

+ GetInstallations func(ctx context.Context) ([]*Installation, error)

+ GetInstance func(ctx context.Context, instanceId string) (*Instance, error)

+ GetInstanceByThingId func(ctx context.Context, thingId string) (*Instance, error)

+ GetInstanceConfiguration func(ctx context.Context, instanceId string) ([]Configuration, error)

+ GetInstances func(ctx context.Context) ([]*Instance, error)

+ GetMappingByInstanceId func(ctx context.Context, instanceId string) ([]ThingMapping, error)

+ RemoveInstallation func(ctx context.Context, installationId string) error

+ RemoveInstance func(ctx context.Context, instanceId string) error

+ type Error struct

+ APIError string

+ Description string

+ Status int

+ func NewError(err string, description string, status int) *Error

+ func (e *Error) Error() string

+ func (e *Error) Write(w http.ResponseWriter)

+ type Installation struct

+ Configuration []Configuration

+ ID string

+ Token InstallationToken

+ func (i *Installation) GetConfig(id string) (*Configuration, bool)

+ type InstallationRequest struct

+ Configuration []Configuration

+ ID string

+ State InstallationState

+ Token InstallationToken

+ type InstallationResponse struct

+ Details json.RawMessage

+ FurtherStep Step

+ type InstallationState int

+ const InstallationStateComplete

+ const InstallationStateFailed

+ const InstallationStateInitialized

+ const InstallationStateOngoing

+ type InstallationStateUpdateRequest struct

+ Details json.RawMessage

+ State InstallationState

+ type InstallationToken string

+ type Instance struct

+ Configuration []Configuration

+ ID string

+ InstallationID string

+ ThingMapping []ThingMapping

+ Token InstantiationToken

+ func (i *Instance) GetConfig(id string) (*Configuration, bool)

+ type InstanceStateUpdateRequest struct

+ Details json.RawMessage

+ State InstantiationState

+ type InstantiationRequest struct

+ Configuration []Configuration

+ ID string

+ InstallationID string

+ State InstantiationState

+ Token InstantiationToken

+ type InstantiationResponse struct

+ Details json.RawMessage

+ FurtherStep Step

+ type InstantiationState int

+ const InstantiationStateComplete

+ const InstantiationStateFailed

+ const InstantiationStateInitialized

+ const InstantiationStateOngoing

+ type InstantiationToken string

+ type PropertyUpdateEvent struct

+ ComponentId string

+ InstanceId string

+ PropertyId string

+ ThingId string

+ Value string

+ type Provider interface

+ RegisterInstallations func(installations ...*Installation) error

+ RegisterInstances func(instances ...*Instance) error

+ RemoveInstallation func(installationId string) error

+ RemoveInstance func(instanceId string) error

+ RequestAction func(ctx context.Context, instance *Instance, actionRequest ActionRequest) (ActionRequestStatus, error)

+ UpdateChannel func() <-chan UpdateEvent

+ type Step struct

+ Content string

+ Type StepType

+ type StepType int

+ const StepMarkdown

+ const StepRedirect

+ const StepText

+ type ThingMapping struct

+ ExternalID string

+ InstanceID string

+ ThingID string

+ type ThingTemplates func(request InstantiationRequest) []connctd.Thing

+ type UpdateEvent struct

+ ActionEvent *ActionEvent

+ PropertyUpdateEvent *PropertyUpdateEvent

+ type UpdateThingPropertyValueRequest struct

+ LastUpdate time.Time

+ Value string

+ type UpdateThingStatusRequest struct

+ Status connctd.StatusType

+ type ValidationParameters struct

+ Host string

+ RequestURI string

+ Scheme string

+ type ValidationPreProcessor func(r *http.Request) ValidationParameters

+ func AutoProxyRequestValidationPreProcessor() ValidationPreProcessor

+ func DefaultValidationPreProcessor() ValidationPreProcessor

+ func ProxiedRequestValidationPreProcessor(scheme string, host string) ValidationPreProcessor

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