org.mule.extension.validation.internal.CustomValidatorOperation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-validation Show documentation
A Mule extension that provides functionality for performing validations
The newest version!
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.extension.validation.internal;

import org.mule.api.MuleEvent;
import org.mule.api.registry.MuleRegistry;
import org.mule.extension.annotations.Operation;
import org.mule.extension.annotations.ParameterGroup;
import org.mule.extension.annotations.param.UseConfig;
import org.mule.extension.introspection.declaration.fluent.Descriptor;
import org.mule.extension.validation.api.Validator;

import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;

/**
 * Defines a stateful operation of {@link ValidationExtension} which
 * is capable of executing custom validators provided by a
 * third party. The {@link Validator} can be provided via a {@link ObjectSource}
 * which means that the user could have specified either a classname or a
 * named reference to it.
 * 
 * If the user provided a classname, then the {@link Class} that it represents
 * is expected to have a default public {@link Descriptor} which can be used to
 * instantiate it.
 * 

 * If the {@link Validator} is provided via a reference, then a lookup
 * to the {@link MuleRegistry} will be performed.
 * 
 * In either case, the referenced {@link Validator} is expected to be reusable
 * and thread-safe. If you used a reference, then that reference will most likely
 * always point to the same instance. If you use a class, then an instance will be
 * created and reused.
 *
 * @since 3.7.0
 */
public final class CustomValidatorOperation extends ValidationSupport
{

    private final LoadingCache class2ValidatorCache = CacheBuilder.newBuilder().build(new CacheLoader()
    {
        @Override
        public Validator load(ValidatorSource validatorSource) throws Exception
        {
            return validatorSource.createValidator();
        }
    });

    @Operation
    public void customValidator(@ParameterGroup ObjectSource source,
                                @ParameterGroup ValidationOptions options,
                                MuleEvent event,
                                @UseConfig ValidationExtension config) throws Exception
    {
        ValidatorSource validatorSource = new ValidatorSource(source.getType(), source.getRef());
        Validator validator = validatorSource.getObject(event.getMuleContext());
        event.getMuleContext().getRegistry().applyProcessors(validator);

        validateWith(validator, createContext(options, event, config), event);
    }

    @Override
    protected void logSuccessfulValidation(Validator validator, MuleEvent event)
    {
        if (logger.isDebugEnabled())
        {
            logger.debug("Successfully executed custom validator of type {} on message: {}", validator.getClass().getName(), event.getMessage());
        }
    }

    private class ValidatorSource extends ObjectSource
    {

        public ValidatorSource(String type, String ref)
        {
            super(type, ref);
        }

        @Override
        protected Validator doGetByClassName()
        {
            return class2ValidatorCache.getUnchecked(this);
        }

        private Validator createValidator()
        {
            return super.doGetByClassName();
        }

        @Override
        public boolean equals(Object obj)
        {
            if (obj instanceof ValidatorSource)
            {
                return getType().equals(((ValidatorSource) obj).getType());
            }

            return false;
        }

        @Override
        public int hashCode()
        {
            return getType().hashCode();
        }
    }
}