org.mule.extension.validation.internal

Class CommonValidationOperations

java.lang.Object

org.mule.extension.validation.internal.CommonValidationOperations

@Validator
public final class CommonValidationOperations
extends Object

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

Since:

1.0

See Also:

ValidationExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_GROUP
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
CommonValidationOperations()

Method Summary

Modifier and Type	Method and Description
protected ValidationContext	createContext(ValidationOptions options, ValidationExtension config)
void	isBlankString(String value, ValidationOptions options, ValidationExtension config) Validates that value is a blank String.
void	isElapsed(Long time, TimeUnit timeUnit, LocalDateTime since, ValidationOptions options, ValidationExtension config) Validates the amount of time that has elapsed since the moment in the since parameter is greater than an specified amount of time.
void	isEmail(String email, ValidationOptions options, ValidationExtension config) Validates that the email address is valid
void	isEmptyCollection(Collection<Object> values, ValidationOptions options, ValidationExtension config) Validates that value is an empty collection.
void	isFalse(boolean expression, ValidationOptions options, ValidationExtension config) Validates that the given value is false
void	isIp(String ip, ValidationOptions options, ValidationExtension config) Validates that an ip address represented as a String is valid
void	isNotBlacklistedIp(String ipAddress, IpFilterList blackList, ValidationOptions options, ValidationExtension config) Validates that a ipAddress is not present in the ipList.
void	isNotBlankString(String value, ValidationOptions options, ValidationExtension config) Validates that value is not a blank String.
void	isNotElapsed(Long time, TimeUnit timeUnit, LocalDateTime since, ValidationOptions options, ValidationExtension config) Validates the amount of time that has elapsed since the moment in the since parameter is greater than an specified amount of time.
void	isNotEmptyCollection(Collection<Object> values, ValidationOptions options, ValidationExtension config) Validates that value is not an empty collection.
void	isNotNull(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<Object> value, ValidationOptions options, ValidationExtension config) Validates that the given value is not null.
void	isNull(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<Object> value, ValidationOptions options, ValidationExtension config) Validates that the given value is null.
void	isTime(String time, String locale, String pattern, ValidationOptions options, ValidationExtension config) Validates that a time in String format is valid for the given pattern and locale.
void	isTrue(boolean expression, ValidationOptions options, ValidationExtension config) Validates that the given value is true
void	isUrl(String url, ValidationOptions options, ValidationExtension config) Validates that url is a valid one
void	isWhitelistedIp(String ipAddress, IpFilterList whiteList, ValidationOptions options, ValidationExtension config) Validates that a ipAddress is present in the ipList.
protected void	logSuccessfulValidation(Validator validator)
void	matchesRegex(String value, String regex, boolean caseSensitive, ValidationOptions options, 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, ValidationExtension config) Validates that value has a size between certain inclusive boundaries.
protected void	validateWith(Validator validator, ValidationContext validationContext)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_GROUP

protected static final String ERROR_GROUP

See Also:

Constant Field Values

LOGGER

protected static final org.slf4j.Logger LOGGER

Constructor Detail

CommonValidationOperations

public CommonValidationOperations()

Method Detail

isTrue

@Throws(value=BooleanErrorType.class)
public void isTrue(boolean expression,
                                                         @ParameterGroup(name="Error options")
                                                         ValidationOptions options,
                                                         @Config
                                                         ValidationExtension config)
                                                  throws Exception

Validates that the given value is true

Parameters:

expression - the boolean to test

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception - if the value is not true

isFalse

@Throws(value=BooleanErrorType.class)
public void isFalse(boolean expression,
                                                          @ParameterGroup(name="Error options")
                                                          ValidationOptions options,
                                                          @Config
                                                          ValidationExtension config)
                                                   throws Exception

Validates that the given value is false

Parameters:

expression - the boolean to test

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception - if the value is not true

isEmail

@Throws(value=EmailErrorType.class)
public void isEmail(String email,
                                                        @ParameterGroup(name="Error options")
                                                        ValidationOptions options,
                                                        @Config
                                                        ValidationExtension config)
                                                 throws Exception

Validates that the email address is valid

Parameters:

email - an email address

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isIp

@DisplayName(value="Is IP")
 @Throws(value=IpErrorType.class)
