Package org.apache.commons.validator
Class UrlValidator
java.lang.Object
org.apache.commons.validator.UrlValidator
- All Implemented Interfaces:
Serializable
Deprecated.
Use the new UrlValidator in the routines package. This class
will be removed in a future release.
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://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.1
- Version:
- $Revision: 1651811 $
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Deprecated.Allow two slashes in the path component of the URL.static final int
Deprecated.Allows all validly formatted schemes to pass validation instead of supplying a set of valid schemes.Deprecated.The set of schemes that are allowed to be in a URL.private static final String
Deprecated.private static final Pattern
Deprecated.private static final String
Deprecated.private static final Pattern
Deprecated.private static final String
Deprecated.private static final Pattern
Deprecated.private static final String
Deprecated.protected String[]
Deprecated.If no schemes are provided, default to this set.private static final Pattern
Deprecated.private static final Pattern
Deprecated.static final int
Deprecated.Enabling this options disallows any URL fragments.private final Flags
Deprecated.Holds the set of current validation options.private static final int
Deprecated.Should always be empty.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.Includes hostname/ip and port number.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.private static final int
Deprecated.Schema/Protocol (ie.private static final Pattern
Deprecated.private static final Pattern
Deprecated.private static final Pattern
Deprecated.private static final Pattern
Deprecated.Protocol (ie.private static final long
Deprecated.private static final String
Deprecated.private static final Pattern
Deprecated.private static final String
Deprecated.This expression derived/taken from the BNF for URI (RFC2396).private static final String
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Create a UrlValidator with default properties.UrlValidator
(int options) Deprecated.Initialize a UrlValidator with the given validation options.UrlValidator
(String[] schemes) Deprecated.Behavior of validation is modified by passing in several strings options:UrlValidator
(String[] schemes, int options) Deprecated.Behavour of validation is modified by passing in options: -
Method Summary
Modifier and TypeMethodDescriptionprotected int
countToken
(String token, String target) Deprecated.Returns the number of times the token appears in the target.boolean
Deprecated.Checks if a field has a valid url address.protected boolean
isValidAuthority
(String authority) Deprecated.Returns true if the authority is properly formatted.protected boolean
isValidFragment
(String fragment) Deprecated.Returns true if the given fragment is null or fragments are allowed.protected boolean
isValidPath
(String path) Deprecated.Returns true if the path is valid.protected boolean
isValidQuery
(String query) Deprecated.Returns true if the query is null or it's a properly formatted query string.protected boolean
isValidScheme
(String scheme) Deprecated.Validate scheme.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDDeprecated.- See Also:
-
ALLOW_ALL_SCHEMES
public static final int ALLOW_ALL_SCHEMESDeprecated.Allows all validly formatted schemes to pass validation instead of supplying a set of valid schemes.- See Also:
-
ALLOW_2_SLASHES
public static final int ALLOW_2_SLASHESDeprecated.Allow two slashes in the path component of the URL.- See Also:
-
NO_FRAGMENTS
public static final int NO_FRAGMENTSDeprecated.Enabling this options disallows any URL fragments.- See Also:
-
ALPHA_CHARS
Deprecated.- See Also:
-
SPECIAL_CHARS
Deprecated.- See Also:
-
VALID_CHARS
Deprecated.- See Also:
-
AUTHORITY_CHARS_REGEX
Deprecated.- See Also:
-
ATOM
Deprecated.- See Also:
-
URL_REGEX
Deprecated.This expression derived/taken from the BNF for URI (RFC2396).- See Also:
-
URL_PATTERN
Deprecated. -
PARSE_URL_SCHEME
private static final int PARSE_URL_SCHEMEDeprecated.Schema/Protocol (ie. http:, ftp:, file:, etc).- See Also:
-
PARSE_URL_AUTHORITY
private static final int PARSE_URL_AUTHORITYDeprecated.Includes hostname/ip and port number.- See Also:
-
PARSE_URL_PATH
private static final int PARSE_URL_PATHDeprecated.- See Also:
-
PARSE_URL_QUERY
private static final int PARSE_URL_QUERYDeprecated.- See Also:
-
PARSE_URL_FRAGMENT
private static final int PARSE_URL_FRAGMENTDeprecated.- See Also:
-
SCHEME_PATTERN
Deprecated.Protocol (ie. http:, ftp:,https:). -
AUTHORITY_REGEX
Deprecated.- See Also:
-
AUTHORITY_PATTERN
Deprecated. -
PARSE_AUTHORITY_HOST_IP
private static final int PARSE_AUTHORITY_HOST_IPDeprecated.- See Also:
-
PARSE_AUTHORITY_PORT
private static final int PARSE_AUTHORITY_PORTDeprecated.- See Also:
-
PARSE_AUTHORITY_EXTRA
private static final int PARSE_AUTHORITY_EXTRADeprecated.Should always be empty.- See Also:
-
PATH_PATTERN
Deprecated. -
QUERY_PATTERN
Deprecated. -
LEGAL_ASCII_PATTERN
Deprecated. -
DOMAIN_PATTERN
Deprecated. -
PORT_PATTERN
Deprecated. -
ATOM_PATTERN
Deprecated. -
ALPHA_PATTERN
Deprecated. -
options
Deprecated.Holds the set of current validation options. -
allowedSchemes
Deprecated.The set of schemes that are allowed to be in a URL. -
defaultSchemes
Deprecated.If no schemes are provided, default to this set.
-
-
Constructor Details
-
UrlValidator
public UrlValidator()Deprecated.Create a UrlValidator with default properties. -
UrlValidator
Deprecated.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) Deprecated.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
Deprecated.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 Details
-
isValid
Deprecated.Checks if a field has a valid url address.
- Parameters:
value
- The value validation is being performed on. Anull
value is considered invalid.- Returns:
- true if the url is valid.
-
isValidScheme
Deprecated.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. Anull
value is considered invalid.- Returns:
- true if valid.
-
isValidAuthority
Deprecated.Returns true if the authority is properly formatted. An authority is the combination of hostname and port. Anull
authority value is considered invalid.- Parameters:
authority
- Authority value to validate.- Returns:
- true if authority (hostname and port) is valid.
-
isValidPath
Deprecated.Returns true if the path is valid. Anull
value is considered invalid.- Parameters:
path
- Path value to validate.- Returns:
- true if path is valid.
-
isValidQuery
Deprecated.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
Deprecated.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
Deprecated.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.
-