org.codehaus.groovy.grails.validation.routines
[Java] Class UrlValidator

java.lang.Object
  org.codehaus.groovy.grails.validation.routines.UrlValidator

All Implemented Interfaces:

java.io.Serializable

public class UrlValidator
extends java.lang.Object

URL Validation routines.

Originally based in on php script by Debbie Dyer, validation.php v1.2b, Date: 03/07/02, http://javascript.internet.com. However, this validation now bears little resemblance to the php original.

   Example of usage:
   Construct a UrlValidator with valid schemes of "http", and "https".

    String[] schemes = {"http","https"}.
    UrlValidator urlValidator = new UrlValidator(schemes);
    if (urlValidator.isValid("ftp://foo.bar.com/")) {
       System.out.println("url is valid");
    } else {
       System.out.println("url is invalid");
    }

    prints "url is invalid"
   If instead the default constructor is used.

    UrlValidator urlValidator = new UrlValidator();
    if (urlValidator.isValid("ftp://foo.bar.com/")) {
       System.out.println("url is valid");
    } else {
       System.out.println("url is invalid");
    }

   prints out "url is valid"
  

See Also:

Since:

Validator 1.4

ALLOW_2_SLASHES

public static final long ALLOW_2_SLASHES

Allow two slashes in the path component of the URL.

ALLOW_ALL_SCHEMES

public static final long ALLOW_ALL_SCHEMES

Allows all validly formatted schemes to pass validation instead of supplying a set of valid schemes.

NO_FRAGMENTS

public static final long NO_FRAGMENTS

Enabling this options disallows any URL fragments.

UrlValidator

public UrlValidator()

Create a UrlValidator with default properties.

UrlValidator

public UrlValidator(java.lang.String[] schemes)

Behavior of validation is modified by passing in several strings options:

Parameters:

schemes - Pass in one or more url schemes to consider valid, passing in a null will default to "http,https,ftp" being valid. If a non-null schemes is specified then all valid schemes must be specified. Setting the ALLOW_ALL_SCHEMES option will ignore the contents of schemes.

UrlValidator

public UrlValidator(long options)

Initialize a UrlValidator with the given validation options.

Parameters:

options - The options should be set using the public constants declared in this class. To set multiple options you simply add them together. For example, ALLOW_2_SLASHES + NO_FRAGMENTS enables both of those options.

UrlValidator

public UrlValidator(java.lang.String[] schemes, long options)

Behavior of validation is modified by passing in options:

Parameters:

schemes - The set of valid schemes.

options - The options should be set using the public constants declared in this class. To set multiple options you simply add them together. For example, ALLOW_2_SLASHES + NO_FRAGMENTS enables both of those options.

UrlValidator

public UrlValidator(RegexValidator authorityValidator, long options)

Initialize a UrlValidator with the given validation options.

Parameters:

authorityValidator - Regular expression validator used to validate the authority part

options - Validation options. Set using the public constants of this class. To set multiple options, simply add them together:

ALLOW_2_SLASHES + NO_FRAGMENTS

enables both of those options.

UrlValidator

public UrlValidator(java.lang.String[] schemes, RegexValidator authorityValidator, long options)

Customizable constructor. Validation behavior is modifed by passing in options.

Parameters:

schemes - the set of valid schemes

authorityValidator - Regular expression validator used to validate the authority part

options - Validation options. Set using the public constants of this class. To set multiple options, simply add them together:

ALLOW_2_SLASHES + NO_FRAGMENTS

enables both of those options.

countToken

protected int countToken(java.lang.String token, java.lang.String target)

Returns the number of times the token appears in the target.

Parameters:

token - Token value to be counted.

target - Target value to count tokens in.

Returns:

the number of tokens.

getInstance

public static UrlValidator getInstance()

Returns the singleton instance of this class with default schemes and options.

Returns:

singleton instance with default schemes and options

isValid

public boolean isValid(java.lang.String value)

Checks if a field has a valid url address.

Parameters:

value - The value validation is being performed on. A null value is considered invalid.

Returns:

true if the url is valid.

isValidAuthority

protected boolean isValidAuthority(java.lang.String authority)

Returns true if the authority is properly formatted. An authority is the combination of hostname and port. A null authority value is considered invalid.

Parameters:

authority - Authority value to validate.

Returns:

true if authority (hostname and port) is valid.

isValidFragment

protected boolean isValidFragment(java.lang.String fragment)

Returns true if the given fragment is null or fragments are allowed.

Parameters:

fragment - Fragment value to validate.

Returns:

true if fragment is valid.

isValidPath

protected boolean isValidPath(java.lang.String path)

Returns true if the path is valid. A null value is considered invalid.

Parameters:

path - Path value to validate.

Returns:

true if path is valid.

isValidQuery

protected boolean isValidQuery(java.lang.String query)

Returns true if the query is null or it's a properly formatted query string.

Parameters:

query - Query value to validate.

Returns:

true if query is valid.

isValidScheme

protected boolean isValidScheme(java.lang.String scheme)

Validate scheme. If schemes[] was initialized to a non null, then only those scheme's are allowed. Note this is slightly different than for the constructor.

Parameters:

scheme - The scheme to validate. A null value is considered invalid.

Returns:

true if valid.

Groovy Documentation