• Package: org.egov.works.service

• Source File: ContractNotificationService.java

• Dependencies: Spring Framework, Kafka, Lombok

Overview

The ContractNotificationService class manages the notification workflow for contract-related actions within the eGov Works module. It processes contract-related Kafka messages and sends appropriate notifications to relevant stakeholders.

Attributes

1. notificationServiceConfiguration: Configuration settings for notification services.

2. restTemplate: Template for making RESTful HTTP requests.

3. producer: Kafka producer for sending notifications.

4. mapper: Object mapper for JSON serialization and deserialization.

5. hrmsUtils: Utility class for HRMS (Human Resource Management System) operations.

6. estimateServiceUtil: Utility class for estimate-related operations.

7. projectServiceUtil: Utility class for project-related operations.

8. locationServiceUtil: Utility class for location-related operations.

9. organisationServiceUtil: Utility class for organization-related operations.

10. repository: Repository for service request operations.

11. localizationUtil: Utility class for localization operations.

12. contractsUtil: Utility class for contract-related operations.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Processes the Kafka message for contract-related actions and sends notifications accordingly.

• sendNotification(ContractRequest request): Sends notifications based on the type of contract action.

• pushNotificationForRevisedContract(ContractRequest request): Sends notifications for revised contracts.

• pushNotificationToOriginator(ContractRequest request, String message, String cboMobileNumber): Sends notifications to the originator.

• pushNotificationToCreatorForRejectAction(ContractRequest request): Sends notifications to the creator for reject actions.

• pushNotificationToCreatorForApproveAction(ContractRequest request): Sends notifications to the creator for approve actions.

• pushNotificationToCreatorForDeclineAction(ContractRequest request): Sends notifications to the creator for decline actions.

• pushNotificationToCreatorForAcceptAction(ContractRequest request): Sends notifications to the creator for accept actions.

• pushNotificationToCBOForApproveAction(ContractRequest request): Sends notifications to the(CBO) for approve actions.

• getDetailsForSMS(ContractRequest request, String uuid): Retrieves details required for SMS notifications.

• getProjectNumber(ContractRequest request): Retrieves project details for SMS notifications.

• getOrgDetailsForCBOAdmin(ContractRequest request): Retrieves organization details for CBO administrators.

• getMessage(ContractRequest request, boolean isCBORole): Retrieves the message based on the contract action.

• getMessage(ContractRequest request, String msgCode): Retrieves the message from localization.

• buildMessageForRevisedContract(Map<String, String> userDetailsForSMS, String message, Boolean isSendBack): Builds the message for revised contracts.

• buildMessageForRejectAction(Contract contract, Map<String, String> userDetailsForSMS, String message): Builds the message for reject actions.

• buildMessageForApproveActionWOCBO(Contract contract, Map<String, String> userDetailsForSMS, String message): Builds the message for approve actions by WO creator.

• buildMessageForWOCreator(Contract contract, Map<String, String> userDetailsForSMS, String message): Builds the message for WO creator.

• buildMessageForDeclineAction_WOCreator(Contract contract, Map<String, String> userDetailsForSMS, String message): Builds the message for decline actions by WO creator.

• buildMessageForAcceptAction_WOCreator(Contract contract, Map<String, String> userDetailsForSMS, String message): Builds the message for accept actions by WO creator.

• getLocalisedMessages(RequestInfo requestInfo, String tenantId, String locale, String module): Retrieves localized messages.

• getShortnerURL(String actualURL): Retrieves the shortened URL.

• setAdditionalFields(ContractRequest request, String localizationCode,Map<String, Object> additionalField ): Sets additional fields for notifications.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalField,Map<String,String> smsDetails): Checks additional fields and pushes notifications onto the SMS topic.

• Package: org.egov.works.service

• Source File: ExpenseNotificationService.java

Overview

The ExpenseNotificationService class is responsible for processing notifications related to expenses within the eGov Works module. It handles the generation and sending of notifications for both purchase bills and supervision bills.

Attributes

1. producer: Kafka producer for sending notifications.

2. config: Configuration settings for notification services.

3. hrmsUtils: Utility class for interacting with the HRMS (Human Resource Management System).

4. projectServiceUtil: Utility class for project-related operations.

5. locationServiceUtil: Utility class for location-related operations.

6. mapper: Object mapper for JSON serialization/deserialization.

7. repository: Repository for service requests.

8. notificationUtil: Utility class for notification-related operations.

9. localizationUtil: Utility class for localization operations.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Processes the incoming Kafka message, determining whether it pertains to a purchase bill or a supervision bill, and sends the appropriate notification accordingly.

• sendNotificationForPurchaseBill(BillRequest billRequest): Sends notifications for purchase bills, handling approval and rejection actions.

