com.ziqni.transformers.ZiqniMqTransformer.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ziqni-transformers Show documentation
Ziqni transformers project.
The newest version!
/***
  *  Copyright (C) Ziqni Ltd - All Rights Reserved
  *  Unauthorized copying of this file, via any medium is strictly prohibited
  *  Proprietary and confidential
  *  Written by Ziqni Ltd, 2021
  */
package com.ziqni.transformers
import com.ziqni.transformers.domain._
trait ZiqniMqTransformer {

	val IsReferenceId = true

	/**
	 * This method gets executed when the transformer is preparing to start
	 * @param ziqniContext The Ziqni Context
	 */
	def preparingToStart(ziqniContext: ZiqniContext): Unit = {

	}

	/**
	 * This method gets executed when the transformer is preparing to stop
	 * @param ziqniContext The Ziqni Context
	 */
	def preparingToStop(ziqniContext: ZiqniContext): Unit = {

	}

	/**
	  * This method gets executed when a message is received on the message queue
	  * @param message The message
	  * @param ziqniContext The Ziqni Context
	  */
	def apply(message: Array[Byte], ziqniContext: ZiqniContext, args: Map[String,Any]): Unit

	/**
	  * This method gets executed when a message is received on the message queue
	  * @param message The message
	  * @param routingKey The routing key for the incoming message from the Envelope of AMQP client
	  * @param exchangeName The exchange name for the incoming message from the Envelope of AMQP client
	  * @param ziqniContext The Ziqni Context
	  */
	def rabbit(message: Array[Byte], routingKey: String, exchangeName: String, ziqniContext: ZiqniContext): Unit =
		apply(
			message, ziqniContext, Map( "routingKey" -> routingKey, "exchangeName" -> exchangeName)
		)

	/**
	  * This method gets executed when a message is received on the message queue
	  * @param topic The message topic
	  * @param message The value for the incoming message from the Kafka broker
	  * @param key The key for the incoming message from the Kafka broker
	  * @param ziqniContext The Ziqni Context
	  */
	def kafka(topic: String, key: Array[Byte], message: Array[Byte], ziqniContext: ZiqniContext, headers: Map[String, Array[Byte]]): Unit =
		apply(
			message, ziqniContext, Map( "key" -> key, "topic" -> topic )++headers
		)

	/**
	  * This method gets executed when a message is received as a POST on API
	  * @param message The value for the incoming message from the http
	  * @param headers Header values for the incoming message
	  * @param ziqniContext The Ziqni Context
	  */
	def http(headers: Map[String, Seq[String]], message: Array[Byte], ziqniContext: ZiqniContext): Unit =
		apply(
			message, ziqniContext, headers
		)

	/**
	  * This method gets executed when a message is received from an SQS endpoint
	  * @param headers Message headers
	  * @param message The message
	  * @param messageId Message id
	  * @param ziqniContext - The Ziqni Context
	  */
	def sqs(headers: Map[String, String], message: Array[Byte], messageId: String, ziqniContext: ZiqniContext): Unit =
		apply(
			message, ziqniContext, headers + ("messageId" -> messageId)
		)

	/**
	 * This method gets executed when the scheduler emits a tick event
	 * @param ziqniContext - The Ziqni Context
	 */
	def scheduled(ziqniContext: ZiqniContext): Unit =
		apply(
			Array.empty, ziqniContext, Map.empty
		)

	/**
		* Get the subscription to use for this transformer to be notified of changes in the system
		* @return
		*/
	def getEntityChangeSubscriptionRequest(ziqniContext: ZiqniContext): Seq[ZiqniEntityChangeSubscriptionRequest] = Seq.empty

	/**
		* If the transformer is subscribed to entity changes then this method is invoked
		* @param change The change events
		*/
	def onEntityChanged(change: ZiqniEntityChanged, ziqniContext: ZiqniContext): Unit = {}

	/**
		* If the transformer is subscribed to entity state changes then this method is invoked
		* @param change
		*/
	def onEntityStateChanged(change: ZiqniEntityStateChanged, ziqniContext: ZiqniContext): Unit = {}

	/**
		* Happens when the class is initialized
		*/
	def initTransformerEventbus(ziqniTransformerInfo:ZiqniTransformerInfo): ZiqniTransformerEventbusConfig = ZiqniTransformerEventbusConfig(ziqniTransformerInfo.connectionId,"all",List.empty)
}