com.dell.cpsd.common.rabbitmq.validators.GenericMessageValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-rabbitmq Show documentation
There is a newer version: 2.2.0
/**
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 */

package com.dell.cpsd.common.rabbitmq.validators;

import com.dell.cpsd.common.rabbitmq.i18n.error.LocalizedError;
import com.dell.cpsd.common.rabbitmq.i18n.error.LocalizedErrorCode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.dell.cpsd.common.rabbitmq.log.RabbitMQMessageCode.VALIDATION_INTERNAL_ERROR_E;
import static com.dell.cpsd.common.rabbitmq.log.RabbitMQMessageCode.VALIDATION_MESSAGE_IS_NULL_E;
import static com.dell.cpsd.common.rabbitmq.log.RabbitMQMessageCode.VALIDATION_PROPERTY_IS_NULL_E;
import static com.dell.cpsd.common.rabbitmq.log.RabbitMQMessageCode.VALIDATION_STRING_IS_EMPTY_E;
import static org.apache.commons.lang3.StringUtils.isBlank;

/**
 * Generic message validator.
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries.  All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @version 1.0
 */
public abstract class GenericMessageValidator implements MessageValidator
{
    private static final Logger LOGGER = LoggerFactory.getLogger(GenericMessageValidator.class);

    /**
     * Implementation of message validation.
     *
     * @param message          the request message
     * @param validationResult validation details to populate
     * @throws Exception the throwable
     */
    protected abstract void validateMessage(M message, ValidationResult validationResult) throws Exception;

    /**
     * Validate the message.
     * In case of internal exception, returns ValidationResult with error.
     *
     * @param message The message to be consumed
     */
    @Override
    public ValidationResult validate(M message)
    {
        if (message == null)
        {
            return failedValidationResult(VALIDATION_MESSAGE_IS_NULL_E);
        }

        try
        {
            ValidationResult result = new ValidationResult();
            validateMessage(message, result);
            return result;
        }
        catch (Exception e)
        {
            LocalizedError msg = VALIDATION_INTERNAL_ERROR_E.getLocalizedError(e.getMessage());
            LOGGER.error(msg.getMessage(), e);
            return failedValidationResult(msg);
        }
    }

    protected void validateNotNull(Object value, String property, ValidationResult validationResult)
    {
        if (value == null)
        {
            validationResult.addError(VALIDATION_PROPERTY_IS_NULL_E, property);
        }
    }

    protected void validateNotEmpty(String value, String property, ValidationResult validationResult)
    {
        if (isBlank(value))
        {
            validationResult.addError(VALIDATION_STRING_IS_EMPTY_E, property);
        }
    }

    @Deprecated
    protected ValidationResult failedValidationResult(String error)
    {
        ValidationResult result = new ValidationResult();
        result.addError(error);
        return result;
    }

    protected ValidationResult failedValidationResult(LocalizedError message)
    {
        ValidationResult result = new ValidationResult();
        result.addError(message);
        return result;
    }

    protected ValidationResult failedValidationResult(LocalizedErrorCode errorProvider, Object... params)
    {
        ValidationResult result = new ValidationResult();
        result.addError(errorProvider, params);
        return result;
    }
}