• sendNotificationForSupervisionBill(BillRequest billRequest): Sends notifications for supervision bills.

• getMessage(RequestInfo requestInfo, String tenantId, String msgCode, Map<String,Object> additionalFields): Retrieves the localized message for a given code and locale, optionally adding additional fields if required.

• buildMessageReplaceVariables(String message, String billNumber, String amount): Replaces variables in a message template with actual values.

• setAdditionalFields(RequestInfo requestInfo,String tenantId, String localizationCode, Map<String,Object> additionalFields): Sets additional fields for the notification if required.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalFields, String mobileNumber): Checks if additional fields are present and sends the SMS request accordingly.

Usage

Instantiate and configure the ExpenseNotificationService class within the application context to handle notifications related to expenses. Ensure that dependencies such as Kafka producer, configuration settings, and utility classes are properly injected.

Overview

The SMS Adapter Service, part of the Mukta_IMPL repository, is a crucial component designed to facilitate SMS notifications. It listens for incoming data on specific Kafka topics and triggers the sending of SMS notifications

Repository Information

• Repository Name: Mukta_IMPL

• Branch: UAT

• Branch: click here for branch link

• Environment: mukta-uat

• Port: 8080

• Context Path: /sms-adapter

Dependencies

• Database(Postgres): digit_works

• Kafka Server

• idGenService

• attendanceService

• workflowService

• mdmsService

• hrmsService

• estimateService

• worksProjectManagementSystemService

• locationService

• contractService

• localizationService

• urlShortnerService

• organisationService

• expenseCalculatorService

• Package: org.egov.works.service

• Source File: NotificationConsumerService.java

• Dependencies: Spring Framework, Kafka, Lombok

Overview

The NotificationConsumerService class is responsible for routing Kafka messages to specific service components based on the topic they belong to within the eGov Works module.

Attributes

1. contractNotificationService: Service for processing contract-related notifications.

2. estimateNotificationService: Service for processing estimate-related notifications.

3. notificationServiceConfiguration: Configuration settings for notification services.

4. expenseNotificationService: Service for processing expense-related notifications.

5. musterRollNotificationService: Service for processing muster roll related notifications.

6. measurementNotificationService: Service for processing measurement related notifications.

7. organizationNotificationService: Service for processing organization related notifications.

8. individualNotificationService: Service for processing individual related notifications.

Methods

• fetchServiceBasedOnTopic(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Determines the appropriate service handler based on the topic of the received message and delegates the message processing to that specific service.

Usage

Instantiate and configure the NotificationConsumer class within the application context to enable message consumption from Kafka topics. Ensure that the NotificationConsumerService class is properly injected into the NotificationConsumer class for seamless message processing.

• Package: org.egov.works.service

• Source File: EstimateNotificationService.java

• Dependencies: Spring Framework, Kafka, Jackson, Lombok, Apache Commons Lang3

Overview

The EstimateNotificationService class is a part of the SMS adapter service in the eGov Works module. This service facilitates the sending of notifications related to estimate workflows via SMS.

Attributes

1. producer: Kafka producer for sending notifications.

2. config: NotificationServiceConfiguration for accessing configuration settings.

3. hrmsUtils: HRMSUtils for fetching employee details.

4. projectServiceUtil: ProjectServiceUtil for fetching project details.

5. locationServiceUtil: LocationServiceUtil for fetching location details.

6. mapper: ObjectMapper for JSON serialization/deserialization.

7. repository: ServiceRequestRepository for fetching data from external services.

8. localizationUtil: LocalizationUtil for fetching localized messages.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Processes Kafka messages containing EstimateRequest data.

• sendNotification(EstimateRequest request): Determines the action type and invokes corresponding notification methods.

• pushNotificationToCreatorForRejectAction(EstimateRequest request): Sends a notification for the rejection action in the estimate workflow.

• pushNotificationToCreatorForApproveAction(EstimateRequest request): Sends a notification for the approval action in the estimate workflow.

• getDetailsForSMS(EstimateRequest request, String uuid): Retrieves details necessary for constructing SMS notifications, such as project and user information.

• getMessage(EstimateRequest request): Retrieves the appropriate message template based on the workflow action.

• buildMessageForRejectAction(Estimate estimate, Map<String, String> userDetailsForSMS, String message): Constructs the SMS content for the rejection action.

• buildMessageForApproveActionCreator(Estimate estimate, Map<String, String> userDetailsForSMS, String message): Constructs the SMS content for the approval action by the estimate creator.

• getLocalisedMessages(RequestInfo requestInfo, String rootTenantId, String locale, String module): Retrieves localized messages based on the user's locale and module.

• setAdditionalFields(EstimateRequest request, String localizationCode, Map<String, Object> additionalField): Sets additional fields required for customizing SMS content.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalField, Map<String, String> smsDetails): Checks if additional fields are required and pushes the SMS message to the appropriate Kafka topic.

