org.apache.commons.validator
Class UrlValidator

java.lang.Object
  extended byorg.apache.commons.validator.UrlValidator
All Implemented Interfaces:
java.io.Serializable

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

Validates URLs.

Behavour 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")) {
           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")) {
           System.out.println("url is valid");
        } else {
           System.out.println("url is invalid");
        }
    
       prints out "url is valid"
      

    Since:
    Validator 1.1
    See Also:
    Uniform Resource Identifiers (URI): Generic Syntax , Serialized Form

    Field Summary
    static int ALLOW_2_SLASHES
              Allow two slashes in the path component of the URL.
    static int 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.lang.String ALPHA_CHARS
               
    private static java.lang.String ALPHA_NUMERIC_CHARS
               
    private static java.lang.String ALPHA_PATTERN
               
    private static java.lang.String ATOM
               
    private static java.lang.String ATOM_PATTERN
               
    private static java.lang.String AUTHORITY_CHARS
               
    private static java.lang.String AUTHORITY_PATTERN
               
    protected  java.lang.String[] defaultSchemes
              If no schemes are provided, default to this set.
    private static java.lang.String DOMAIN_PATTERN
               
    private static java.lang.String IP_V4_DOMAIN_PATTERN
               
    private static java.lang.String LEGAL_ASCII_PATTERN
               
    static int NO_FRAGMENTS
              Enabling this options disallows any URL fragments.
    private  Flags 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.lang.String PATH_PATTERN
               
    private static java.lang.String PORT_PATTERN
               
    private static java.lang.String QUERY_PATTERN
               
    private static java.lang.String SCHEME_CHARS
               
    private static java.lang.String SCHEME_PATTERN
              Protocol (ie.
    private static java.lang.String SPECIAL_CHARS
               
    private static java.lang.String URL_PATTERN
              This expression derived/taken from the BNF for URI (RFC2396).
    private static java.lang.String VALID_CHARS
               
     
    Constructor Summary
    UrlValidator()
              Create a UrlValidator with default properties.
    UrlValidator(int 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, int options)
              Behavour of validation is modified by passing in options:
     
    Method Summary
    protected  int countToken(java.lang.String token, java.lang.String target)
              Returns the number of times the token appears in the target.
     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 int 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 int ALLOW_2_SLASHES
    Allow two slashes in the path component of the URL.

    See Also:
    Constant Field Values

    NO_FRAGMENTS

    public static final int NO_FRAGMENTS
    Enabling this options disallows any URL fragments.

    See Also:
    Constant Field Values

    ALPHA_CHARS

    private static final java.lang.String ALPHA_CHARS
    See Also:
    Constant Field Values

    ALPHA_NUMERIC_CHARS

    private static final java.lang.String ALPHA_NUMERIC_CHARS
    See Also:
    Constant Field Values

    SPECIAL_CHARS

    private static final java.lang.String SPECIAL_CHARS
    See Also:
    Constant Field Values

    VALID_CHARS

    private static final java.lang.String VALID_CHARS
    See Also:
    Constant Field Values

    SCHEME_CHARS

    private static final java.lang.String SCHEME_CHARS
    See Also:
    Constant Field Values

    AUTHORITY_CHARS

    private static final java.lang.String AUTHORITY_CHARS
    See Also:
    Constant Field Values

    ATOM

    private static final java.lang.String ATOM
    See Also:
    Constant Field Values

    URL_PATTERN

    private static final java.lang.String URL_PATTERN
    This expression derived/taken from the BNF for URI (RFC2396).

    See Also:
    Constant Field Values

    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_PATTERN

    private static final java.lang.String SCHEME_PATTERN
    Protocol (ie. http:, ftp:,https:).

    See Also:
    Constant Field Values

    AUTHORITY_PATTERN

    private static final java.lang.String AUTHORITY_PATTERN
    See Also:
    Constant Field Values

    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_PATTERN

    private static final java.lang.String PATH_PATTERN
    See Also:
    Constant Field Values

    QUERY_PATTERN

    private static final java.lang.String QUERY_PATTERN
    See Also:
    Constant Field Values

    LEGAL_ASCII_PATTERN

    private static final java.lang.String LEGAL_ASCII_PATTERN
    See Also:
    Constant Field Values

    IP_V4_DOMAIN_PATTERN

    private static final java.lang.String IP_V4_DOMAIN_PATTERN
    See Also:
    Constant Field Values

    DOMAIN_PATTERN

    private static final java.lang.String DOMAIN_PATTERN
    See Also:
    Constant Field Values

    PORT_PATTERN

    private static final java.lang.String PORT_PATTERN
    See Also:
    Constant Field Values

    ATOM_PATTERN

    private static final java.lang.String ATOM_PATTERN
    See Also:
    Constant Field Values

    ALPHA_PATTERN

    private static final java.lang.String ALPHA_PATTERN
    See Also:
    Constant Field Values

    options

    private Flags options
    Holds the set of current validation options.


    allowedSchemes

    private java.util.Set allowedSchemes
    The set of schemes that are allowed to be in a URL.


    defaultSchemes

    protected java.lang.String[] defaultSchemes
    If no schemes are provided, default to this set.

    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(int 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,
                        int options)
    Behavour 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.
    Method Detail

    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.


    isValidPath

    protected boolean isValidPath(java.lang.String path)
    Returns true if the path is valid. A null value is considered invalid.


    isValidQuery

    protected boolean isValidQuery(java.lang.String query)
    Returns true if the query is null or it's a properly formatted query string.


    isValidFragment

    protected boolean isValidFragment(java.lang.String fragment)
    Returns true if the given fragment is null or fragments are allowed.


    countToken

    protected int countToken(java.lang.String token,
                             java.lang.String target)
    Returns the number of times the token appears in the target.



    Copyright (c) 2001-2004 Apache Software Foundation