channels

Documentation

Overview

Copyright (c) Abstract Machines SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func AvailableActions() []roles.Action
• func BuiltInRoles() map[roles.BuiltInRoleName][]roles.Action
• func NewExternalOperationPerm() svcutil.ExternalOperationPerm
• func NewExternalOperationPermissionMap() map[svcutil.ExternalOperation]svcutil.Permission
• func NewOperationPerm() svcutil.OperationPerm
• func NewOperationPermissionMap() map[svcutil.Operation]svcutil.Permission
• func NewRolesOperationPermissionMap() map[svcutil.Operation]svcutil.Permission
• type AuthzReq
• type Channel
• type Connection
• type Page
• type PageMetadata
• type Repository
• type Service
  • func New(repo Repository, policy policies.Service, idProvider supermq.IDProvider, ...) (Service, error)

Constants

const (
	ChannelUpdate           roles.Action = "update"
	ChannelRead             roles.Action = "read"
	ChannelDelete           roles.Action = "delete"
	ChannelSetParentGroup   roles.Action = "set_parent_group"
	ChannelConnectToChannel roles.Action = "connect_to_client"
	ChannelManageRole       roles.Action = "manage_role"
	ChannelAddRoleUsers     roles.Action = "add_role_users"
	ChannelRemoveRoleUsers  roles.Action = "remove_role_users"
	ChannelViewRoleUsers    roles.Action = "view_role_users"
)

const (
	OpViewChannel svcutil.Operation = iota
	OpUpdateChannel
	OpUpdateChannelTags
	OpEnableChannel
	OpDisableChannel
	OpDeleteChannel
	OpSetParentGroup
	OpRemoveParentGroup
	OpConnectClient
	OpDisconnectClient
)

const (
	DomainOpCreateChannel svcutil.ExternalOperation = iota
	DomainOpListChannel
	GroupOpSetChildChannel
	GroupsOpRemoveChildChannel
	ClientsOpConnectChannel
	ClientsOpDisconnectChannel
)

External Operations.

const (
	BuiltInRoleAdmin = "admin"
)

Functions

func AvailableActions

func AvailableActions() []roles.Action

func BuiltInRoles

func BuiltInRoles() map[roles.BuiltInRoleName][]roles.Action

func NewExternalOperationPerm

func NewExternalOperationPerm() svcutil.ExternalOperationPerm

func NewExternalOperationPermissionMap

func NewExternalOperationPermissionMap() map[svcutil.ExternalOperation]svcutil.Permission

func NewOperationPerm

func NewOperationPerm() svcutil.OperationPerm

func NewOperationPermissionMap

func NewOperationPermissionMap() map[svcutil.Operation]svcutil.Permission

func NewRolesOperationPermissionMap

func NewRolesOperationPermissionMap() map[svcutil.Operation]svcutil.Permission

Types

type AuthzReq

type AuthzReq struct {
	DomainID   string
	ChannelID  string
	ClientID   string
	ClientType string
	Type       connections.ConnType
}

type Channel

type Channel struct {
	ID          string           `json:"id"`
	Name        string           `json:"name,omitempty"`
	Tags        []string         `json:"tags,omitempty"`
	ParentGroup string           `json:"parent_group_id,omitempty"`
	Domain      string           `json:"domain_id,omitempty"`
	Metadata    clients.Metadata `json:"metadata,omitempty"`
	CreatedAt   time.Time        `json:"created_at,omitempty"`
	UpdatedAt   time.Time        `json:"updated_at,omitempty"`
	UpdatedBy   string           `json:"updated_by,omitempty"`
	Status      clients.Status   `json:"status,omitempty"`      // 1 for enabled, 0 for disabled
	Permissions []string         `json:"permissions,omitempty"` // 1 for enabled, 0 for disabled
}

Channel represents a SuperMQ "communication topic". This topic contains the clients that can exchange messages between each other.

type Connection

type Connection struct {
	ClientID  string
	ChannelID string
	DomainID  string
	Type      connections.ConnType
}

type Page

type Page struct {
	PageMetadata
	Channels []Channel
}

ChannelsPage contains page related metadata as well as list of channels that belong to this page.

type PageMetadata

type PageMetadata struct {
	Total      uint64           `json:"total"`
	Offset     uint64           `json:"offset"`
	Limit      uint64           `json:"limit"`
	Name       string           `json:"name,omitempty"`
	Id         string           `json:"id,omitempty"`
	Order      string           `json:"order,omitempty"`
	Dir        string           `json:"dir,omitempty"`
	Metadata   clients.Metadata `json:"metadata,omitempty"`
	Domain     string           `json:"domain,omitempty"`
	Tag        string           `json:"tag,omitempty"`
	Permission string           `json:"permission,omitempty"`
	Status     clients.Status   `json:"status,omitempty"`
	IDs        []string         `json:"ids,omitempty"`
	ListPerms  bool             `json:"-"`
	ClientID   string           `json:"-"`
}