Usage

The EstimateNotificationService class is utilized within the eGov Works module for sending SMS notifications related to estimate workflows. It integrates with Kafka for message processing and supports dynamic message construction based on predefined templates and user-specific data.

• Package: org.egov.works.kafka

• Source File: NotificationConsumer.java

• Dependencies: Spring Framework, Kafka, Lombok

Overview

The NotificationConsumer class is responsible for consuming messages from Kafka topics and forwarding them to the NotificationConsumerService for further processing within the eGov Works module.

Functionality

The primary functionality of the NotificationConsumer class includes:

Consuming Kafka Messages: Messages are consumed from specified Kafka topics using Kafka listeners.

Forwarding Messages: Consumed messages are forwarded to the NotificationConsumerService for processing based on the topic.

Usage

The NotificationConsumer class acts as a bridge between Kafka topics and the NotificationConsumerService, ensuring seamless message consumption and processing within the eGov Works module.

• Package: org.egov.works.service

• Source File: OrganizationNotificationService.java

Overview

The OrganizationNotificationService class is responsible for handling notifications related to organization management within the eGov Works module. It facilitates the generation and sending of notifications to relevant parties when organizations are created or updated.

Attributes

1. mapper: ObjectMapper for JSON serialization/deserialization.

2. notificationServiceConfiguration: Configuration settings for notification services.

3. producer: Kafka producer for sending notifications.

4. restTemplate: RestTemplate for making HTTP requests.

5. repository: ServiceRequestRepository for fetching data from external services.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic, boolean isCreateOperation): Processes the incoming Kafka message containing organization details and delegates the notification sending process based on whether it's a create or update operation.

• sendNotification(OrgRequest request, boolean isCreateOperation): Sends notifications for organization creation or update based on the boolean flag.

• pushNotificationForCreate(OrgRequest request): Pushes notifications for organization creation to relevant personnel.

• pushNotificationForUpdate(OrgRequest request): Pushes notifications for organization updates to relevant personnel.

• getOrganisations(OrgSearchRequest orgSearchRequest): Fetches organization details based on search criteria.

• setAdditionalFields(OrgRequest request, String localizationCode, Map<String, Object> additionalField): Sets additional fields for the notification if required.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalField, String mobileNumber): Checks if additional fields are present and pushes the SMS notification accordingly.

• getDetailsForSMS(Organisation organisation): Retrieves details necessary for composing the SMS notification for organization creation.

  getShortnerURL(String actualURL): Shortens the provided URL using a URL

• getSMSDetailsForUpdate(OrgRequest request): Retrieves details necessary for composing the SMS notification for organization update.

• getMessage(OrgRequest request, boolean isCreateOperation): Retrieves the localized message for organization creation or update based on the operation type.

• getMessage(OrgRequest request, String msgCode): Retrieves the localized message for the specified code and locale.

• buildMessageForCreateAction(Map<String, String> userDetailsForSMS, String message): Builds the message for organization creation based on the provided user details.

• buildMessageForUpdateAction(Map<String, String> userDetailsForSMS, String message): Builds the message for organization update based on the provided user details.

• getLocalisedMessages(RequestInfo requestInfo, String rootTenantId, String locale, String module): Fetches localized messages from the localization service based on the specified parameters.

• getShortnerURL(String actualURL): Shortens the provided URL using a URL shortening service.

Usage

Instantiate and configure the OrganizationNotificationService class within the application context to handle notifications related to organization management. Ensure that dependencies such as ObjectMapper, configuration settings, Kafka producer, and RestTemplate are properly injected. Additionally, ensure that the ServiceRequestRepository is configured to communicate with external services for fetching data.

• Package: org.egov.works.service

• Source File: MusterRollNotificationService.java

Overview

The MusterRollNotificationService class is responsible for processing notifications related to muster rolls within the eGov Works module. It handles the generation and sending of notifications to CBO (Central Billing Office) personnel based on different actions performed on muster rolls.

Attributes

1. producer: Kafka producer for sending notifications.

2. config: Configuration settings for notification services.

3. hrmsUtils: A utility class for interacting with the HRMS (Human Resource Management System).

4. projectServiceUtil: Utility class for project-related operations.

5. locationServiceUtil: Utility class for location-related operations.

6. mapper: Object mapper for JSON serialization/deserialization.

7. repository: Repository for service requests.

8. notificationUtil: Utility class for notification-related operations.

9. localizationUtil: Utility class for localization operations.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Processes the incoming Kafka message containing muster roll details and delegates the notification sending process to the appropriate method.

• sendNotificationToCBO(MusterRollRequest musterRollRequest): Sends notifications to CBO personnel based on the action performed on the muster roll (e.g., send back for correction, approval).

