org.mule.extension.validation.internal

Class CommonValidationOperations

java.lang.Object

org.mule.extension.validation.internal.CommonValidationOperations

public final class CommonValidationOperations
extends Object

Defines the operations of ValidationExtension which executes the Validators that the extension provides out of the box

Since:

3.7.0

See Also:

ValidationExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
CommonValidationOperations()

Method Summary

Modifier and Type	Method and Description
protected ValidationContext	createContext(ValidationOptions options, MuleEvent muleEvent, ValidationExtension config)
void	isEmail(String email, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that the email address is valid
void	isEmpty(Object value, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that value is empty.
void	isFalse(boolean expression, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that the given value is false
void	isIp(String ip, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that an ip address represented as a String is valid
void	isNotEmpty(Object value, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that value is not empty.
void	isNotNull(Object value, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that the given value is not null nor an instance of NullPayload
void	isNull(Object value, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that the given value is null or an instance of NullPayload
void	isTime(String time, String locale, String pattern, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that a time in String format is valid for the given pattern and locale.
void	isTrue(boolean expression, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that the given value is true
void	isUrl(String url, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that url is a valid one
protected void	logSuccessfulValidation(Validator validator, MuleEvent event)
void	matchesRegex(String value, String regex, boolean caseSensitive, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that value matches the regex regular expression
protected Locale	parseLocale(String locale)
void	validateSize(Object value, int min, Integer max, ValidationOptions options, MuleEvent event, ValidationExtension config) Validates that value has a size between certain inclusive boundaries.
protected void	validateWith(Validator validator, ValidationContext validationContext, MuleEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

CommonValidationOperations

public CommonValidationOperations()

Method Detail

isTrue

@Operation
public void isTrue(boolean expression,
                              @ParameterGroup
                              ValidationOptions options,
                              MuleEvent event,
                              @UseConfig
                              ValidationExtension config)
                       throws Exception

Validates that the given value is true

Parameters:

expression - the boolean to test

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception - if the value is not true

isFalse

@Operation
public void isFalse(boolean expression,
                               @ParameterGroup
                               ValidationOptions options,
                               MuleEvent event,
                               @UseConfig
                               ValidationExtension config)
                        throws Exception

Validates that the given value is false

Parameters:

expression - the boolean to test

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception - if the value is not true

isEmail

@Operation
public void isEmail(String email,
                               @ParameterGroup
                               ValidationOptions options,
                               MuleEvent event,
                               @UseConfig
                               ValidationExtension config)
                        throws Exception

Validates that the email address is valid

Parameters:

email - an email address

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

isIp

@Operation
public void isIp(String ip,
                            @ParameterGroup
                            ValidationOptions options,
                            MuleEvent event,
                            @UseConfig
                            ValidationExtension config)
                     throws Exception

Validates that an ip address represented as a String is valid

Parameters:

ip - the ip address to validate

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

validateSize

@Operation
public void validateSize(Object value,
                                    @Optional(defaultValue="0")
                                    int min,
                                    @Optional
                                    Integer max,
                                    @ParameterGroup
                                    ValidationOptions options,
                                    MuleEvent event,
                                    @UseConfig
                                    ValidationExtension config)
                             throws Exception

Validates that value has a size between certain inclusive boundaries. This validator is capable of handling instances of String, Collection, Map and arrays

Parameters:

value - the value to validate

min - the minimum expected length (inclusive, defaults to zero)

max - the maximum expected length (inclusive). Leave unspecified or null to allow any max length

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

isNotEmpty

@Operation
public void isNotEmpty(Object value,
                                  @ParameterGroup
                                  ValidationOptions options,
                                  MuleEvent event,
                                  @UseConfig
                                  ValidationExtension config)
                           throws Exception

Validates that value is not empty. The definition of empty depends on the type of value. If it's a String it will check that it is not blank. If it's a Collection, array or Map it will check that it's not empty. No other types are supported, an IllegalArgumentException will be thrown if any other type is supplied

Parameters:

value - the value to check

options - the ValidationOptions

event - the current {@link MuleEvent

config - the current ValidationExtension that serves as config

Throws:

IllegalArgumentException - if value is something other than a String,Collection or Map

Exception

isEmpty

@Operation
public void isEmpty(Object value,
                               @ParameterGroup
                               ValidationOptions options,
                               MuleEvent event,
                               @UseConfig
                               ValidationExtension config)
                        throws Exception

Validates that value is empty. The definition of empty depends on the type of value. If it's a String it will check that it is not blank. If it's a Collection, array or Map it will check that it's not empty. No other types are supported, an IllegalArgumentException will be thrown if any other type is supplied

Parameters:

value - the value to check

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

IllegalArgumentException - if value is something other than a String,Collection or Map

Exception

isNotNull

@Operation
public void isNotNull(Object value,
                                 @ParameterGroup
                                 ValidationOptions options,
                                 MuleEvent event,
                                 @UseConfig
                                 ValidationExtension config)
                          throws Exception

Validates that the given value is not null nor an instance of NullPayload

Parameters:

value - the value to test

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

isNull

@Operation
public void isNull(Object value,
                              @ParameterGroup
                              ValidationOptions options,
                              MuleEvent event,
                              @UseConfig
                              ValidationExtension config)
                       throws Exception

Validates that the given value is null or an instance of NullPayload

Parameters:

value - the value to test

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

isTime

@Operation
public void isTime(String time,
                              @Optional
                              String locale,
                              @Optional
                              String pattern,
                              @ParameterGroup
                              ValidationOptions options,
                              MuleEvent event,
                              @UseConfig
                              ValidationExtension config)
                       throws Exception

Validates that a time in String format is valid for the given pattern and locale. If no pattern is provided, then the locale's default will be used

Parameters:

time - A date in String format

locale - the locale of the String

pattern - the pattern for the date

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

isUrl

@Operation
public void isUrl(String url,
                             @ParameterGroup
                             ValidationOptions options,
                             MuleEvent event,
                             @UseConfig
                             ValidationExtension config)
                      throws Exception

Validates that url is a valid one

Parameters:

url - the URL to validate as a String

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

matchesRegex

@Operation
public void matchesRegex(String value,
                                    String regex,
                                    @Optional(defaultValue="true")
                                    boolean caseSensitive,
                                    @ParameterGroup
                                    ValidationOptions options,
                                    MuleEvent event,
                                    @UseConfig
                                    ValidationExtension config)
                             throws Exception

Validates that value matches the regex regular expression

Parameters:

value - the value to check

regex - the regular expression to check against

caseSensitive - when true matching is case sensitive, otherwise matching is case in-sensitive

options - the ValidationOptions

event - the current MuleEvent

config - the current ValidationExtension that serves as config

Throws:

Exception

validateWith

protected void validateWith(Validator validator,
                            ValidationContext validationContext,
                            MuleEvent event)
                     throws Exception

Throws:

Exception

createContext

protected ValidationContext createContext(ValidationOptions options,
                                          MuleEvent muleEvent,
                                          ValidationExtension config)

parseLocale

protected Locale parseLocale(String locale)

logSuccessfulValidation

protected void logSuccessfulValidation(Validator validator,
                                       MuleEvent event)