public void isIp(String ip,
                                                                               @ParameterGroup(name="Error options")
                                                                               ValidationOptions options,
                                                                               @Config
                                                                               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

config - the current ValidationExtension that serves as config

Throws:

Exception

validateSize

@Throws(value=SizeErrorType.class)
public void validateSize(Object value,
                                                            @Optional(defaultValue="0")
                                                            int min,
                                                            @Optional
                                                            Integer max,
                                                            @ParameterGroup(name="Error options")
                                                            ValidationOptions options,
                                                            @Config
                                                            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

config - the current ValidationExtension that serves as config

Throws:

Exception

isNotBlankString

@Throws(value=BlankErrorType.class)
public void isNotBlankString(@Optional(defaultValue="#[payload]")
                                                                 String value,
                                                                 @ParameterGroup(name="Error options")
                                                                 ValidationOptions options,
                                                                 @Config
                                                                 ValidationExtension config)
                                                          throws Exception

Validates that value is not a blank String.

Parameters:

value - the String to check

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isNotEmptyCollection

@Throws(value=EmptyErrorType.class)
public void isNotEmptyCollection(@Optional(defaultValue="#[payload]")
                                                                     Collection<Object> values,
                                                                     @ParameterGroup(name="Error options")
                                                                     ValidationOptions options,
                                                                     @Config
                                                                     ValidationExtension config)
                                                              throws Exception

Validates that value is not an empty collection.

Parameters:

values - the value to check

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isBlankString

@Throws(value=NotBlankErrorType.class)
public void isBlankString(String value,
                                                                 @ParameterGroup(name="Error options")
                                                                 ValidationOptions options,
                                                                 @Config
                                                                 ValidationExtension config)
                                                          throws Exception

Validates that value is a blank String.

Parameters:

value - the value to check

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isEmptyCollection

@Throws(value=NotEmptyErrorType.class)
public void isEmptyCollection(@Optional(defaultValue="#[payload]")
                                                                     Collection<Object> values,
                                                                     @ParameterGroup(name="Error options")
                                                                     ValidationOptions options,
                                                                     @Config
                                                                     ValidationExtension config)
                                                              throws Exception

Validates that value is an empty collection.

Parameters:

values - the value to check

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isNotNull

@Throws(value=NullErrorType.class)
public void isNotNull(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<Object> value,
                                                         @ParameterGroup(name="Error options")
                                                         ValidationOptions options,
                                                         @Config
                                                         ValidationExtension config)
                                                  throws Exception

Validates that the given value is not null.

Parameters:

value - the value to test

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isNull

@Throws(value=NotNullErrorType.class)
public void isNull(org.mule.runtime.extension.api.runtime.parameter.ParameterResolver<Object> value,
                                                         @ParameterGroup(name="Error options")
                                                         ValidationOptions options,
                                                         @Config
                                                         ValidationExtension config)
                                                  throws Exception

Validates that the given value is null.

Parameters:

value - the value to test

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

isTime

@Throws(value=TimeErrorType.class)
public void isTime(String time,
                                                      @Optional
                                                      String locale,
                                                      @Optional
                                                      String pattern,
                                                      @ParameterGroup(name="Error options")
                                                      ValidationOptions options,
                                                      @Config
                                                      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

config - the current ValidationExtension that serves as config

Throws:

Exception

isElapsed

@Throws(value=NotElapsedErrorType.class)
public void isElapsed(Long time,
                                                               TimeUnit timeUnit,
                                                               LocalDateTime since,
                                                               @ParameterGroup(name="Error options")
                                                               ValidationOptions options,
                                                               @Config
                                                               ValidationExtension config)
                                                        throws Exception

Validates the amount of time that has elapsed since the moment in the since parameter is greater than an specified amount of time.

Parameters:

time - the interval size

timeUnit - the interval unit (as a TimeUnit)

since - the time to validate

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

Since:

1.1

isNotElapsed

@Throws(value=ElapsedErrorType.class)
public void isNotElapsed(Long time,
                                                               TimeUnit timeUnit,
                                                               LocalDateTime since,
                                                               @ParameterGroup(name="Error options")
                                                               ValidationOptions options,
                                                               @Config
                                                               ValidationExtension config)
                                                        throws Exception

Validates the amount of time that has elapsed since the moment in the since parameter is greater than an specified amount of time.

Parameters:

time - the interval size

timeUnit - the interval unit (as a TimeUnit)

since - the time to validate

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

Since:

1.1

isUrl

@DisplayName(value="Is URL")
 @Throws(value=UrlErrorType.class)
public void isUrl(@DisplayName(value="URL")
                                                                                  String url,
                                                                                  @ParameterGroup(name="Error options")
                                                                                  ValidationOptions options,
                                                                                  @Config
                                                                                  ValidationExtension config)
                                                                           throws Exception

Validates that url is a valid one

Parameters:

url - the URL to validate as a String

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

matchesRegex

@Throws(value=RegexErrorType.class)
public void matchesRegex(String value,
                                                             String regex,
                                                             @Optional(defaultValue="true")
                                                             boolean caseSensitive,
                                                             @ParameterGroup(name="Error options")
                                                             ValidationOptions options,
                                                             @Config
                                                             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

config - the current ValidationExtension that serves as config

Throws:

Exception

isWhitelistedIp

@Throws(value={IpErrorType.class,IpFilterErrorType.class})
public void isWhitelistedIp(String ipAddress,
                                                                                       IpFilterList whiteList,
                                                                                       @ParameterGroup(name="Error options")
                                                                                       ValidationOptions options,
                                                                                       @Config
                                                                                       ValidationExtension config)
                                                                                throws Exception

Validates that a ipAddress is present in the ipList.

Parameters:

ipAddress - the address to validate

whiteList - the list of allowed addresses

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

Since:

1.1

isNotBlacklistedIp

@Throws(value={IpErrorType.class,IpFilterErrorType.class})
public void isNotBlacklistedIp(String ipAddress,
                                                                                          IpFilterList blackList,
                                                                                          @ParameterGroup(name="Error options")
                                                                                          ValidationOptions options,
                                                                                          @Config
                                                                                          ValidationExtension config)
                                                                                   throws Exception

Validates that a ipAddress is not present in the ipList.

Parameters:

ipAddress - the address to validate

blackList - the list of disallowed addresses

options - the ValidationOptions

config - the current ValidationExtension that serves as config

Throws:

Exception

Since:

1.1

validateWith

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

Throws:

Exception

createContext

protected ValidationContext createContext(ValidationOptions options,
                                          ValidationExtension config)

parseLocale

protected Locale parseLocale(String locale)

logSuccessfulValidation

protected void logSuccessfulValidation(Validator validator)