• setAdditionalFields(MusterRollRequest request, String localizationCode,Map<String, Object> additionalField ): Sets additional fields for the notification if required.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage , Map<String, Object> additionalField,Map<String,String> smsDetails): Checks if additional fields are present and sends the SMS request accordingly.

• getMessage(MusterRollRequest musterRollRequest, String msgCode): Retrieves the localized message for a given code and locale.

• buildMessageReplaceVariables(String message, String musterRollName, String amount): Replaces variables in a message template with actual values.

Usage

Instantiate and configure the MusterRollNotificationService class within the application context to handle notifications related to muster rolls. Ensure that dependencies such as Kafka producer, configuration settings, and utility classes are properly injected.

• Package: org.egov.works.service

• Source File: MeasurementNotificationService.java

Overview

The MeasurementNotificationService class is responsible for processing notifications related to measurements within the eGov Works module. It handles the generation and sending of notifications to relevant personnel based on different actions performed on measurements, such as approval or rejection.

Attributes

1. mapper: ObjectMapper for JSON serialization/deserialization.

2. notificationServiceConfiguration: Configuration settings for notification services.

3. measurementServiceUtil: Utility class for measurement-related operations.

4. producer: Kafka producer for sending notifications.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic): Processes the incoming Kafka message containing measurement details and delegates the notification sending process to the appropriate method.

• sendNotification(MeasurementServiceRequest request): Sends notifications to relevant personnel based on the action performed on the measurement (e.g., approval, rejection).

• setAdditionalFields(MeasurementServiceRequest request, String localizationCode, Map<String, Object> additionalField): Sets additional fields for the notification if required.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalField, Map<String, String> smsDetails): Checks if additional fields are present and sends the SMS request accordingly.

• getCustomMessage(String message, String measurementNumber, String projectNumber): Replaces variables in a message template with actual measurement and project numbers.

• getMessage(MeasurementServiceRequest request, String msgCode): Retrieves the localized message for a given code and locale.

Usage

Instantiate and configure the MeasurementNotificationService class within the application context to handle notifications related to measurements. Ensure that dependencies such as ObjectMapper, configuration settings, and utility classes are properly injected.

• Package: org.egov.works.service

• Source File: IndividualNotificationService.java

Overview

The IndividualNotificationService class is responsible for managing notifications related to individual entities within the eGov Works module. It handles the generation and sending of notifications when individual entities are created or updated.

Attributes

1. config: NotificationServiceConfiguration for accessing configuration settings.

2. producer: Kafka producer for sending notifications.

3. repository: ServiceRequestRepository for fetching data from external services.

4. restTemplate: RestTemplate for making HTTP requests.

5. mapper: ObjectMapper for JSON serialization/deserialization.

Methods

• process(final String record, @Header(KafkaHeaders.RECEIVED_TOPIC) String topic, boolean isCreateOperation): Processes the incoming Kafka message containing individual details and delegates the notification sending process based on whether it's a create or update operation.

• sendNotification(IndividualRequest request, boolean isCreateOperation): Sends notifications for individual creation or update based on the boolean flag.

• pushNotificationForCreate(IndividualRequest request): Pushes notifications for individual creation to relevant parties.

• pushNotificationForUpdate(IndividualRequest request): Pushes notifications for individual update to relevant parties.

• getDetailsForSMS(IndividualRequest request): Retrieves details necessary for composing the SMS notification for individual creation or update.

• getMessageForCreate(IndividualRequest request): Retrieves the localized message for individual creation.

• getMessageForUpdate(IndividualRequest request): Retrieves the localized message for individual update.

• getMessage(IndividualRequest request, String msgCode): Retrieves the localized message for the specified code and locale.

• buildMessageForCreate(Map<String, String> userDetailsForSMS, String message): Builds the message for individual creation based on the provided user details.

• buildMessageForUpdate(Map<String, String> userDetailsForSMS, String message): Builds the message for individual updates based on the provided user details.

• getLocalisedMessages(RequestInfo requestInfo, String rootTenantId, String locale, String module): Fetches localized messages from the localization service based on the specified parameters.

• setAdditionalFields(IndividualRequest request, String localizationCode, Map<String, Object> additionalField): Sets additional fields for the notification if required.

• checkAdditionalFieldAndPushONSmsTopic(String customizedMessage, Map<String, Object> additionalField, Map<String, String> smsDetails): Checks if additional fields are present and push the SMS notification accordingly.

Usage

Instantiate and configure the IndividualNotificationService class within the application context to handle notifications related to individual entities. Ensure that dependencies such as NotificationServiceConfiguration, Kafka producer, ServiceRequestRepository, RestTemplate, and ObjectMapper are properly injected. Additionally, configure the methods to handle individual creation and update notifications as per the application's requirements.