type Repository

type Repository interface {
	// Save persists multiple channels. Channels are saved using a transaction. If one channel
	// fails then none will be saved. Successful operation is indicated by non-nil
	// error response.
	Save(ctx context.Context, chs ...Channel) ([]Channel, error)

	// Update performs an update to the existing channel.
	Update(ctx context.Context, c Channel) (Channel, error)

	UpdateTags(ctx context.Context, ch Channel) (Channel, error)

	ChangeStatus(ctx context.Context, channel Channel) (Channel, error)

	// RetrieveByID retrieves the channel having the provided identifier
	RetrieveByID(ctx context.Context, id string) (Channel, error)

	// RetrieveAll retrieves the subset of channels.
	RetrieveAll(ctx context.Context, pm PageMetadata) (Page, error)

	// Remove removes the channel having the provided identifier
	Remove(ctx context.Context, ids ...string) error

	// SetParentGroup set parent group id to a given channel id
	SetParentGroup(ctx context.Context, ch Channel) error

	// RemoveParentGroup remove parent group id fr given chanel id
	RemoveParentGroup(ctx context.Context, ch Channel) error

	AddConnections(ctx context.Context, conns []Connection) error

	RemoveConnections(ctx context.Context, conns []Connection) error

	CheckConnection(ctx context.Context, conn Connection) error

	ClientAuthorize(ctx context.Context, conn Connection) error

	ChannelConnectionsCount(ctx context.Context, id string) (uint64, error)

	DoesChannelHaveConnections(ctx context.Context, id string) (bool, error)

	RemoveClientConnections(ctx context.Context, clientID string) error

	RemoveChannelConnections(ctx context.Context, channelID string) error

	RetrieveParentGroupChannels(ctx context.Context, parentGroupID string) ([]Channel, error)

	UnsetParentGroupFromChannels(ctx context.Context, parentGroupID string) error

	roles.Repository
}

ChannelRepository specifies a channel persistence API.

type Service

type Service interface {
	// CreateChannels adds channels to the user identified by the provided key.
	CreateChannels(ctx context.Context, session authn.Session, channels ...Channel) ([]Channel, error)

	// ViewChannel retrieves data about the channel identified by the provided
	// ID, that belongs to the user identified by the provided key.
	ViewChannel(ctx context.Context, session authn.Session, id string) (Channel, error)

	// UpdateChannel updates the channel identified by the provided ID, that
	// belongs to the user identified by the provided key.
	UpdateChannel(ctx context.Context, session authn.Session, channel Channel) (Channel, error)

	// UpdateChannelTags updates the channel's tags.
	UpdateChannelTags(ctx context.Context, session authn.Session, channel Channel) (Channel, error)

	EnableChannel(ctx context.Context, session authn.Session, id string) (Channel, error)

	DisableChannel(ctx context.Context, session authn.Session, id string) (Channel, error)

	// ListChannels retrieves data about subset of channels that belongs to the
	// user identified by the provided key.
	ListChannels(ctx context.Context, session authn.Session, pm PageMetadata) (Page, error)

	// ListChannelsByClient retrieves data about subset of channels that have
	// specified client connected or not connected to them and belong to the user identified by
	// the provided key.
	ListChannelsByClient(ctx context.Context, session authn.Session, id string, pm PageMetadata) (Page, error)

	// RemoveChannel removes the client identified by the provided ID, that
	// belongs to the user identified by the provided key.
	RemoveChannel(ctx context.Context, session authn.Session, id string) error

	// Connect adds clients to the channels list of connected clients.
	Connect(ctx context.Context, session authn.Session, chIDs, clIDs []string, connType []connections.ConnType) error

	// Disconnect removes clients from the channels list of connected clients.
	Disconnect(ctx context.Context, session authn.Session, chIDs, clIDs []string, connType []connections.ConnType) error

	SetParentGroup(ctx context.Context, session authn.Session, parentGroupID string, id string) error

	RemoveParentGroup(ctx context.Context, session authn.Session, id string) error

	roles.RoleManager
}

func New

func New(repo Repository, policy policies.Service, idProvider supermq.IDProvider, clients grpcClientsV1.ClientsServiceClient, groups grpcGroupsV1.GroupsServiceClient, sidProvider supermq.IDProvider) (Service, error)