org.finra.herd.service.impl.MessageNotificationEventServiceImpl 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.impl;

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

import javax.xml.datatype.XMLGregorianCalendar;

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.api.xml.BusinessObjectDataKey;
import org.finra.herd.model.api.xml.BusinessObjectDefinitionDescriptionSuggestion;
import org.finra.herd.model.api.xml.BusinessObjectFormatKey;
import org.finra.herd.model.api.xml.UserNamespaceAuthorizationKey;
import org.finra.herd.model.dto.BusinessObjectDataStatusChangeNotificationEvent;
import org.finra.herd.model.dto.BusinessObjectDefinitionDescriptionSuggestionChangeNotificationEvent;
import org.finra.herd.model.dto.BusinessObjectFormatVersionChangeNotificationEvent;
import org.finra.herd.model.dto.ConfigurationValue;
import org.finra.herd.model.dto.NotificationMessage;
import org.finra.herd.model.dto.StorageUnitStatusChangeNotificationEvent;
import org.finra.herd.model.dto.UserNamespaceAuthorizationChangeNotificationEvent;
import org.finra.herd.model.jpa.NamespaceEntity;
import org.finra.herd.service.MessageNotificationEventService;
import org.finra.herd.service.helper.NotificationMessageInMemoryQueue;
import org.finra.herd.service.helper.notification.NotificationMessageManager;

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

    @Autowired
    private ConfigurationHelper configurationHelper;

    @Autowired
    private NotificationMessageManager notificationMessageManager;

    @Autowired
    private NotificationMessageInMemoryQueue notificationMessageInMemoryQueue;

    @Override
    public List processBusinessObjectDataStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey,
        String newBusinessObjectDataStatus, String oldBusinessObjectDataStatus)
    {
        return processNotificationMessages(notificationMessageManager.buildNotificationMessages(
            new BusinessObjectDataStatusChangeNotificationEvent(businessObjectDataKey, newBusinessObjectDataStatus, oldBusinessObjectDataStatus)));
    }

    @Override
    public List processBusinessObjectDefinitionDescriptionSuggestionChangeNotificationEvent(
        BusinessObjectDefinitionDescriptionSuggestion businessObjectDefinitionDescriptionSuggestion, String lastUpdatedByUserId,
        XMLGregorianCalendar lastUpdatedOn, NamespaceEntity namespaceEntity)
    {
        return processNotificationMessages(notificationMessageManager.buildNotificationMessages(
            new BusinessObjectDefinitionDescriptionSuggestionChangeNotificationEvent(businessObjectDefinitionDescriptionSuggestion, lastUpdatedByUserId,
                lastUpdatedOn, namespaceEntity.getCode())));
    }

    @Override
    public List processBusinessObjectFormatVersionChangeNotificationEvent(BusinessObjectFormatKey businessObjectFormatKey,
        String oldBusinessObjectFormatVersion)
    {
        return processNotificationMessages(notificationMessageManager
            .buildNotificationMessages(new BusinessObjectFormatVersionChangeNotificationEvent(businessObjectFormatKey, oldBusinessObjectFormatVersion)));
    }

    @Override
    public List processUserNamespaceAuthorizationChangeNotificationEvent(UserNamespaceAuthorizationKey userNamespaceAuthorizationKey)
    {
        return processNotificationMessages(
            notificationMessageManager.buildNotificationMessages(new UserNamespaceAuthorizationChangeNotificationEvent(userNamespaceAuthorizationKey)));
    }

    @Override
    public List processStorageUnitStatusChangeNotificationEvent(BusinessObjectDataKey businessObjectDataKey, String storageName,
        String newStorageUnitStatus, String oldStorageUnitStatus)
    {
        return processNotificationMessages(notificationMessageManager.buildNotificationMessages(
            new StorageUnitStatusChangeNotificationEvent(businessObjectDataKey, storageName, newStorageUnitStatus, oldStorageUnitStatus)));
    }

    /**
     * Processes a message by adding it to the "in-memory" queue for publishing by the advice.
     *
     * @param notificationMessages the list of notification messages, may be empty
     *
     * @return the list of notification messages that got queued for publishing
     */
    private List processNotificationMessages(final List notificationMessages)
    {
        // Create an empty result list.
        List result = new ArrayList<>();

        // Check if message notification is enabled.
        boolean herdNotificationEnabled = configurationHelper.getBooleanProperty(ConfigurationValue.HERD_NOTIFICATION_ENABLED);

        // Only process messages if the service is enabled.
        if (herdNotificationEnabled)
        {
            // Process the list of notification messages.
            for (NotificationMessage notificationMessage : notificationMessages)
            {
                // Add the message to the "in-memory" queue if a message was configured. Otherwise, log a warning.
                if (StringUtils.isNotBlank(notificationMessage.getMessageText()))
                {
                    notificationMessageInMemoryQueue.add(notificationMessage);
                    result.add(notificationMessage);
                }
                else
                {
                    LOGGER.warn("Not sending notification message because it is not configured. messageType={} messageDestination={}",
                        notificationMessage.getMessageType(), notificationMessage.getMessageDestination());
                }
            }
        }

        return result;
    }
}