com.google.enterprise.connector.util

Class UrlValidator

java.lang.Object

com.google.enterprise.connector.util.UrlValidator

public class UrlValidator
extends java.lang.Object

Validates URLs by making an HTTP request.

Since:

2.6.6

Constructor Summary

Constructors

Constructor and Description
UrlValidator() Constructs an instance using the default parameter values.

Method Summary

Modifier and Type	Method and Description
void	setConnectTimeout(int connectTimeout) Sets the connect timeout.
void	setFollowRedirects(boolean followRedirects) Sets whether to follow HTTP redirects, or return them as the response.
void	setReadTimeout(int readTimeout) Sets the read timeout.
void	setRequestMethod(java.lang.String requestMethod) Sets the HTTP request method.
void	setRequireFullyQualifiedHostNames(boolean requireFullyQualifiedHostNames) Sets whether fully qualified host names are required in the URL.
int	validate(java.lang.String urlString) Attempts to validate the given URL by making an HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlValidator

public UrlValidator()

Constructs an instance using the default parameter values.

Method Detail

setRequestMethod

public void setRequestMethod(java.lang.String requestMethod)

Sets the HTTP request method. The default value is "HEAD".

Parameters:

requestMethod - should be either "GET" or "HEAD"

See Also:

HttpURLConnection.setRequestMethod(java.lang.String)

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

Sets whether to follow HTTP redirects, or return them as the response. The default is false, which returns the redirect as the HTTP response.

Parameters:

followRedirects - true to follow HTTP redirects, or false to return them as the HTTP response

See Also:

HttpURLConnection.setInstanceFollowRedirects(boolean)

setRequireFullyQualifiedHostNames

public void setRequireFullyQualifiedHostNames(boolean requireFullyQualifiedHostNames)

Sets whether fully qualified host names are required in the URL. IP addresses are still OK, but host names must be fully qualified. The default is false, which allows non-fully qualified host names, even thought the GSA requires one in most cases.

Parameters:

requireFullyQualifiedHostNames - true if host names must be fully qualified, false if not

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Sets the connect timeout. The default value is 60000 milliseconds.

Parameters:

connectTimeout - the connect timeout in milliseconds

See Also:

URLConnection.setConnectTimeout(int)

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets the read timeout. The default value is 60000 milliseconds.

Parameters:

readTimeout - the read timeout in milliseconds

See Also:

URLConnection.setReadTimeout(int)

validate

public int validate(java.lang.String urlString)
             throws java.security.GeneralSecurityException,
                    java.io.IOException,
                    UrlValidatorException

Attempts to validate the given URL by making an HTTP request. In this case, we're mostly trying to catch typos, so "valid" means:

1. The URL syntax is valid.
2. If fully qualified host names are required, check that the host name looks fully qualified (contains a '.').
3. If the URL uses HTTP or HTTPS:
   1. A connection can be made and the response read.
   2. The response code was not 404, or any of the following related but less common errors: 400, 405, 410, or 414.

The 405 (Method Not Allowed) is related because the Sun Java System Web Server, and possibly Apache, return this code rather than a 404 if you attempt to access a CGI program in an unknown directory.

When testing an HTTPS URL, we override server certificate validation to skip trying to verify the server's certificate, and we accept hostname mismatches. In this case, all we care about is that the configured URL can be reached; it's up to the connector administrator to enter the right URL.

Parameters:

urlString - the URL to test

Throws:

java.security.GeneralSecurityException - if there is an error configuring the HTTPS connection

java.io.IOException - if the URL is malformed, or if there is an error connecting or reading the response

UrlValidatorException - if the HTTP status code was invalid