org.mule.extension.validation.internal.CommonValidationOperations Maven / Gradle / Ivy
/*
* 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.extension.annotations.ImplementationOf;
import org.mule.extension.annotations.Operation;
import org.mule.extension.annotations.ParameterGroup;
import org.mule.extension.annotations.param.Optional;
import org.mule.extension.validation.api.Validator;
import org.mule.extension.validation.internal.validator.BooleanValidator;
import org.mule.extension.validation.internal.validator.EmailValidator;
import org.mule.extension.validation.internal.validator.EmptyValidator;
import org.mule.extension.validation.internal.validator.IpValidator;
import org.mule.extension.validation.internal.validator.MatchesRegexValidator;
import org.mule.extension.validation.internal.validator.NotEmptyValidator;
import org.mule.extension.validation.internal.validator.NotNullValidator;
import org.mule.extension.validation.internal.validator.NullValidator;
import org.mule.extension.validation.internal.validator.SizeValidator;
import org.mule.extension.validation.internal.validator.TimeValidator;
import org.mule.extension.validation.internal.validator.UrlValidator;
import org.mule.transport.NullPayload;
import java.util.Collection;
import java.util.Map;
/**
* Defines the operations of {@link ValidationExtension}
* which executes the {@link Validator}s that the extension
* provides out of the box
*
* @see ValidationExtension
* @since 3.7.0
*/
@ImplementationOf(ValidationExtension.class)
public final class CommonValidationOperations extends ValidationSupport
{
public CommonValidationOperations(ValidationExtension config)
{
super(config);
}
/**
* Validates that the given {@code value} is {@code true}
*
* @param expression the boolean to test
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
* @throws Exception if the value is not {@code true}
*/
@Operation
public void isTrue(boolean expression, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new BooleanValidator(expression, true, context), context, event);
}
/**
* Validates that the given {@code value} is {@code false}
*
* @param expression the boolean to test
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
* @throws Exception if the value is not {@code true}
*/
@Operation
public void isFalse(boolean expression, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new BooleanValidator(expression, false, context), context, event);
}
/**
* Validates that the {@code email} address is valid
*
* @param email an email address
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isEmail(String email, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new EmailValidator(email, context), context, event);
}
/**
* Validates that an {@code ip} address represented as a {@link String} is valid
*
* @param ip the ip address to validate
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isIp(String ip, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new IpValidator(ip, context), context, event);
}
/**
* Validates that {@code value} has a size between certain inclusive boundaries. This
* validator is capable of handling instances of {@link String}, {@link Collection},
* {@link Map} and arrays
*
* @param value the value to validate
* @param min the minimum expected length (inclusive, defaults to zero)
* @param max the maximum expected length (inclusive). Leave unspecified or {@code null} to allow any max length
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void validateSize(Object value,
@Optional(defaultValue = "0") int min,
@Optional Integer max,
@ParameterGroup ValidationOptions options,
MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new SizeValidator(value, min, max, context), context, event);
}
/**
* Validates that {@code value} is not empty. The definition of empty depends on
* the type of {@code value}. If it's a {@link String} it will check that it is not blank.
* If it's a {@link Collection}, array or {@link Map} it will check that it's not empty. No other types
* are supported, an {@link IllegalArgumentException} will be thrown if any other type is supplied
*
* @param value the value to check
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
* @throws IllegalArgumentException if {@code value} is something other than a {@link String},{@link Collection} or {@link Map}
*/
@Operation
public void isNotEmpty(Object value, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new NotEmptyValidator(value, context), context, event);
}
/**
* Validates that {@code value} is empty. The definition of empty depends on
* the type of {@code value}. If it's a {@link String} it will check that it is not blank.
* If it's a {@link Collection}, array or {@link Map} it will check that it's not empty. No other types
* are supported, an {@link IllegalArgumentException} will be thrown if any other type is supplied
*
* @param value the value to check
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent}
* @throws IllegalArgumentException if {@code value} is something other than a {@link String},{@link Collection} or {@link Map}
*/
@Operation
public void isEmpty(Object value, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new EmptyValidator(value, context), context, event);
}
/**
* Validates that the given {@code value} is not {@code null} nor
* an instance of {@link NullPayload}
*
* @param value the value to test
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isNotNull(Object value, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new NotNullValidator(value, context), context, event);
}
/**
* Validates that the given {@code value} is {@code null} or
* an instance of {@link NullPayload}
*
* @param value the value to test
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isNull(Object value, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new NullValidator(value, context), context, event);
}
/**
* Validates that a {@code time} in {@link String} format is valid for the given {@code pattern} and {@code locale}.
* If no pattern is provided, then the {@code locale}'s default will be used
*
* @param time A date in String format
* @param locale the locale of the String
* @param pattern the pattern for the {@code date}
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isTime(String time,
@Optional String locale,
@Optional String pattern,
@ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new TimeValidator(time, nullSafeLocale(locale), pattern, context), context, event);
}
/**
* Validates that {@code url} is a valid one
*
* @param url the URL to validate as a {@link String}
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void isUrl(String url, @ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new UrlValidator(url, context), context, event);
}
/**
* Validates that {@code value} matches the {@code regex} regular expression
*
* @param value the value to check
* @param regex the regular expression to check against
* @param caseSensitive when {@code true} matching is case sensitive, otherwise matching is case in-sensitive
* @param options the {@link ValidationOptions}
* @param event the current {@link MuleEvent
*/
@Operation
public void matchesRegex(String value,
String regex,
@Optional(defaultValue = "true") boolean caseSensitive,
@ParameterGroup ValidationOptions options, MuleEvent event) throws Exception
{
ValidationContext context = createContext(options, event);
validateWith(new MatchesRegexValidator(value, regex, caseSensitive, context), context, event);
}
private String nullSafeLocale(String locale)
{
return locale == null ? ValidationExtension.DEFAULT_LOCALE : locale;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy