org.apache.commons.validator.routines
Class UrlValidator

java.lang.Object
  org.apache.commons.validator.routines.UrlValidator

All Implemented Interfaces:

java.io.Serializable

public class UrlValidator
extends java.lang.Object
implements java.io.Serializable

URL Validation routines.

Behavior of validation is modified by passing in options:

ALLOW_2_SLASHES - [FALSE] Allows double '/' characters in the path component.

NO_FRAGMENT- [FALSE] By default fragments are allowed, if this option is included then fragments are flagged as illegal.

ALLOW_ALL_SCHEMES - [FALSE] By default only http, https, and ftp are considered valid schemes. Enabling this option will let any scheme pass validation.

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"
  

Since:

Validator 1.4

Version:

$Revision: 595020 $ $Date: 2007-11-14 20:36:45 +0100 (Mi, 14. Nov 2007) $

See Also:

Uniform Resource Identifiers (URI): Generic Syntax , Serialized Form

Field Summary

static long	ALLOW_2_SLASHES Allow two slashes in the path component of the URL.
static long	ALLOW_ALL_SCHEMES Allows all validly formatted schemes to pass validation instead of supplying a set of valid schemes.
private java.util.Set	allowedSchemes The set of schemes that are allowed to be in a URL.
private static java.util.regex.Pattern	ASCII_PATTERN
private static java.lang.String	AUTHORITY_CHARS_REGEX
private static java.util.regex.Pattern	AUTHORITY_PATTERN
private static java.lang.String	AUTHORITY_REGEX
private RegexValidator	authorityValidator Regular expressions used to manually validate authorities if IANA domain name validation isn't desired.
private static java.lang.String[]	DEFAULT_SCHEMES If no schemes are provided, default to this set.
private static UrlValidator	DEFAULT_URL_VALIDATOR Singleton instance of this class with default schemes and options.
private static java.lang.String	LEGAL_ASCII_REGEX
static long	NO_FRAGMENTS Enabling this options disallows any URL fragments.
private long	options Holds the set of current validation options.
private static int	PARSE_AUTHORITY_EXTRA Should always be empty.
private static int	PARSE_AUTHORITY_HOST_IP
private static int	PARSE_AUTHORITY_PORT
private static int	PARSE_URL_AUTHORITY Includes hostname/ip and port number.
private static int	PARSE_URL_FRAGMENT
private static int	PARSE_URL_PATH
private static int	PARSE_URL_QUERY
private static int	PARSE_URL_SCHEME Schema/Protocol (ie.
private static java.util.regex.Pattern	PATH_PATTERN
private static java.lang.String	PATH_REGEX
private static java.util.regex.Pattern	PORT_PATTERN
private static java.lang.String	PORT_REGEX
private static java.util.regex.Pattern	QUERY_PATTERN
private static java.lang.String	QUERY_REGEX
private static java.util.regex.Pattern	SCHEME_PATTERN
private static java.lang.String	SCHEME_REGEX Protocol (ie.
private static java.util.regex.Pattern	URL_PATTERN
private static java.lang.String	URL_REGEX This expression derived/taken from the BNF for URI (RFC2396).

Constructor Summary

UrlValidator()
Create a UrlValidator with default properties.

UrlValidator(long options)
Initialize a UrlValidator with the given validation options.

UrlValidator(RegexValidator authorityValidator, long options)
Initialize a UrlValidator with the given validation options.

UrlValidator(java.lang.String[] schemes)
Behavior of validation is modified by passing in several strings options:

UrlValidator(java.lang.String[] schemes, long options)
Behavior of validation is modified by passing in options:

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

Method Summary

protected int	countToken(java.lang.String token, java.lang.String target) Returns the number of times the token appears in the target.
static UrlValidator	getInstance() Returns the singleton instance of this class with default schemes and options.
private boolean	isOff(long flag) Tests whether the given flag is off.
private boolean	isOn(long flag) Tests whether the given flag is on.
boolean	isValid(java.lang.String value) Checks if a field has a valid url address.
protected boolean	isValidAuthority(java.lang.String authority) Returns true if the authority is properly formatted.
protected boolean	isValidFragment(java.lang.String fragment) Returns true if the given fragment is null or fragments are allowed.
protected boolean	isValidPath(java.lang.String path) Returns true if the path is valid.
protected boolean	isValidQuery(java.lang.String query) Returns true if the query is null or it's a properly formatted query string.
protected boolean	isValidScheme(java.lang.String scheme) Validate scheme.

Methods inherited from class java.lang.Object

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

Field Detail

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.

See Also:

Constant Field Values

ALLOW_2_SLASHES

public static final long ALLOW_2_SLASHES

Allow two slashes in the path component of the URL.

See Also:

Constant Field Values

NO_FRAGMENTS

public static final long NO_FRAGMENTS

Enabling this options disallows any URL fragments.

See Also:

Constant Field Values

AUTHORITY_CHARS_REGEX

private static final java.lang.String AUTHORITY_CHARS_REGEX

See Also:

Constant Field Values

URL_REGEX

private static final java.lang.String URL_REGEX

This expression derived/taken from the BNF for URI (RFC2396).

See Also:

Constant Field Values

URL_PATTERN

private static final java.util.regex.Pattern URL_PATTERN

PARSE_URL_SCHEME

private static final int PARSE_URL_SCHEME

Schema/Protocol (ie. http:, ftp:, file:, etc).

See Also:

Constant Field Values

PARSE_URL_AUTHORITY

private static final int PARSE_URL_AUTHORITY

Includes hostname/ip and port number.

See Also:

Constant Field Values

PARSE_URL_PATH

private static final int PARSE_URL_PATH

See Also:

Constant Field Values

PARSE_URL_QUERY

private static final int PARSE_URL_QUERY

See Also:

Constant Field Values

PARSE_URL_FRAGMENT

private static final int PARSE_URL_FRAGMENT

See Also:

Constant Field Values

SCHEME_REGEX

private static final java.lang.String SCHEME_REGEX

Protocol (ie. http:, ftp:,https:).

See Also:

Constant Field Values

SCHEME_PATTERN

private static final java.util.regex.Pattern SCHEME_PATTERN

AUTHORITY_REGEX

private static final java.lang.String AUTHORITY_REGEX

See Also:

Constant Field Values

AUTHORITY_PATTERN

private static final java.util.regex.Pattern AUTHORITY_PATTERN

PARSE_AUTHORITY_HOST_IP

private static final int PARSE_AUTHORITY_HOST_IP

See Also:

Constant Field Values

PARSE_AUTHORITY_PORT

private static final int PARSE_AUTHORITY_PORT

See Also:

Constant Field Values

PARSE_AUTHORITY_EXTRA

private static final int PARSE_AUTHORITY_EXTRA

Should always be empty.

See Also:

Constant Field Values

PATH_REGEX

private static final java.lang.String PATH_REGEX

See Also:

Constant Field Values

PATH_PATTERN

private static final java.util.regex.Pattern PATH_PATTERN

QUERY_REGEX

private static final java.lang.String QUERY_REGEX

See Also:

Constant Field Values

QUERY_PATTERN

private static final java.util.regex.Pattern QUERY_PATTERN

LEGAL_ASCII_REGEX

private static final java.lang.String LEGAL_ASCII_REGEX

See Also:

Constant Field Values

ASCII_PATTERN

private static final java.util.regex.Pattern ASCII_PATTERN

PORT_REGEX

private static final java.lang.String PORT_REGEX

See Also:

Constant Field Values

PORT_PATTERN

private static final java.util.regex.Pattern PORT_PATTERN

options

private final long options

Holds the set of current validation options.

allowedSchemes

private final java.util.Set allowedSchemes

The set of schemes that are allowed to be in a URL.

authorityValidator

private final RegexValidator authorityValidator

Regular expressions used to manually validate authorities if IANA domain name validation isn't desired.

DEFAULT_SCHEMES

private static final java.lang.String[] DEFAULT_SCHEMES

If no schemes are provided, default to this set.

DEFAULT_URL_VALIDATOR

private static final UrlValidator DEFAULT_URL_VALIDATOR

Singleton instance of this class with default schemes and options.

Constructor Detail

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.

Method Detail

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.

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.

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.

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.

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.

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.

isOn

private boolean isOn(long flag)

Tests whether the given flag is on. If the flag is not a power of 2 (ie. 3) this tests whether the combination of flags is on.

Parameters:

flag - Flag value to check.

Returns:

whether the specified flag value is on.

isOff

private boolean isOff(long flag)

Tests whether the given flag is off. If the flag is not a power of 2 (ie. 3) this tests whether the combination of flags is off.

Parameters:

flag - Flag value to check.

Returns:

whether the specified flag value is off.