Merge pull request #33 from Ashi1993/event

Fixing issues in Event Notification Implementation

open-banking-accelerator/accelerators/ob-is/carbon-home/dbscripts/open-banking/event-notifications/mssql.sql

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+-- All the data related to time are stored in unix time stamp and therefore, the data types for the time related data
+-- are represented in BIGINT.
+-- Since the database systems does not support adding default unix time to the database columns, the default data
+-- storing is handled within the database querieS.
+
+CREATE TABLE OB_NOTIFICATION (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    RESOURCE_ID varchar(255) NOT NULL,
+    STATUS varchar(10) NOT NULL,
+    UPDATED_TIMESTAMP DATETIME2(0) DEFAULT GETDATE(),
+    PRIMARY KEY (NOTIFICATION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_EVENT (
+    EVENT_ID int NOT NULL IDENTITY,
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(200) NOT NULL,
+    EVENT_INFO varchar(1000) NOT NULL,
+    PRIMARY KEY (EVENT_ID),
+    CONSTRAINT FK_NotificationEvent FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_ERROR (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    ERROR_CODE varchar(255) NOT NULL,
+    DESCRIPTION varchar(255) NOT NULL,
+    PRIMARY KEY (NOTIFICATION_ID),
+    CONSTRAINT FK_NotificationError FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_SUBSCRIPTION (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    REQUEST JSON NOT NULL,
+    CALLBACK_URL varchar(255),
+    TIMESTAMP BIGINT NOT NULL,
+    SPEC_VERSION varchar(255),
+    STATUS varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_SUBSCRIBED_EVENTS (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID, EVENT_TYPE),
+    CONSTRAINT FK_NotificationSubEvents FOREIGN KEY (SUBSCRIPTION_ID) REFERENCES OB_NOTIFICATION_SUBSCRIPTION(SUBSCRIPTION_ID)
+);

open-banking-accelerator/accelerators/ob-is/carbon-home/dbscripts/open-banking/event-notifications/mysql.sql

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+-- All the data related to time are stored in unix time stamp and therefore, the data types for the time related data
+-- are represented in BIGINT.
+-- Since the database systems does not support adding default unix time to the database columns, the default data
+-- storing is handled within the database querieS.
+
+-- For event notifications feature run the following queries against the openbank_openbankingdb--
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    RESOURCE_ID varchar(255) NOT NULL,
+    STATUS varchar(10) NOT NULL,
+    UPDATED_TIMESTAMP TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+    PRIMARY KEY (NOTIFICATION_ID)
+)
+ENGINE=InnoDB;
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_EVENT (
+    EVENT_ID int(11) NOT NULL AUTO_INCREMENT,
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(200) NOT NULL,
+    EVENT_INFO varchar(1000) NOT NULL,
+    PRIMARY KEY (EVENT_ID),
+    CONSTRAINT FK_NotificationEvent FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+)
+ENGINE=InnoDB;
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_ERROR (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    ERROR_CODE varchar(255) NOT NULL,
+    DESCRIPTION varchar(255) NOT NULL,
+    PRIMARY KEY (NOTIFICATION_ID),
+    CONSTRAINT FK_NotificationError FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+)
+ENGINE=InnoDB;
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_SUBSCRIPTION (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    REQUEST JSON NOT NULL,
+    CALLBACK_URL varchar(255),
+    TIMESTAMP BIGINT NOT NULL,
+    SPEC_VERSION varchar(255),
+    STATUS varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID)
+)
+ENGINE=InnoDB;
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_SUBSCRIBED_EVENTS (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID, EVENT_TYPE),
+    CONSTRAINT FK_NotificationSubEvents FOREIGN KEY (SUBSCRIPTION_ID) REFERENCES OB_NOTIFICATION_SUBSCRIPTION(SUBSCRIPTION_ID)
+)
+ENGINE=InnoDB;

open-banking-accelerator/accelerators/ob-is/carbon-home/dbscripts/open-banking/event-notifications/oracle.sql

@@ -0,0 +1,76 @@
+/**
+ * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+-- All the data related to time are stored in unix time stamp and therefore, the data types for the time related data
+-- are represented in BIGINT.
+-- Since the database systems does not support adding default unix time to the database columns, the default data
+-- storing is handled within the database querieS.
+
+CREATE TABLE OB_NOTIFICATION (
+    NOTIFICATION_ID varchar2(36) NOT NULL,
+    CLIENT_ID varchar2(255) NOT NULL,
+    RESOURCE_ID varchar2(255) NOT NULL,
+    STATUS varchar2(10) NOT NULL,
+    UPDATED_TIMESTAMP TIMESTAMP(0) DEFAULT SYSTIMESTAMP,
+    PRIMARY KEY (NOTIFICATION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_EVENT (
+    EVENT_ID number(10) NOT NULL,
+    NOTIFICATION_ID varchar2(36) NOT NULL,
+    EVENT_TYPE varchar2(200) NOT NULL,
+    EVENT_INFO varchar2(1000) NOT NULL,
+    PRIMARY KEY (EVENT_ID),
+    CONSTRAINT FK_NotificationEvent FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+);
+
+-- Generate ID using sequence and trigger
+CREATE SEQUENCE OB_NOTIFICATION_EVENT_seq START WITH 1 INCREMENT BY 1;
+
+CREATE OR REPLACE TRIGGER OB_NOTIFICATION_EVENT_seq_tr
+ BEFORE INSERT ON OB_NOTIFICATION_EVENT FOR EACH ROW
+ WHEN (NEW.EVENT_ID IS NULL)
+BEGIN
+ SELECT OB_NOTIFICATION_EVENT_seq.NEXTVAL INTO :NEW.EVENT_ID FROM DUAL;
+END;
+
+CREATE TABLE OB_NOTIFICATION_ERROR (
+    NOTIFICATION_ID varchar2(36) NOT NULL,
+    ERROR_CODE varchar2(255) NOT NULL,
+    DESCRIPTION varchar2(255) NOT NULL,
+    PRIMARY KEY (NOTIFICATION_ID),
+    CONSTRAINT FK_NotificationError FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+)
+
+CREATE TABLE OB_NOTIFICATION_SUBSCRIPTION (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    REQUEST JSON NOT NULL,
+    CALLBACK_URL varchar(255),
+    TIMESTAMP BIGINT NOT NULL,
+    SPEC_VERSION varchar(255),
+    STATUS varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID)
+);
+
+CREATE TABLE OB_NOTIFICATION_SUBSCRIBED_EVENTS (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID, EVENT_TYPE),
+    CONSTRAINT FK_NotificationSubEvents FOREIGN KEY (SUBSCRIPTION_ID) REFERENCES OB_NOTIFICATION_SUBSCRIPTION(SUBSCRIPTION_ID)
+);

open-banking-accelerator/accelerators/ob-is/carbon-home/dbscripts/open-banking/event-notifications/postgresql.sql

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+-- All the data related to time are stored in unix time stamp and therefore, the data types for the time related data
+-- are represented in BIGINT.
+-- Since the database systems does not support adding default unix time to the database columns, the default data
+-- storing is handled within the database querieS.
+
+-- For event notifications feature run the following queries against the openbank_openbankingdb--
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    RESOURCE_ID varchar(255) NOT NULL,
+    STATUS varchar(10) NOT NULL,
+    UPDATED_TIMESTAMP TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP,
+    PRIMARY KEY (NOTIFICATION_ID)
+);
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_EVENT (
+    EVENT_ID SERIAL PRIMARY KEY,
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(200) NOT NULL,
+    EVENT_INFO varchar(1000) NOT NULL,
+    CONSTRAINT FK_NotificationEvent FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+);
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_ERROR (
+    NOTIFICATION_ID varchar(36) NOT NULL,
+    ERROR_CODE varchar(255) NOT NULL,
+    DESCRIPTION varchar(255) NOT NULL,
+    PRIMARY KEY (NOTIFICATION_ID),
+    CONSTRAINT FK_NotificationError FOREIGN KEY (NOTIFICATION_ID) REFERENCES OB_NOTIFICATION(NOTIFICATION_ID)
+);
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_SUBSCRIPTION (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    CLIENT_ID varchar(255) NOT NULL,
+    REQUEST JSON NOT NULL,
+    CALLBACK_URL varchar(255),
+    TIMESTAMP BIGINT NOT NULL,
+    SPEC_VERSION varchar(255),
+    STATUS varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID)
+);
+
+CREATE TABLE IF NOT EXISTS OB_NOTIFICATION_SUBSCRIBED_EVENTS (
+    SUBSCRIPTION_ID varchar(36) NOT NULL,
+    EVENT_TYPE varchar(255) NOT NULL,
+    PRIMARY KEY (SUBSCRIPTION_ID, EVENT_TYPE),
+    CONSTRAINT FK_NotificationSubEvents FOREIGN KEY (SUBSCRIPTION_ID) REFERENCES OB_NOTIFICATION_SUBSCRIPTION(SUBSCRIPTION_ID)
+);

open-banking-accelerator/components/event-notifications/com.wso2.openbanking.accelerator.event.notifications.service/src/main/java/com/wso2/openbanking/accelerator/event/notifications/service/constants/EventNotificationConstants.java

@@ -114,5 +114,5 @@ public class EventNotificationConstants {
     public static final String EVENT_SUBSCRIPTION_NOT_FOUND = "Event subscription not found.";
     public static final String EVENT_SUBSCRIPTIONS_NOT_FOUND = "Event subscriptions not found for the given client id.";
     public static final String ERROR_HANDLING_EVENT_SUBSCRIPTION = "Error occurred while handling the event " +
-            "subscription  request";
+            "subscription request";
 }

open-banking-accelerator/components/event-notifications/com.wso2.openbanking.accelerator.event.notifications.service/src/main/java/com/wso2/openbanking/accelerator/event/notifications/service/dao/AggregatedPollingDAO.java

@@ -35,68 +35,70 @@ public interface AggregatedPollingDAO {
      * This method is to update the notification status by ID, allowed values are.
      * OPEN,ACK and ERR
      *
-     * @param notificationId
-     * @param notificationStatus
-     * @return
+     * @param notificationId     Notification ID to update
+     * @param notificationStatus Notification status to update
+     * @return Update is success or not
      * @throws OBEventNotificationException
      */
     Boolean updateNotificationStatusById(String notificationId, String notificationStatus)
             throws OBEventNotificationException;
 
     /**
-     * This method is to store event notifications in the OB_NOTIFICATION table.
-     * @param notificationError
-     * @return
+     * This method is to store event notifications error details in the OB_NOTIFICATION table.
+     *
+     * @param notificationError  Notification error details
+     * @return Stored event notifications error details
      * @throws OBEventNotificationException
      */
     Map<String, NotificationError> storeErrorNotification(NotificationError notificationError)
             throws OBEventNotificationException;
 
     /**
      * This method is to retrieve given number of notifications in the OB_NOTIFICATION table by client and status.
-     * @param clientId
-     * @param status
-     * @param max
-     * @return
+     *
+     * @param clientId  Client ID to retrieve notifications
+     * @param status    Notification status to retrieve
+     * @param max       Maximum number of notifications to retrieve
+     * @return List of notifications by client and status
      * @throws OBEventNotificationException
      */
     List<NotificationDTO> getNotificationsByClientIdAndStatus(String clientId, String
             status, int max) throws OBEventNotificationException;
 
     /**
      * This method is to retrieve notifications by NotificationID.
-     * @param notificationId
      *
-     * @return
+     * @param notificationId  Notification ID to retrieve
+     * @return List of notifications by notification ID
      * @throws OBEventNotificationException
      */
     List<NotificationEvent> getEventsByNotificationID(String notificationId) throws OBEventNotificationException;
 
     /**
      * This method is to retrieve notifications in the OB_NOTIFICATION table by status.
-     * @param status
      *
-     * @return List<NotificationDTO>
+     * @param status  Notification status to retrieve
+     * @return List of notifications by status
      * @throws OBEventNotificationException
      */
     List<NotificationDTO> getNotificationsByStatus(String status) throws OBEventNotificationException;
 
     /**
      * This method is to retrieve notificationsCount by ClientId and Status.
-     * @param clientId
-     * @param eventStatus
      *
-     * @return
+     * @param clientId    Client ID to retrieve notifications
+     * @param eventStatus Notification status to retrieve
+     * @return List of notifications by status and client id
      * @throws OBEventNotificationException
      */
     int getNotificationCountByClientIdAndStatus(String clientId, String eventStatus)
             throws OBEventNotificationException;
 
     /**
      * This method is to retrieve the notification status.
-     * @param notificationId
      *
-     * @return
+     * @param notificationId  Notification ID to retrieve
+     * @return Notification status by notification ID
      * @throws OBEventNotificationException
      */
     boolean getNotificationStatus(String notificationId) throws OBEventNotificationException;