SqsNotificationEventServiceImpl.java

/*
* 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.impl;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import org.finra.herd.core.helper.ConfigurationHelper;
import org.finra.herd.dao.config.DaoSpringModuleConfig;
import org.finra.herd.model.annotation.PublishJmsMessages;
import org.finra.herd.model.api.xml.BusinessObjectDataKey;
import org.finra.herd.model.dto.ConfigurationValue;
import org.finra.herd.model.dto.JmsMessage;
import org.finra.herd.service.SqsNotificationEventService;
import org.finra.herd.service.helper.JmsMessageInMemoryQueue;
import org.finra.herd.service.helper.SqsMessageBuilder;

/**
 * The SQS notification event service.
 */
@Service
@Transactional(value = DaoSpringModuleConfig.HERD_TRANSACTION_MANAGER_BEAN_NAME)
public class SqsNotificationEventServiceImpl implements SqsNotificationEventService
{
    private static final Logger LOGGER = LoggerFactory.getLogger(SqsNotificationEventServiceImpl.class);

    @Autowired
    private ConfigurationHelper configurationHelper;

    @Autowired
    private JmsMessageInMemoryQueue jmsMessageInMemoryQueue;

    @Autowired
    private SqsMessageBuilder sqsMessageBuilder;

    @Override
    public JmsMessage processBusinessObjectDataStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String newBusinessObjectDataStatus,
        String oldBusinessObjectDataStatus)
    {
        return processMessage(
            sqsMessageBuilder.buildBusinessObjectDataStatusChangeMessage(businessObjectDataKey, newBusinessObjectDataStatus, oldBusinessObjectDataStatus),
            "business object data status change");
    }

    @PublishJmsMessages
    @Override
    public JmsMessage processSystemMonitorNotificationEvent(String systemMonitorRequestPayload)
    {
        return processMessage(sqsMessageBuilder.buildSystemMonitorResponse(systemMonitorRequestPayload), "system monitor response");
    }

    /**
     * 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.HERD_NOTIFICATION_SQS_OUTGOING_QUEUE_NAME);

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

        return sqsQueueName;
    }

    /**
     * Checks if herd SQS notification is enabled.
     *
     * @return true if herd SQS notification is enabled, false otherwise
     */
    private boolean isHerdSqsNotificationEnabled()
    {
        return Boolean.valueOf(configurationHelper.getProperty(ConfigurationValue.HERD_NOTIFICATION_SQS_ENABLED));
    }

    /**
     * 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
     * @param messageName the message name. This is a description of the message that is being processed
     *
     * @return the JMS message entity that got saved.
     */
    private JmsMessage processMessage(String messageText, String messageName)
    {
        JmsMessage jmsMessage = null;

        boolean herdSqsNotificationEnabled = isHerdSqsNotificationEnabled();

        LOGGER.debug(String.format("herdSqsNotificationEnabled: %s, messageName: %s, messageText:%n%s", herdSqsNotificationEnabled, messageName, messageText));

        // Only process messages if the service is enabled.
        if (herdSqsNotificationEnabled)
        {
            // Add the message to the database queue if a message was configured. Otherwise, log a warning.
            if (StringUtils.isBlank(messageText))
            {
                LOGGER.warn("Not sending \"" + messageName + "\" message because it is not configured.");
            }
            else
            {
                // Add the JMS message to the "in-memory" JMS message queue to be published by the advice.
                jmsMessage = new JmsMessage(getSqsQueueName(), messageText);
                jmsMessageInMemoryQueue.add(jmsMessage);
            }
        }

        return jmsMessage;
    }
}