org.finra.herd.service.helper.SearchIndexUpdateHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of herd-service Show documentation
This project contains the business service code. This is a classic service tier where business logic is defined along with it's associated transaction management configuration.
There is a newer version: 0.160.0
Show newest version
/*
* Copyright 2015 herd contributors
*
* Licensed 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.
*/
package org.finra.herd.service.helper;

import static org.finra.herd.model.dto.SearchIndexUpdateDto.MESSAGE_TYPE_BUSINESS_OBJECT_DEFINITION_UPDATE;
import static org.finra.herd.model.dto.SearchIndexUpdateDto.MESSAGE_TYPE_TAG_UPDATE;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;
import org.quartz.ObjectAlreadyExistsException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import org.finra.herd.core.helper.ConfigurationHelper;
import org.finra.herd.dao.helper.JsonHelper;
import org.finra.herd.model.dto.ConfigurationValue;
import org.finra.herd.model.dto.NotificationMessage;
import org.finra.herd.model.dto.SearchIndexUpdateDto;
import org.finra.herd.model.jpa.BusinessObjectDefinitionEntity;
import org.finra.herd.model.jpa.MessageTypeEntity;
import org.finra.herd.model.jpa.TagEntity;
import org.finra.herd.service.NotificationMessagePublishingService;
import org.finra.herd.service.systemjobs.JmsPublishingJob;

/**
 * SearchIndexUpdateHelper class contains helper methods needed to process a search index update.
 */
@Component
public class SearchIndexUpdateHelper
{
    private static final Logger LOGGER = LoggerFactory.getLogger(SearchIndexUpdateHelper.class);

    @Autowired
    private ConfigurationHelper configurationHelper;

    @Autowired
    private JsonHelper jsonHelper;

    @Autowired
    private NotificationMessagePublishingService notificationMessagePublishingService;

    @Autowired
    private SystemJobHelper systemJobHelper;

    /**
     * Modify a business object definition
     *
     * @param businessObjectDefinitionEntity the business object definition entity to modify
     * @param modificationType the type of modification
     */
    public void modifyBusinessObjectDefinitionInSearchIndex(BusinessObjectDefinitionEntity businessObjectDefinitionEntity, String modificationType)
    {
        List businessObjectDefinitionIds = new ArrayList<>();
        businessObjectDefinitionIds.add(businessObjectDefinitionEntity.getId());
        processMessage(
            jsonHelper.objectToJson(new SearchIndexUpdateDto(MESSAGE_TYPE_BUSINESS_OBJECT_DEFINITION_UPDATE, businessObjectDefinitionIds, modificationType)));
    }

    /**
     * Modify a list of business object definitions
     *
     * @param businessObjectDefinitionEntityList the business object definition entities to modify
     * @param modificationType the type of modification
     */
    public void modifyBusinessObjectDefinitionsInSearchIndex(List businessObjectDefinitionEntityList, String modificationType)
    {
        List businessObjectDefinitionIds = new ArrayList<>();
        businessObjectDefinitionEntityList.forEach(businessObjectDefinitionEntity -> businessObjectDefinitionIds.add(businessObjectDefinitionEntity.getId()));
        processMessage(
            jsonHelper.objectToJson(new SearchIndexUpdateDto(MESSAGE_TYPE_BUSINESS_OBJECT_DEFINITION_UPDATE, businessObjectDefinitionIds, modificationType)));
    }

    /**
     * Modify a tag
     *
     * @param tagEntity the tag entity to modify
     * @param modificationType the type of modification
     */
    public void modifyTagInSearchIndex(TagEntity tagEntity, String modificationType)
    {
        List tagIds = new ArrayList<>();
        tagIds.add(tagEntity.getId());
        processMessage(jsonHelper.objectToJson(new SearchIndexUpdateDto(MESSAGE_TYPE_TAG_UPDATE, tagIds, modificationType)));
    }

    /**
     * Modify a list of tags
     *
     * @param tagEntityList the tag entities to modify
     * @param modificationType the type of modification
     */
    public void modifyTagsInSearchIndex(List tagEntityList, String modificationType)
    {
        List tagIds = new ArrayList<>();
        tagEntityList.forEach(tagEntity -> tagIds.add(tagEntity.getId()));
        processMessage(jsonHelper.objectToJson(new SearchIndexUpdateDto(MESSAGE_TYPE_TAG_UPDATE, tagIds, modificationType)));
    }

    /**
     * Returns the SQS queue name. Throws {@link IllegalStateException} if SQS queue name is undefined.
     *
     * @return the sqs queue name
     */
    private String getSqsQueueName()
    {
        String sqsQueueName = configurationHelper.getProperty(ConfigurationValue.SEARCH_INDEX_UPDATE_SQS_QUEUE_NAME);

        if (StringUtils.isBlank(sqsQueueName))
        {
            throw new IllegalStateException(String.format("SQS queue name not found. Ensure the \"%s\" configuration entry is configured.",
                ConfigurationValue.SEARCH_INDEX_UPDATE_SQS_QUEUE_NAME.getKey()));
        }

        return sqsQueueName;
    }

    /**
     * Processes a message by adding it to the database "queue" table to ultimately be placed on the real queue by a separate job.
     *
     * @param messageText the message text to place on the queue
     */
    private void processMessage(String messageText)
    {
        boolean isSearchIndexUpdateSqsNotificationEnabled =
            Boolean.valueOf(configurationHelper.getProperty(ConfigurationValue.SEARCH_INDEX_UPDATE_JMS_LISTENER_ENABLED));

        LOGGER.info("searchIndexUpdateSqsNotificationEnabled={} messageText={}", isSearchIndexUpdateSqsNotificationEnabled, messageText);

        // Only process messages if the service is enabled.
        if (isSearchIndexUpdateSqsNotificationEnabled)
        {
            // Add the message to the database queue if a message was configured. Otherwise, log a warning.
            if (StringUtils.isBlank(messageText))
            {
                LOGGER.warn("Not sending search index update message because it is not configured.");
            }
            else
            {
                NotificationMessage notificationMessage =
                    new NotificationMessage(MessageTypeEntity.MessageEventTypes.SQS.name(), getSqsQueueName(), messageText, null);

                // Add the notification message to the database JMS message queue to be processed.
                notificationMessagePublishingService.addNotificationMessageToDatabaseQueue(notificationMessage);

                // Schedule JMS publishing job.
                try
                {
                    systemJobHelper.runSystemJob(JmsPublishingJob.JOB_NAME, null);
                }
                catch (ObjectAlreadyExistsException objectAlreadyExistsException)
                {
                    // Ignore the error when job is already running.
                    LOGGER.info("Failed to schedule JMS publishing job: ObjectAlreadyExistsException occurred");
                }
                catch (Exception e)
                {
                    LOGGER.error("Failed to schedule JMS publishing job.", e);
                }
            }
        }
    }
}