External Event Enablement – AWS, AZURE, GCP

In this example, the event type accountservice/account/create denotes the create action in the Accounts service. Also, the identifier response_account.id denotes the account.id has to be fetched from the response object.

1. Create a custom class CamelEventConfiguration for interception to specific route that implement the CamelContextConfiguration interface which contains two methods.
   For example:
   

   public class CamelEventConfiguration implements CamelContextConfiguration { @Override private void beforeApplicationStart(CamelContext camelContext) { camelContext.getRouteDefinition(“routeAddCustomerAddressRest”).adviceWith(camelContext, new AdviceWithRouteBuilder() { @Override public void configure() throws Exception { onCompletion().toProcess(“resetPasswordExternalEvent”); } }); } private void afterApplicationStart(CamelContext camelContext) {} }

2. Create a custom process class CreateCustomerEvent and auto wire EventUtil in the class inside the process class. You need to call gePayload() and sendEventPayload() methods.
   • getPayload() –  to convert payload from the body of the route.
   • sendEventPayload() – to send event payload to event bridge with the above payload.

   public class CreateCustomerEvent implements Processor { @Autowired private EventUtil eventUtil; @Override public void process(Exchange exchange) throws JsonParseException, JsonMappingException, IOException { EventPayload<?> event= eventUtil.getPayload(exchange, CustomerLoginResponse.class); //You can change the id, eventType, and payload information from the event and send it to below mentioned send event function. eventUtil.sendEventPayload(event); }

Orchestration Support

public class EventUtil { public void sendEventPayload(EventPayload<?> payloadobject) {} public Object getPayload(Exchange exchange, Class<?> responseModel){} }

Portal Configurations

Event Bridge

 In Event Bridge, you need to:

• Create an Event Bus
• Create a Rule

Creating a Rule

To create a rule,

1. Define Rule Detail.
   
2. Build event pattern.
   Sample Event:

   { “version”: “0”, “id”: “0948ba87-d3b8-c6d4-f2da-732a1example”, “detail-type”: “Macie Finding”, “source”: “catalog”, “account”: “123456789012”, “time”: “2021-04-29T23:12:15Z”, “region”: “us-east-1”, “resources”: [], “detail”: { “messageType”: null, “sender”: null, “id”: “3”, “payload”: { “responseCode”: “ACACCRE0000”, “responseMessage”: “Collection Create Success”, “timeStamp”: null, “account”: { “id”: 3, “collectionId”: 1, “name”: “Account 1”, “size”: “<500”, “phoneNumber”: “+919876543210”, “dunsNumber”: “skava123”, “taxNumber”: “skava123”, “typeId”: 1, “accountType”: “Hardware”, “status”: “active”, “parentAccountId”: 1, “createdTime”: 1655816483884, “updatedTime”: 1655816483884, “properties”: [], “createdBy”: 1, “updatedBy”: 1, “costCentre”: [ { “id”: 4, “accountId”: 3, “name”: “Default Cost Centre”, “status”: “active”, “createdTime”: 1655816483910, “updatedTime”: 1655816483910, “createdBy”: 1, “updatedBy”: 1, “budgets”: null } ], “team”: [ { “id”: 2, “accountId”: 3, “costCentreId”: 4, “name”: “Default Team”, “description”: null, “status”: “active”, “createdTime”: 1655816483925, “updatedTime”: 1655816483925, “createdBy”: 1, “updatedBy”: 1, “teamBuyer”: null } ] } }, “correlationId”: null, “collectionId”: null, “version”: null, “authToken”: null, “publisherId”: null, “msgProps”: null, “eventType”: “Create Account”, “userId”: “1”, “actOnBehalfOfUser”: 0, “roles”: [ “ROLE_SUPER_ADMIN” ] } }

   

3. Select Custom pattern JSON editor and provide values as given below:

   <span class="token punctuation">{</span> <span class="token property">"detail"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"eventType"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"prefix"</span><span class="token operator">:</span> <span class="token string">"omsservices/orders/create"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span>

   Note: The prefix key denotes the service name.
   

4.  Select Target. In that, you need to:
   
   • Select a target type as AWS service
   • Select a target as CloudWatch log group
   • Select a log group, for example, aws/events/eventbridge.log
     
     
5. Review and Update.
   After doing all the above configurations, review and submit the rule.

Event Grid

In Event Bridge, you need to:

• Create a Custom Topic
• Subscribe to Custom Topic

Creating a Custom Topic

1. On Azure Portal, search for Event Grid.

2. Under Custom events, click Manage Topics.
   

3. On the Event Grid Topics page, select Create available at the toolbar.
   

4. On the Create Topic page, follow these steps:

   1. Select your required subscription.

   2. Select an existing resource group.

   3. Provide a unique name for the custom topic.

   4. Select a Region.

   5. Select Review + create at the bottom of the page.

5. Once the topic is successfully created, navigate to the particular topic to get the topic details such as the topic endpoint to enter the Zookeeper properties.
   

Subscribe to Custom Topic

Subscription is required to receive an event.

To create an event subscription,

1. On the Event Grid Topic page of your custom topic, select Event Subscription on the toolbar.
   You are navigated to the Create Event Subscription page.
   

2. On the Create Event Subscription page, follow these steps:

1. 1. Enter a unique subscription name.

   2. Select Event Schema.
      

   3. Select Storage Queues as the Endpoint type.
      Note: The endpoint type can be chosen as per the requirement, the below step is to receive events through storage queues.

   4. Click Select an endpoint.
      Note: Select the storage account and select an existing queue if the queue is created already; otherwise, create a new queue.
      

   5. Select Create at the bottom of the page.
      

You have triggered the event, and Event Grid sends the message to the endpoint you configured when subscribing. The message is in the JSON format and it contains an array with one or more events. For example,

{ “id”: “4b9dfe97-2a2c-4a85-bbf3-a543cbb943c2”, “subject”: “catalogservice”, “data”: { “id”: “2”, “timestamp”: “2023-02-20T10:36:25.932+00:00”, “payload”: { “identifier”: “2”, “collectionId”: 1, “type”: “MASTER”, “status”: “ACTIVE”, “subType”: “DEFAULT”, “sfFilter”: “string”, “adminFilter”: “string”, “startTime”: “2016-11-09T11:44:44.797+05:30”, “endTime”: “2025-11-09T11:44:44.797+05:30”, “createdOn”: “2023-02-20T16:06:25.9235963+05:30”, “createdBy”: 1, “updatedOn”: “2023-02-20T16:06:25.9235963+05:30”, “updatedBy”: 1, “properties”: [ { “createdBy”: 0, “updatedBy”: 0, “value”: “string”, “name”: “string”, “locale”: “en_US” } ] }, “eventType”: “catalogservice/catalog/create”, “userId”: “1”, “actOnBehalfOfUser”: 0, “roles”: [ “ROLE_SUPER_ADMIN” ], “subject”: “catalogservice” }, “eventType”: “catalogservice/catalog/create”, “dataVersion”: “2”, “metadataVersion”: “1”, “eventTime”: “2023-02-20T10:36:27.0768392Z”, “topic”: “/subscriptions/7d19369d-a8d9-425e-9415-8c856593ff8c/resourceGroups/EQ_<<ClientName>>_Platform/providers/Microsoft.EventGrid/topics/<<ClientName>>-event-grid-topic” }

Note: You need to replace <<ClientName>> with the client name.

Event Arc

In Event Arc, you need to Create and Subscribe to Topic

Create and Subscribe to Topic

1. Enter Project Name and Location.
   

2. On the Event Arc Topics page, select Create Topic on the toolbar.
   

3. On the Create Topic page, follow these steps:

   1. Provide a unique Topic ID for the custom topic.

   2. Select Add a default subscription to create a default subscription.

   3. For Encryption, select Google-manage encryption key.

   4. Select CREATE at the bottom of the page.
      

4. Once a topic is successfully created, navigate to the particular topic list page to get the topic details such as the topic name.
   
5. Select a particular Topic ID in the Topics page.
6. Navigate to the particular topic page to get the topic details such as topic name and default subscription in the below topic page:
   
7. Click the Default Subscription ID button available at the bottom left on the topic page or create a new custom subscription.
   
8. Navigate to the subscription page to get subscription details such as subscription name, subscription state, topic name, and event massages.
9. To get event messages, follow these steps:

1. 1. Select the MESSAGES tab available below the subscription details.

   2. Click PULL to get all the published messages.

   3. Select a particular message to get the event payload.
      

ZooKeeper Properties

The ZooKeeper properties to be configured are:

CLOUD	KEY	VALUE	ALLOWED VALUES	DESCRIPTION
AWS,AZURE,GCP	skava.event.enableExternalEvent	ZK_ENABLE_EVENT_BRIDGE	True/False	This is to enable/disable External Events.
AWS,AZURE,GCP	skava.event.enableFatEvent	FALSE	True/False	This is to enable/disable Fat Events.
AWS,AZURE,GCP	skava.event.externalFatEventClass		String	This will be used to send events from the custom implementation class.
AWS,AZURE,GCP	skava.event.externalClassName		String	This will contain external Event component class name(GCP/Azure). By default, it is take as AwsEventComponent class.
AWS	skava.event.eventbridge.region	ZK_EVENT_BRIDGE_REGION	String	This will contain AWS EventBridge region.
AWS	skava.event.eventbridge.eventBusName	ZK_EVENT_BRIDGE_EVENT_BUS_NAME	String	This will contain AWS bus name of EventBridge.
AZURE	skava.event.eventgrid.topicEndPoint	ZK_EVENT_GRID_TOPIC_ENDPOINT	String	This will contain Topic EndPoint url of Azure EventGrid.
AZURE	skava.event.eventgrid.endPointKey	ZK_EVENT_GRID_ENDPOINT_KEY	String	This will contain EndPoint Key of Azure EventGrid.
GCP	skava.event.eventarc.projectId	ZK_EVENT_ARC_PROJECT_ID	String	This will contain Project Id of GCP EventArc.
GCP	skava.event.eventarc.topicId	ZK_EVENT_ARC_TOPIC_ID	String	This will contain Topic Id of GCP EventArc.

Extension to Fat Events

To send fat events on top of thin events, the following method from the abstract class is to be overridden in the extension plugin of the particular microservice.

abstract class EventProcess { public void updateEventPayload(InputModel input, OutputModel output, EventPayload<Object> event) { } }

Note: The parameters:

• input – denotes request object is sent
• output – denotes response object is sent
• event – denotes thin event object is sent to update fat events

Example:

public class OrderEventProcessImpl extends EventProcess { @Override public void updateEventPayload(InputModel input, OutputModel output, EventPayload<Object> event) { // Add stuff to override event payload } }

Event Details for Services

Here are the links to the event details of all microservices:

Revision History

2023-11-15| AN, SD – Updated the page.
2023-10-16| AN, SD – Created the page and updated for release 8.15.0.