consumer

Documentation

Index

• Variables
• type ConceptAnnotationsEvent
• type ContentQueueHandler
  • func NewContentQueueHandler(contentURIWhitelist *regexp.Regexp, contentTypeWhitelist *Set, ...) *ContentQueueHandler
  • func (qHandler *ContentQueueHandler) HandleMessage(queueMsg kafka.FTMessage) error
• type MessageQueueHandler
• type MessageQueueRouter
  • func NewMessageQueueHandler(contentHandler, metadataHandler MessageQueueHandler) *MessageQueueRouter
  • func (h *MessageQueueRouter) HandleMessage(queueMsg kafka.FTMessage) error
• type MetadataQueueHandler
  • func NewMetadataQueueHandler(originWhitelist []string, mapper NotificationMapper, ...) *MetadataQueueHandler
  • func (h *MetadataQueueHandler) HandleMessage(queueMsg kafka.FTMessage) error
  • func (h *MetadataQueueHandler) IsAllowedOrigin(origin string) bool
• type NotificationMapper
  • func (n NotificationMapper) MapMetadataNotification(event ConceptAnnotationsEvent, transactionID string) dispatch.Notification
  • func (n NotificationMapper) MapNotification(event PublicationEvent, transactionID string) (dispatch.Notification, error)
• type NotificationQueueMessage
  • func (msg NotificationQueueMessage) HasCarouselTransactionID() bool
  • func (msg NotificationQueueMessage) HasSynthTransactionID() bool
  • func (msg NotificationQueueMessage) OriginID() string
  • func (msg NotificationQueueMessage) ToAnnotationEvent() (ConceptAnnotationsEvent, error)
  • func (msg NotificationQueueMessage) ToPublicationEvent() (event PublicationEvent, err error)
  • func (msg NotificationQueueMessage) TransactionID() string
• type PropertyReader
• type PublicationEvent
  • func (e PublicationEvent) HasEmptyPayload() bool
  • func (e PublicationEvent) Matches(whitelist *regexp.Regexp) bool
• type Set
  • func NewSet() *Set
  • func (s *Set) Add(value string)
  • func (s *Set) Contains(value string) bool

Variables

var UUIDRegexp = regexp.MustCompile("[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}")

UUIDRegexp enables to check if a string matches a UUID

Types

type ConceptAnnotationsEvent

type ConceptAnnotationsEvent struct {
	ContentID   string `json:"uuid"`
	Annotations []struct {
		Thing struct {
			ID        string `json:"id"`
			Predicate string `json:"predicate"`
		} `json:"thing"`
	} `json:"annotations"`
}

type ContentQueueHandler

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

func NewContentQueueHandler

func NewContentQueueHandler(contentURIWhitelist *regexp.Regexp, contentTypeWhitelist *Set, mapper NotificationMapper, dispatcher notificationDispatcher, log *logger.UPPLogger) *ContentQueueHandler

NewContentQueueHandler returns a new message handler

func (*ContentQueueHandler) HandleMessage

func (qHandler *ContentQueueHandler) HandleMessage(queueMsg kafka.FTMessage) error

type MessageQueueHandler

type MessageQueueHandler interface {
	HandleMessage(queueMsg kafka.FTMessage) error
}

MessageQueueHandler is a generic interface for implementation of components to handle messages form the kafka queue.

type MessageQueueRouter

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

func NewMessageQueueHandler

func NewMessageQueueHandler(contentHandler, metadataHandler MessageQueueHandler) *MessageQueueRouter

func (*MessageQueueRouter) HandleMessage

func (h *MessageQueueRouter) HandleMessage(queueMsg kafka.FTMessage) error

type MetadataQueueHandler

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

func NewMetadataQueueHandler

func NewMetadataQueueHandler(originWhitelist []string, mapper NotificationMapper, dispatcher notificationDispatcher, log *logger.UPPLogger) *MetadataQueueHandler

func (*MetadataQueueHandler) HandleMessage

func (h *MetadataQueueHandler) HandleMessage(queueMsg kafka.FTMessage) error

func (*MetadataQueueHandler) IsAllowedOrigin

func (h *MetadataQueueHandler) IsAllowedOrigin(origin string) bool

type NotificationMapper

type NotificationMapper struct {
	APIBaseURL string
	Resource   string
	Property   PropertyReader
}

NotificationMapper maps CmsPublicationEvents to Notifications

func (NotificationMapper) MapMetadataNotification

func (n NotificationMapper) MapMetadataNotification(event ConceptAnnotationsEvent, transactionID string) dispatch.Notification

func (NotificationMapper) MapNotification

func (n NotificationMapper) MapNotification(event PublicationEvent, transactionID string) (dispatch.Notification, error)

MapNotification maps the given event to a new notification.

type NotificationQueueMessage

type NotificationQueueMessage struct {
	kafka.FTMessage
}

NotificationQueueMessage is a wrapper for the queue consumer message type

func (NotificationQueueMessage) HasCarouselTransactionID

func (msg NotificationQueueMessage) HasCarouselTransactionID() bool

HasCarouselTransactionID checks if the message is generated by the publish carousel

func (NotificationQueueMessage) HasSynthTransactionID

func (msg NotificationQueueMessage) HasSynthTransactionID() bool

HasSynthTransactionID checks if the message is synthetic

func (NotificationQueueMessage) OriginID

func (msg NotificationQueueMessage) OriginID() string

func (NotificationQueueMessage) ToAnnotationEvent

func (msg NotificationQueueMessage) ToAnnotationEvent() (ConceptAnnotationsEvent, error)

ToAnnotationEvent converts message to ConceptAnnotations Event

func (NotificationQueueMessage) ToPublicationEvent

func (msg NotificationQueueMessage) ToPublicationEvent() (event PublicationEvent, err error)

ToPublicationEvent converts the message to a CmsPublicationEvent

func (NotificationQueueMessage) TransactionID

func (msg NotificationQueueMessage) TransactionID() string

TransactionID returns the message TID

type PropertyReader

type PropertyReader interface {
	LastModified(event ConceptAnnotationsEvent) string
}

type PublicationEvent

type PublicationEvent struct {
	ContentURI        string
	ContentTypeHeader string
	LastModified      string
	Payload           interface{}
	UUID              string
}

PublicationEvent is the data structure that represents a publication event consumed from Kafka

func (PublicationEvent) HasEmptyPayload

func (e PublicationEvent) HasEmptyPayload() bool

HasEmptyPayload is a method that returns true if the PublicationEvent has an empty payload

func (PublicationEvent) Matches

func (e PublicationEvent) Matches(whitelist *regexp.Regexp) bool

Matches is a method that returns True if the ContentURI of a publication event matches a whitelist regexp

type Set

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

func NewSet

func NewSet() *Set

func (*Set) Add

func (s *Set) Add(value string)

func (*Set) Contains

func (s *Set) Contains(value string) bool