net.sf.oval.constraint
Class AssertURLCheck

java.lang.Object
  net.sf.oval.AbstractCheck
      net.sf.oval.configuration.annotation.AbstractAnnotationCheck<AssertURL>
          net.sf.oval.constraint.AssertURLCheck

All Implemented Interfaces:

Serializable, Check, AnnotationCheck<AssertURL>

public class AssertURLCheck
extends AbstractAnnotationCheck<AssertURL>

Author:

Sebastian Thomschke

See Also:

Serialized Form

Nested Class Summary

static class

AssertURLCheck.URIScheme http://en.wikipedia.org/wiki/URI_scheme

Constructor Summary

AssertURLCheck()

Method Summary

void	configure(AssertURL constraintAnnotation) Configures the check based on the given constraint annotation.
protected ConstraintTarget[]	getAppliesToDefault()
AssertURLCheck.URIScheme[]	getPermittedURISchemes() Gets the allowed URL schemes.
boolean	isConnect() Specifies if a connection to the URL should be attempted to verify its validity.
boolean	isSatisfied(Object validatedObject, Object valueToValidate, OValContext context, Validator validator) This method implements the validation logic
void	setConnect(boolean connect) Specifies if a connection to the URL should be attempted to verify its validity.
void	setPermittedURISchemes(AssertURLCheck.URIScheme[] permittedURISchemes) Specifies the allowed URL schemes.

Methods inherited from class net.sf.oval.AbstractCheck

createMessageVariables, getAppliesTo, getContext, getErrorCode, getMessage, getMessageVariables, getProfiles, getSeverity, getTarget, getWhen, isActive, requireMessageVariablesRecreation, setAppliesTo, setContext, setErrorCode, setMessage, setProfiles, setSeverity, setTarget, setWhen

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.oval.Check

getAppliesTo, getContext, getErrorCode, getMessage, getMessageVariables, getProfiles, getSeverity, getTarget, getWhen, isActive, setAppliesTo, setContext, setErrorCode, setMessage, setProfiles, setSeverity, setTarget, setWhen

Constructor Detail

AssertURLCheck

public AssertURLCheck()

Method Detail

configure

public void configure(AssertURL constraintAnnotation)

Configures the check based on the given constraint annotation.

Specified by:

configure in interface AnnotationCheck<AssertURL>

Overrides:

configure in class AbstractAnnotationCheck<AssertURL>

Parameters:

constraintAnnotation - the constraint annotation to use for configuration

getAppliesToDefault

protected ConstraintTarget[] getAppliesToDefault()

Overrides:

getAppliesToDefault in class AbstractCheck

Returns:

the default behavior when the constraint is validated for a array/map/collection reference.

getPermittedURISchemes

public AssertURLCheck.URIScheme[] getPermittedURISchemes()

Gets the allowed URL schemes.

Returns:

the permittedURISchemes

isConnect

public boolean isConnect()

Specifies if a connection to the URL should be attempted to verify its validity.

Returns:

the connect

isSatisfied

public boolean isSatisfied(Object validatedObject,
                           Object valueToValidate,
                           OValContext context,
                           Validator validator)

This method implements the validation logic

Parameters:

validatedObject - the object/bean to validate the value against, for static fields or methods this is the class

valueToValidate - the value to validate, may be null when validating pre conditions for static methods

context - the validation context (e.g. a field, a constructor parameter or a method parameter)

validator - the calling validator

Returns:

true if the value satisfies the checked constraint

setConnect

public void setConnect(boolean connect)

Specifies if a connection to the URL should be attempted to verify its validity.

Parameters:

connect - the connect to set

setPermittedURISchemes

public void setPermittedURISchemes(AssertURLCheck.URIScheme[] permittedURISchemes)

Specifies the allowed URL schemes.

Parameters:

permittedURISchemes - the permittedURISchemes to set