org.mdiutil.io

Class FileUtilities

java.lang.Object

org.mdiutil.io.FileUtilities

Direct Known Subclasses:

FileUIUtilities

public class FileUtilities
extends Object

Various File utilities to deal with URLs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIREFOX10_USERAGENT The Firefox 10 user agent.
static String	IE9_USERAGENT The IE9 user agent.
static int	OPTION_ACCEPT301CODE The option used if 301 or 308 return codes will be accepted as valid responses (URL found).
static short	OPTION_CHILDURL_DEFAULT The default option for the getChildURL(java.net.URL, java.lang.String, int).
static short	OPTION_CHILDURL_ESCAPE The option for the getChildURL(java.net.URL, java.lang.String, int) to escape the result.
static short	OPTION_CHILDURL_FILTEREXIST The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists.
static short	OPTION_CHILDURL_FILTEREXIST_FILE The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists only for file protocols.
static short	OPTION_CHILDURL_FILTEREXIST_HTTP The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists only for http and https protocols.
static short	OPTION_FILEEXIST_DEFAULT The default option for the exist(java.io.File, short) and exist(java.net.URL, short).
static short	OPTION_FILEEXIST_HTTP_FORCETRUE The option for the exist(java.io.File, short) and exist(java.net.URL, short) by setting by default that http resources exists.
static short	OPTION_FILEEXIST_LENGTH The option for the exist(java.io.File, short) and exist(java.net.URL, short) by getting the file length to check the file existence.
static short	OPTION_FILEEXIST_READ The option for the exist(java.io.File, short) and exist(java.net.URL, short) by trying to read the beginning of the file to check the file existence.
static short	OPTION_FILEEXIST_SKIP_PHP The option for the exist(java.io.File, short) and exist(java.net.URL, short) by considering that URLs which point to php resources don't exist.
static short	OPTION_FILEEXIST_SKIP_QUERIES The option for the exist(java.io.File, short) and exist(java.net.URL, short) by considering that URLs with queries don't exist.
static int	OPTION_FOLLOWREDIRECT The option used if redirection links will be followed and used to check that the links exists.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileUtilities()

Method Summary

Modifier and Type	Method and Description
static boolean	checkFilePermissions() Return true if the application has the right to get Files in the local network.
static URL	collapse(URL url) Collapse an URL to a representation without any ..
static File	createFile(File dir, String path) Create the File whose name is defined by path, and which may be defined relative to a parent directory.
static String	encodeURL(String path) Filter a path name for an URL, replacing spaces characters by their percent encoding equivalent.
static boolean	exist(File file) Return true if the file or the resource denoted by this URL exist.
static boolean	exist(File file, int option) Return true if the file or the resource denoted by this URL exist.
static boolean	exist(File file, short option) Return true if the file or the resource denoted by this URL exist.
static boolean	exist(URL url) Return true if the URL or the resource denoted by this URL exist.
static boolean	exist(URL url, int option) Return true if the file or the resource denoted by this URL exist.
static boolean	exist(URL url, short option) Return true if the file or the resource denoted by this URL exist.
static URL	fixURLPath(URL url) Filter a path name for an URL, replacing spaces characters by their percent encoding equivalent.
static File	getAbsoluteFile(File baseDir, String relativePath) Return the File corresponding to a String-defined path, that can be defined as absolute, or as relative to a base directory.
static String	getAbsolutePath(File baseDir, String path) Return the absolute path of an URL, using the file separator of the platform.
static String	getAbsolutePath(File baseDir, String path, boolean filterExistingURLs) Return the absolute path of an URL, using the file separator of the platform.
static String	getAbsolutePath(URL baseURL, String relativePath) Return the absolute path of an URL, using the file separator of the platform.
static URL	getAbsoluteURL(URL baseURL, String relativePath) Return the File corresponding to a String-defined path, that can be defined as absolute, or as relative to a base directory.
static List<URL>	getChildren(URL url, boolean strict) Return the list of children of a URL designing a directory, including directories in jar or zip files.
static URL	getChildURL(URL parentURL, String path) Return an URL by its relative path from a parent URL.
static URL	getChildURL(URL parentURL, String path, boolean filterExistingURLs) Return an URL by its relative path from a parent URL.
static URL	getChildURL(URL parentURL, String path, boolean filterExistingURLs, boolean escape) Return an URL by its relative path from a parent URL.
static URL	getChildURL(URL parentURL, String path, int options) Return an URL by its relative path from a parent URL.
static File	getCompatibleFile(File file, String ext) Return a File abstract representation, making sure that it have the desired extension.
static File	getCompatibleFile(File file, String[] exts) Return a File abstract representation, making sure that it have the desired extension.
static File	getCompatibleFile(File file, String[] exts, String defaultExt) Return a File abstract representation, making sure that it have the desired extension.
static File	getDirectory(String path) Get the directory whose name is defined by path.
static String	getDrive(File file) Return the drive name of a file.
static String	getEscapedName(String name) Return a name without blank, and containing only ASCII characters.
static File	getFile(File dir, String path) Return the File whose name is defined by path, and which may be defined relative to a parent directory.
static File	getFile(String path) Return the File whose name is defined by path.
static File	getFile(URL url) Return a File for an URL, replacing percent encoding characters by their equivalent characters.
static String	getFileExtension(File file) Return the extension of a File.
static String	getFileExtension(URL url) Return the extension of a URL.
static String	getFileName(File file) Return the file name without the path, nor the extension.
static String	getFileName(URL url) Return the URL name without the path, nor the extension.
static String	getFileNameBody(File file) Return the body name of a File (before the extension if there is an extension, else this is the name of the file itself).
static String	getFileNameBody(URL url) Return the body name of a URL (before the extension if there is an extension, else this is the name of the file itself).
static String	getFileNameWithExtension(File file) Return the file name without the path, but keeping the extension.
static String	getFileNameWithExtension(URL url) Return the URL name without the path, but keeping the extension.
static File[]	getFilesFromURLList(List<URL> list) Return a list of Files defined by their list of URLs.
static File[]	getFilesFromURLList(List<URL> list, boolean filterExistingURLs) Return a list of Files defined by their list of URLs.
static URL	getJarEntryURL(URL url, String entryPath) Return an URL corresponding to an entry in a Jar file.
static URL	getJarEntryURL(URL url, String entryPath, URLStreamHandler handler) Return an URL corresponding to an entry in a Jar file.
static URL	getParentURL(URL url) Return the parent URL of a given URL.
static URL	getParentURL(URL url, boolean endSeparator) Return the parent URL of a given URL.
static URL	getProtectedURL(File file) Return the URL corresponding to a File, avoiding to throw a SecurityException in secured environments like Applets.
static URL	getRedirectURL(URL url) Return the final URL after applying all the possible redirections.
static String	getRelativePath(File baseDir, File file) Return the path of a File relative to a directory.
static String	getRelativePath(File baseDir, File file, boolean strict) Return the path of a File relative to a directory.
static String	getRelativePath(URL baseURL, URL url) Return the path of an URL relative to a directory.
static String	getRelativePath(URL baseURL, URL url, boolean strict) Return the path of an URL relative to a directory.
static int	getResponseCode(URL url) Return the response code for an URL, without a proxy.
static int	getResponseCode(URL url, int timeOut) Return the response code for an URL, without a proxy.
static int	getResponseCode(URL url, Proxy proxy) Return the response code for an URL, without using a timeOut.
static int	getResponseCode(URL url, Proxy proxy, int timeOut) Return the response code for an URL.
static int	getResponseCode(URL url, Proxy proxy, String userAgent) Return the response code for an URL, witbout using a timeOut.
static int	getResponseCode(URL url, Proxy proxy, String userAgent, int timeOut) Return the response code for an URL.
static Set<String>	getRootNames() Return the file system root names.
static String	getText(File file) Return the text corresponding to a File.
static String	getText(URL url) Return the text corresponding to a URL.
static URL	getURL(File baseDir, String path) Return the URL whose name is defined by path.
static URL	getURL(File baseDir, String path, boolean filterExistingURLs) Return the URL whose name is defined by path.
static List<URL>	getURLListFromFiles(File[] files) Return a list of URLs defined by their list of Files.
static List<URL>	getURLListFromFiles(File[] files, boolean filterExistingFiles) Return a list of URLs defined by their list of Files.
static URL[]	getURLs(File dir, String paths) Return a list of URLs from a String.
static URL[]	getURLs(File dir, String paths, boolean filterExistingURLs) Return a list of URLs from a String.
static List<URL>	getURLsFromString(File baseDir, String urlList) Return a List of URLs from a String separated with a ";".
static List<URL>	getURLsFromString(File baseDir, String urlList, boolean filterExistingURLs) Return a List of URLs from a String separated with a ";".
static List<URL>	getURLsFromString(URL baseDir, String urlList) Return a List of URLs from a String separated with a ";".
static List<URL>	getURLsFromString(URL baseDir, String urlList, boolean filterExistingURLs) Return a List of URLs from a String separated with a ";".
static boolean	isAbsolute(String path) Return true if a path is absolute.
static boolean	isAbsoluteURI(String path) Return true if an URI path is absolute.
static boolean	isAncestor(File ancestor, File file) Return true if a file is an ancestor of another file.
static boolean	isAncestor(URL ancestor, URL url) Return true if an URL is an ancestor of another URL.
static boolean	isArchive(File f) Return true if a File is an archive.
static boolean	isArchive(URL url) Return true if an url is an archive.
static boolean	isDirectory(URL url) Return true if an URL correspond to a directory, including directories in jar or zip files.
static boolean	isFileOrHTTPProtocol(URL url) Return true if the protocol is a file, http, or https protocol.
static boolean	isHTTPProtocol(String path) Return true if the protocol is a http, or https protocol.
static boolean	isHTTPProtocol(URL url) Return true if the protocol is a http, or https protocol.
static boolean	isHTTPSProtocol(String path) Return true if the protocol is a https protocol.
static boolean	isHTTPSProtocol(URL url) Return true if the protocol is a https protocol.
static boolean	isRelativeTo(File baseDir, File file) Return true if a file is relative to a directory (that is: the directory is one of the file ancestors).
static boolean	isRoot(File dir) Return true if a directory is a root of the file system.
static boolean	isURLFound(URL url) Return true if an URL is found, without using a timeOut.
static boolean	isURLFound(URL url, int options) Return true if an URL is found, without using a timeOut.
static boolean	isURLFound(URL url, int options, int timeOut) Return true if an URL is found.
static boolean	isURLFound(URL url, Proxy proxy) Return true if an URL is found, without using a timeOut.
static boolean	isURLFound(URL url, Proxy proxy, int timeOut) Return true if an URL is found.
static boolean	isURLFound(URL url, Proxy proxy, int options, int timeOut) Return true if an URL is found.
static boolean	isURLFound(URL url, Proxy proxy, String userAgent) Return true if an URL is found, without using a timeOut.
static boolean	isURLFound(URL url, Proxy proxy, String userAgent, int timeOut) Return true if an URL is found.
static boolean	isURLFound(URL url, Proxy proxy, String userAgent, int options, int timeOut) Return true if an URL is found.
static URL	makeAbsoluteURLPath(String path) Create an URL from a path, removing the relative delimiters.
static URL	normalize(URL url) Normalize an URL by removing "." and ".." in the path part of the URL.
static String	replaceEscapedSequences(String path) Replace the percent-encoding escape sequences in a URL path by their equivalent characters.
static String	replaceEscapedSequences(String path, boolean keepEscapedSpaces) Replace the percent-encoding escape sequences in a URL path by their equivalent characters.
static boolean	sameURL(URL url1, URL url2) Check if two URLs are the same, taking into account double slash and .. constructs.
static boolean	useFileOrHTTPProtocol(String url) Return true if the URL use a file, http, or https protocol.
static boolean	useFileProtocol(String url) Return true if the URL use the file protocol.
static boolean	useHTTPProtocol(String url) Return true if the URL use a http, or https protocol.

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_ACCEPT301CODE

public static final int OPTION_ACCEPT301CODE

The option used if 301 or 308 return codes will be accepted as valid responses (URL found).

See Also:

isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int), Constant Field Values

OPTION_FOLLOWREDIRECT

public static final int OPTION_FOLLOWREDIRECT

The option used if redirection links will be followed and used to check that the links exists. For example:

• "http://docs.oracle.com/javase/8/docs/api/java/awt/Button.html": this link is found with a 301 code and the redirection links to the same link with an https protocol, it will be considered as existing
• "http://docs.oracle.com/javase/8/docs/api/java/awt/Button1111.html": this link is found with a 301 code and the redirection links to a special 404 Oracle link, it will be considered as not existing

See Also:

isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int), Constant Field Values

OPTION_FILEEXIST_DEFAULT

public static final short OPTION_FILEEXIST_DEFAULT

The default option for the exist(java.io.File, short) and exist(java.net.URL, short).

See Also:

Constant Field Values

OPTION_FILEEXIST_READ

public static final short OPTION_FILEEXIST_READ

The option for the exist(java.io.File, short) and exist(java.net.URL, short) by trying to read the beginning of the file to check the file existence.

See Also:

Constant Field Values

OPTION_FILEEXIST_LENGTH

public static final short OPTION_FILEEXIST_LENGTH

The option for the exist(java.io.File, short) and exist(java.net.URL, short) by getting the file length to check the file existence.

See Also:

Constant Field Values

OPTION_FILEEXIST_SKIP_QUERIES

public static final short OPTION_FILEEXIST_SKIP_QUERIES

The option for the exist(java.io.File, short) and exist(java.net.URL, short) by considering that URLs with queries don't exist.

See Also:

Constant Field Values

OPTION_FILEEXIST_SKIP_PHP

public static final short OPTION_FILEEXIST_SKIP_PHP

The option for the exist(java.io.File, short) and exist(java.net.URL, short) by considering that URLs which point to php resources don't exist.

See Also:

Constant Field Values

OPTION_FILEEXIST_HTTP_FORCETRUE

public static final short OPTION_FILEEXIST_HTTP_FORCETRUE

The option for the exist(java.io.File, short) and exist(java.net.URL, short) by setting by default that http resources exists.

See Also:

Constant Field Values

OPTION_CHILDURL_DEFAULT

public static final short OPTION_CHILDURL_DEFAULT

The default option for the getChildURL(java.net.URL, java.lang.String, int).

See Also:

Constant Field Values

OPTION_CHILDURL_ESCAPE

public static final short OPTION_CHILDURL_ESCAPE

The option for the getChildURL(java.net.URL, java.lang.String, int) to escape the result.

See Also:

Constant Field Values

OPTION_CHILDURL_FILTEREXIST

public static final short OPTION_CHILDURL_FILTEREXIST

The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists.

See Also:

Constant Field Values

OPTION_CHILDURL_FILTEREXIST_FILE

public static final short OPTION_CHILDURL_FILTEREXIST_FILE

The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists only for file protocols.

See Also:

Constant Field Values

OPTION_CHILDURL_FILTEREXIST_HTTP

public static final short OPTION_CHILDURL_FILTEREXIST_HTTP

The option for the getChildURL(java.net.URL, java.lang.String, int) to check if the resulting file exists only for http and https protocols.

See Also:

Constant Field Values

FIREFOX10_USERAGENT

public static final String FIREFOX10_USERAGENT

The Firefox 10 user agent.

See Also:

Constant Field Values

IE9_USERAGENT

public static final String IE9_USERAGENT

The IE9 user agent.

See Also:

Constant Field Values

Constructor Detail

FileUtilities

protected FileUtilities()

Method Detail

getRootNames

public static Set<String> getRootNames()

Return the file system root names.

Returns:

the fle system root names

useFileOrHTTPProtocol

public static boolean useFileOrHTTPProtocol(String url)

Return true if the URL use a file, http, or https protocol.

Parameters:

url - the URL

Returns:

true if the URL use a file, http, or https protocol

useFileProtocol

public static boolean useFileProtocol(String url)

Return true if the URL use the file protocol.

Parameters:

url - the URL

Returns:

true if the URL use the file protocol

useHTTPProtocol

public static boolean useHTTPProtocol(String url)

Return true if the URL use a http, or https protocol.

Parameters:

url - the URL

Returns:

true if the URL use a http, or https protocol

isFileOrHTTPProtocol

public static boolean isFileOrHTTPProtocol(URL url)

Return true if the protocol is a file, http, or https protocol.

Parameters:

url - the URL

Returns:

true if the protocol is a file, http, or https protocol

isHTTPSProtocol

public static boolean isHTTPSProtocol(URL url)

Return true if the protocol is a https protocol.

Parameters:

url - the URL

Returns:

true if the protocol is a https protocol.

isHTTPProtocol

public static boolean isHTTPProtocol(URL url)

Return true if the protocol is a http, or https protocol.

Parameters:

url - the URL

Returns:

true if the protocol is a http, or https protocol.

isHTTPSProtocol

public static boolean isHTTPSProtocol(String path)

Return true if the protocol is a https protocol.

Parameters:

path - the path

Returns:

true if the protocol is a https protocol

isHTTPProtocol

public static boolean isHTTPProtocol(String path)

Return true if the protocol is a http, or https protocol.

Parameters:

path - the path

Returns:

true if the protocol is a http, or https protocol

checkFilePermissions

public static boolean checkFilePermissions()

Return true if the application has the right to get Files in the local network.

Returns:

true if the application has the right to get Files in the local network

exist

public static boolean exist(URL url)

Return true if the URL or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets. The method used to check the URL availability defer to exist(java.net.URL, short) with the OPTION_FILEEXIST_READ option.

Parameters:

url - the URL

Returns:

true if the file or the resource denoted by this URL exist

exist

public static boolean exist(URL url,
                            short option)

Return true if the file or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets.

Parameters:

url - the URL

option - the option to detected if the file exist. The following optinos are available:

• OPTION_FILEEXIST_READ: by trying to read the beginning of the file
• OPTION_FILEEXIST_LENGTH: by getting a not null length for the file
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist
• OPTION_FILEEXIST_HTTP_FORCETRUE: by considering that URL which point to http or https resources exist (if queries or php resources areot skipped)

Returns:

true if the file or the resource denoted by this URL exist

exist

public static boolean exist(URL url,
                            int option)

Return true if the file or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets.

Parameters:

url - the URL

option - the option to detected if the file exist. The following optinos are available:

• OPTION_FILEEXIST_READ: by trying to read the beginning of the file
• OPTION_FILEEXIST_LENGTH: by getting a not null length for the file
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist
• OPTION_FILEEXIST_HTTP_FORCETRUE: by considering that URL which point to http or https resources exist (if queries or php resources areot skipped)

Returns:

true if the file or the resource denoted by this URL exist

exist

public static boolean exist(File file)

Return true if the file or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets. The method used to check the file availability defer to exist(java.io.File, short) with the OPTION_FILEEXIST_READ option.

Parameters:

file - the file

Returns:

true if the file or the resource denoted by this URL exist

exist

public static boolean exist(File file,
                            short option)

Return true if the file or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets.

Parameters:

file - the file

option - the option to detected if the file exist. The following options are available:

• OPTION_FILEEXIST_READ: by trying to read the beginning of the file
• OPTION_FILEEXIST_LENGTH: by getting a not null length for the file

Returns:

true if the file or the resource denoted by this URL exist

exist

public static boolean exist(File file,
                            int option)

Return true if the file or the resource denoted by this URL exist. Remark that this method will return false if the URL is null. Note that this method does not use the File.exist() method, so it will work on sandboxed environments like Applets.

Parameters:

file - the file

option - the option to detected if the file exist. The following options are available:

• OPTION_FILEEXIST_READ: by trying to read the beginning of the file
• OPTION_FILEEXIST_LENGTH: by getting a not null length for the file

Returns:

true if the file or the resource denoted by this URL exist

getJarEntryURL

public static URL getJarEntryURL(URL url,
                                 String entryPath)
                          throws MalformedURLException

Return an URL corresponding to an entry in a Jar file.

Parameters:

url - the parent URL

entryPath - the path of the child relative to the parent

Returns:

the child URL

Throws:

MalformedURLException - if the resulting URL is invalid, or the protocol is not file:

getJarEntryURL

public static URL getJarEntryURL(URL url,
                                 String entryPath,
                                 URLStreamHandler handler)
                          throws MalformedURLException

Return an URL corresponding to an entry in a Jar file.

Parameters:

url - the parent URL

entryPath - the path of the child relative to the parent

handler - the URLStreamHandler

Returns:

the child URL

Throws:

MalformedURLException - if the resulting URL is invalid, or the protocol is not file:

getChildURL

public static URL getChildURL(URL parentURL,
                              String path,
                              int options)

Return an URL by its relative path from a parent URL. Special characters will be escaped.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

options - the options. The following options are available:

• OPTION_CHILDURL_ESCAPE: if space characters will be escaped
• OPTION_CHILDURL_FILTEREXIST: if not existing resources will be filtered
• OPTION_CHILDURL_FILTEREXIST_FILE: if not existing non http resources will be filtered
• OPTION_CHILDURL_FILTEREXIST_HTTP: if not existing http resources will be filtered

Returns:

the child URL

getChildURL

public static URL getChildURL(URL parentURL,
                              String path)

Return an URL by its relative path from a parent URL. Special characters will be escaped.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

Returns:

the child URL

getChildURL

public static URL getChildURL(URL parentURL,
                              String path,
                              boolean filterExistingURLs)

Return an URL by its relative path from a parent URL. Spaces in paths will be escaped by a "%20" String.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

filterExistingURLs - if true, return true if the resulting URL does not exist

Returns:

the child URL

getChildURL

public static URL getChildURL(URL parentURL,
                              String path,
                              boolean filterExistingURLs,
                              boolean escape)

Return an URL by its relative path from a parent URL.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

filterExistingURLs - if true, return true if the resulting URL does not exist

escape - true if spaces in file paths must be escaped by a "%20" String

Returns:

the child URL

getParentURL

public static URL getParentURL(URL url)

Return the parent URL of a given URL.

Parameters:

url - the URL

Returns:

the parent URL

getParentURL

public static URL getParentURL(URL url,
                               boolean endSeparator)

Return the parent URL of a given URL.

Parameters:

url - the URL

endSeparator - true if an end separator ("/") must be added at the end of the parent path

Returns:

the parent URL

normalize

public static URL normalize(URL url)

Normalize an URL by removing "." and ".." in the path part of the URL. Note that in some cases the URI.normalize() method does not normalize some URIs. This method will never throw a MalformedURLException but instead return the initial URL in this case.

Parameters:

url - the URL

Returns:

the normalized URL

getDirectory

public static File getDirectory(String path)

Get the directory whose name is defined by path. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path

. If path is not a directory, the parent file will be returned.

Parameters:

path - the path

Returns:

the directory whose name is defined by path

getFileNameBody

public static String getFileNameBody(File file)

Return the body name of a File (before the extension if there is an extension, else this is the name of the file itself).

Parameters:

file - the File

Returns:

the body name of the File

getFileNameBody

public static String getFileNameBody(URL url)

Return the body name of a URL (before the extension if there is an extension, else this is the name of the file itself).

Parameters:

url - the URL

Returns:

the body name of the URL

getFileName

public static String getFileName(File file)

Return the file name without the path, nor the extension. For example the File "C:/myDir/myFile.xml" will return myFile.

Parameters:

file - the File

Returns:

the file name without the path, nor the extension

fixURLPath

public static URL fixURLPath(URL url)

Filter a path name for an URL, replacing spaces characters by their percent encoding equivalent.

Parameters:

url - the url

Returns:

the path after replacing spaces characters by their percent encoding equivalent

encodeURL

public static String encodeURL(String path)

Filter a path name for an URL, replacing spaces characters by their percent encoding equivalent.

Parameters:

path - the path

Returns:

the path after replacing spaces characters by their percent encoding equivalent

replaceEscapedSequences

public static String replaceEscapedSequences(String path,
                                             boolean keepEscapedSpaces)

Replace the percent-encoding escape sequences in a URL path by their equivalent characters.

Parameters:

path - the path

keepEscapedSpaces - allow to keep the escaping of spaces (%20)

Returns:

the path after replacing the percent-encoding escape sequences by their equivalent characters

replaceEscapedSequences

public static String replaceEscapedSequences(String path)

Replace the percent-encoding escape sequences in a URL path by their equivalent characters.

Parameters:

path - the path

Returns:

the path after replacing the percent-encoding escape sequences by their equivalent characters

getFileNameWithExtension

public static String getFileNameWithExtension(File file)

Return the file name without the path, but keeping the extension. For example the File "C:/myDir/myFile.xml" will return myFile.xml.

Parameters:

file - the File

Returns:

the file name without the path, but keeping the extension

getFileNameWithExtension

public static String getFileNameWithExtension(URL url)

Return the URL name without the path, but keeping the extension. For example the URL "file:///C:/myDir/myFile.xml" will return myFile.xml.

Parameters:

url - the URL

Returns:

the URL name without the whole body

getFileName

public static String getFileName(URL url)

Return the URL name without the path, nor the extension. For example the URL "file:///C:/myDir/myFile.xml" will return myFile.

Parameters:

url - the URL

Returns:

the URL name without the extension

getFileExtension

public static String getFileExtension(File file)

Return the extension of a File.

Parameters:

file - the File

Returns:

the File extension of the file, or null if the file does not have an extension

getFileExtension

public static String getFileExtension(URL url)

Return the extension of a URL.

Parameters:

url - the URL

Returns:

the File extension of the URL, or null if the URL does not have an extension

getFile

public static File getFile(URL url)

Return a File for an URL, replacing percent encoding characters by their equivalent characters.

Parameters:

url - the URL

Returns:

the associated file, or null if the syntax of the associated URI is incorrect, or if the file does not exist

isDirectory

public static boolean isDirectory(URL url)

Return true if an URL correspond to a directory, including directories in jar or zip files.

Parameters:

url - the URL

Returns:

true if the URL correspond to a directory

getChildren

public static List<URL> getChildren(URL url,
                                    boolean strict)

Return the list of children of a URL designing a directory, including directories in jar or zip files.

Use Cases

For normal files

In normal cases (if the URL is not a zip file, and is not inside a zip or jar file), the method will return the same result as File.listFiles(), in a List rather than an array.

For zip or jar files

If the file is a zip or jar file, and the strict parameter is false, it will return the first level entries of the zip file. For example, for this zip file:

 myZipFile.zip
 ==> entry1
 ==> entry2
 ==> directory1/entry3
 ==> directory1/entry4
 

The method will return the following list:

• The URL for myZipFile.zip!entry1
• The URL for myZipFile.zip!entry2
• The URL for myZipFile.zip!directory1

For URL entries in zip or jar files

If the file is an URL entry in a zip or jar file it will return the first level entries of this entry. For example, for this zip file:

 myZipFile.zip
 ==> entry1
 ==> entry2
 ==> directory1/entry3
 ==> directory1/entry4
 

The method will return the following list for the URL for the myZipFile.zip!directory1/ entry:

• The URL for myZipFile.zip!entry1
• The URL for myZipFile.zip!entry2

Note that in all cases, it is perfectly possible to reuse an URL returned by the method:

• To open the URL as a Stream if it correspond to an existing entry
• To apply this method with one of the returned URLs

Parameters:

url - the URL

strict - true if children in jar or zip files should not be taken into account, except if the parent URL is itself a child of a zip or jar file

Returns:

the list of children

getFile

public static File getFile(String path)

Return the File whose name is defined by path. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path

Parameters:

path - the path

Returns:

the File

getEscapedName

public static String getEscapedName(String name)

Return a name without blank, and containing only ASCII characters.

Parameters:

name - the name

Returns:

the escape name

getFile

public static File getFile(File dir,
                           String path)

Return the File whose name is defined by path, and which may be defined relative to a parent directory. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path

Parameters:

dir - the base directory

path - the path

Returns:

the File

createFile

public static File createFile(File dir,
                              String path)

Create the File whose name is defined by path, and which may be defined relative to a parent directory. This method will return null if one of these conditions is true:

• path is null
• path is not absolute, and dir does not exist or is not a directory

Parameters:

dir - the base directory

path - the path

Returns:

the File

getProtectedURL

public static URL getProtectedURL(File file)
                           throws MalformedURLException

Return the URL corresponding to a File, avoiding to throw a SecurityException in secured environments like Applets.

Parameters:

file - the file

Returns:

the URL corresponding to the File

Throws:

MalformedURLException - if the conversion to an URL of the File lead to a MalformedURLException

getURL

public static URL getURL(File baseDir,
                         String path)
                  throws MalformedURLException

Return the URL whose name is defined by path. The path can be defined as a URL, or as a relative or absolute File. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path or URL protocol

If the baseDir does not exist, or the path points to a non existing File, the method will just return a null URL. Otherwise, a MalformedURLException will be thrown if the path itself is not correctly defined.

Parameters:

baseDir - the base directory

path - the relative or absolute path

Returns:

the resulting URL

Throws:

MalformedURLException - if the conversion to an URL of the path lead to a MalformedURLException

getAbsolutePath

public static String getAbsolutePath(File baseDir,
                                     String path)
                              throws MalformedURLException

Return the absolute path of an URL, using the file separator of the platform. The path can be defined as a URL, or as a relative or absolute File. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path or URL protocol

If the baseDir does not exist, or the path points to a non existing File, the method will just return a null URL. Otherwise, a MalformedURLException will be thrown if the path itself is not correctly defined.

Parameters:

baseDir - the base directory

path - the relative or absolute path

Returns:

the path

Throws:

MalformedURLException - if the conversion to an URL of the path lead to a MalformedURLException

getAbsolutePath

public static String getAbsolutePath(File baseDir,
                                     String path,
                                     boolean filterExistingURLs)
                              throws MalformedURLException

Return the absolute path of an URL, using the file separator of the platform. The path can be defined as a URL, or as a relative or absolute File. This method will return null if one of these conditions is true:

• path is null
• path does not define an existing file path or URL protocol

If filterExistingURLs is true;

• If the baseDir does not exist, or the path points to a non existing File, the method will just return an empty String

Otherwise, a MalformedURLException will be thrown if the path itself is not correctly defined.

Parameters:

baseDir - the base directory

path - the relative or absolute path

filterExistingURLs - if true, return true for a not existing URLs

Returns:

the path

Throws:

MalformedURLException - if the conversion to an URL of the path lead to a MalformedURLException

getURL

public static URL getURL(File baseDir,
                         String path,
                         boolean filterExistingURLs)
                  throws MalformedURLException

Return the URL whose name is defined by path. The path can be defined as a URL, or as a relative or absolute File. This method will return null if one of these conditions is true :

• path is null
• path does not define an existing file path or URL protocol

If filterExistingURLs is true;

• If the baseDir does not exist, or the path points to a non existing File, the method will just return a null URL

Otherwise, a MalformedURLException will be thrown if the path itself is not correctly defined.

Parameters:

baseDir - the base directory

path - the relative or absolute path

filterExistingURLs - if true, return true for a not existing URLs

Returns:

the resulting URL

Throws:

MalformedURLException - if the conversion to an URL of the path lead to a MalformedURLException

isAbsolute

public static boolean isAbsolute(String path)

Return true if a path is absolute.

Parameters:

path - the path

Returns:

true if the path is absolute

isAbsoluteURI

public static boolean isAbsoluteURI(String path)

Return true if an URI path is absolute.

Parameters:

path - the URI path

Returns:

true if the URI is absolute

getAbsolutePath

public static String getAbsolutePath(URL baseURL,
                                     String relativePath)

Return the absolute path of an URL, using the file separator of the platform. If the relativePath if already absolute, the parent baseURL will not be used, else the path will be constructed using the baseURL and the relativePath.

Parameters:

baseURL - the base URL

relativePath - the relative path

Returns:

the path

getAbsoluteURL

public static URL getAbsoluteURL(URL baseURL,
                                 String relativePath)

Return the File corresponding to a String-defined path, that can be defined as absolute, or as relative to a base directory. The file can also be an URL corresponding to an HTTP protocol. If the relativePath if already absolute, the parent baseURL will not be used, else the resulting URL will be constructed using the baseURL and the relativePath.

Parameters:

baseURL - the base URL

relativePath - the relative path

Returns:

the resulting URL

makeAbsoluteURLPath

public static URL makeAbsoluteURLPath(String path)
                               throws MalformedURLException

Create an URL from a path, removing the relative delimiters. For example, the "L://my/path/../file.xml" path will return the "file:/L://my/file.xml" URL.

Parameters:

path - the path

Returns:

the URL

Throws:

MalformedURLException

getAbsoluteFile

public static File getAbsoluteFile(File baseDir,
                                   String relativePath)

Return the File corresponding to a String-defined path, that can be defined as absolute, or as relative to a base directory. The file can also be an URL corresponding to an HTTP protocol.

Parameters:

baseDir - the base directory

relativePath - the relative path

Returns:

the resulting File

getCompatibleFile

public static File getCompatibleFile(File file,
                                     String[] exts)

Return a File abstract representation, making sure that it have the desired extension.

Parameters:

file - the File

exts - the array of allowed extensions

Returns:

a File which is the same as the inpout file if it has one of the allowed extensions, or a File constructed to have the first extension

getCompatibleFile

public static File getCompatibleFile(File file,
                                     String[] exts,
                                     String defaultExt)

Return a File abstract representation, making sure that it have the desired extension.

Parameters:

file - the File

exts - the array of allowed extensions

defaultExt - the default extension

Returns:

a File which is the same as the inpout file if it has one of the allowed extensions, or a File constructed to have the default extension

getCompatibleFile

public static File getCompatibleFile(File file,
                                     String ext)

Return a File abstract representation, making sure that it have the desired extension.

Parameters:

file - the File

ext - the of allowed extension

Returns:

a File which is the same as the inpout file if it has one of the allowed extensions, or a File constructed to have the extension

getText

public static String getText(File file)
                      throws IOException

Return the text corresponding to a File.

Parameters:

file - the File

Returns:

the File content as text

Throws:

IOException

getText

public static String getText(URL url)
                      throws IOException

Return the text corresponding to a URL.

Parameters:

url - the URL

Returns:

the File content as text

Throws:

IOException

getFilesFromURLList

public static File[] getFilesFromURLList(List<URL> list)

Return a list of Files defined by their list of URLs. Note that even URL which do not exist on the network will still be added to the result.

Parameters:

list - the list of URLs

Returns:

the associated Files array

getFilesFromURLList

public static File[] getFilesFromURLList(List<URL> list,
                                         boolean filterExistingURLs)

Return a list of Files defined by their list of URLs.

Parameters:

list - the list of URLs

filterExistingURLs - true if only URL which exist on the network will be added to the result

Returns:

the associated Files array

getURLListFromFiles

public static List<URL> getURLListFromFiles(File[] files)

Return a list of URLs defined by their list of Files. Note that even Files which do not exist on the network will still be added to the result.

Parameters:

files - the FIles array

Returns:

the list of URLs

getURLListFromFiles

public static List<URL> getURLListFromFiles(File[] files,
                                            boolean filterExistingFiles)

Return a list of URLs defined by their list of Files.

Parameters:

files - the list of Files

filterExistingFiles - true if only Files which exist on the network will be added to the result

Returns:

the list of URLs

getURLsFromString

public static List<URL> getURLsFromString(File baseDir,
                                          String urlList)
                                   throws MalformedURLException

Return a List of URLs from a String separated with a ";".

Parameters:

baseDir - the base directory

urlList - the list of URLs as a String separated with a ";"

Returns:

the list of URLs

Throws:

MalformedURLException - if the conversion to an URL of one of the Strings lead to a MalformedURLException

getURLsFromString

public static List<URL> getURLsFromString(File baseDir,
                                          String urlList,
                                          boolean filterExistingURLs)
                                   throws MalformedURLException

Return a List of URLs from a String separated with a ";".

Parameters:

baseDir - the base directory

urlList - the list of URLs as a String separated with a ";"

filterExistingURLs - if true, remove not existing URLs from the list

Returns:

the list of URLs

Throws:

MalformedURLException - if the conversion to an URL of one of the Files lead to a MalformedURLException

getURLsFromString

public static List<URL> getURLsFromString(URL baseDir,
                                          String urlList)
                                   throws MalformedURLException

Return a List of URLs from a String separated with a ";".

Parameters:

baseDir - the base directory

urlList - the list of URLs as a String separated with a ";"

Returns:

the list of URLs

Throws:

MalformedURLException - if the conversion to an URL of one of the Files lead to a MalformedURLException

getURLsFromString

public static List<URL> getURLsFromString(URL baseDir,
                                          String urlList,
                                          boolean filterExistingURLs)
                                   throws MalformedURLException

Return a List of URLs from a String separated with a ";".

Parameters:

baseDir - the base directory

urlList - the list of URLs as a String separated with a ";"

filterExistingURLs - if true, remove not existing URLs from the list

Returns:

the list of URLs

Throws:

MalformedURLException

getURLs

public static URL[] getURLs(File dir,
                            String paths)

Return a list of URLs from a String. For example: "url1;url2" will return an array of url1, url2.

Parameters:

dir - the base directory

paths - the list of URLs as a String separated by ";"

Returns:

the list of URLs

getURLs

public static URL[] getURLs(File dir,
                            String paths,
                            boolean filterExistingURLs)

Return a list of URLs from a String. For example: "url1;url2" will return an array of url1, url2.

Parameters:

dir - the base directory

paths - the list of URLs as a String separated by ";"

filterExistingURLs - if true, remove not existing URLs from the list

Returns:

the list of URLs

isAncestor

public static boolean isAncestor(File ancestor,
                                 File file)

Return true if a file is an ancestor of another file.

Parameters:

ancestor - the ancestor file

file - the file

Returns:

true if the ancestor file is an ancestor of file

isAncestor

public static boolean isAncestor(URL ancestor,
                                 URL url)

Return true if an URL is an ancestor of another URL.

Parameters:

ancestor - the ancestor URL

url - the URL

Returns:

true if the ancestor URL is an ancestor of url

isRelativeTo

public static boolean isRelativeTo(File baseDir,
                                   File file)

Return true if a file is relative to a directory (that is: the directory is one of the file ancestors).

Parameters:

baseDir - the directory

file - the file

Returns:

true if the file is relative to the directory

getRelativePath

public static String getRelativePath(URL baseURL,
                                     URL url)

Return the path of an URL relative to a directory. Defer to getRelativePath(java.net.URL, java.net.URL, boolean) with the strict parameter set to true.

Parameters:

baseURL - the base directory

url - the URL

Returns:

the path of the URL relative to the directory

getDrive

public static String getDrive(File file)

Return the drive name of a file.

Parameters:

file - the file

Returns:

the drive name of the file

getRelativePath

public static String getRelativePath(URL baseURL,
                                     URL url,
                                     boolean strict)

Return the path of an URL relative to a directory.

Parameters:

baseURL - the base directory

url - the URL

strict - true if this will fall back to the absolute path of the URL if the File is not under the base directory. If this parameter is true, this will have the same result as getRelativePath(java.io.File, java.io.File)

Returns:

the path of the URL relative to the directory

getRelativePath

public static String getRelativePath(File baseDir,
                                     File file)

Return the path of a File relative to a directory. This will fall back to the absolute path of the File if the File is not under the base directory. Defer to getRelativePath(java.io.File, java.io.File, boolean) with the strict parameter set to true.

Parameters:

baseDir - the base directory

file - the File

Returns:

the path of the File relative to the directory

isRoot

public static boolean isRoot(File dir)

Return true if a directory is a root of the file system.

Parameters:

dir - the directory

Returns:

true if the directory is a root of the file system.

getRelativePath

public static String getRelativePath(File baseDir,
                                     File file,
                                     boolean strict)

Return the path of a File relative to a directory.

Parameters:

baseDir - the base directory

file - the File

strict - true if this will fall back to the absolute path of the File if the File is not under the base directory. If this parameter is true, this will have the same result as getRelativePath(java.io.File, java.io.File)

Returns:

the path of the File relative to the directory

collapse

public static URL collapse(URL url)
                    throws MalformedURLException

Collapse an URL to a representation without any .. constructs.

Parameters:

url - the URL

Returns:

the collapse URL representation

Throws:

MalformedURLException - if the collapsing of the URL leads to a malformed URL (this should normally never happen, except if the input URL is itself Malformed)

sameURL

public static boolean sameURL(URL url1,
                              URL url2)

Check if two URLs are the same, taking into account double slash and .. constructs.

Parameters:

url1 - the first URL

url2 - the second URL

Returns:

true if the two URL representations represent the same URL

getResponseCode

public static int getResponseCode(URL url,
                                  Proxy proxy)
                           throws IOException

Return the response code for an URL, without using a timeOut. Some of the following codes can occur:

• 200: the standard response for successful HTTP requests
• 404: the URL was not found
• 403: the request was valid but access to the URL is forbidden
• ...
• -1 will be returned for an URL which does not correspond to an URL connection

The complete list of HTTP return codes can be found on wikipedia here: List_of_HTTP_status_codes. Note that if the request timeOut, the method will return a 404 code.

Parameters:

url - the URL

proxy - the proxy (can be null, in that case no proxy will be used)

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

getResponseCode

public static int getResponseCode(URL url,
                                  Proxy proxy,
                                  int timeOut)
                           throws IOException

Return the response code for an URL. Some of the following codes can occur:

• 200: the standard response for successful HTTP requests
• 404: the URL was not found
• 403: the request was valid but access to the URL is forbidden
• ...
• -1 will be returned for an URL which does not correspond to an URL connection

The complete list of HTTP return codes can be found on wikipedia here: List_of_HTTP_status_codes. Note that if the request timeOut, the method will return a 404 code.

Parameters:

url - the URL

proxy - the proxy (can be null, in that case no proxy will be used)

timeOut - the timeOut (-1 for no timeOut)

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

getResponseCode

public static int getResponseCode(URL url,
                                  Proxy proxy,
                                  String userAgent)
                           throws IOException

Return the response code for an URL, witbout using a timeOut.

Parameters:

url - the URL

proxy - the proxy (can be null, in that case no proxy will be used)

userAgent - the user agent. If the user agent is null, the FIREFOX10_USERAGENT will be used by default

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

See Also:

getResponseCode(java.net.URL, java.net.Proxy, java.lang.String, int)

getResponseCode

public static int getResponseCode(URL url,
                                  Proxy proxy,
                                  String userAgent,
                                  int timeOut)
                           throws IOException

Return the response code for an URL. Some of the following codes can occur:

• 200: the standard response for successful HTTP requests
• 404: the URL was not found
• 403: the request was valid but access to the URL is forbidden
• ...
• -1 will be returned for an URL which does not correspond to an URL connection

The complete list of http return codes can be found on wikipedia here: List_of_HTTP_status_codes. Note that if the request timeOut, the method will return a 404 code.

Algorithm

For local URLs, the method will just return -1. For http or https URLs, the method will:

• Open an HttpURLConnection on the URL
• Send the "GET" method on this connection
• Return the connection status code

Parameters:

url - the URL

proxy - the proxy (can be null, in that case no proxy will be used)

userAgent - the user agent. If the user agent is null, the FIREFOX10_USERAGENT will be used by default

timeOut - the timeOut (-1 for no timeOut)

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

getResponseCode

public static int getResponseCode(URL url)
                           throws IOException

Return the response code for an URL, without a proxy.

Parameters:

url - the URL

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

See Also:

getResponseCode(java.net.URL, java.net.Proxy, int)

getResponseCode

public static int getResponseCode(URL url,
                                  int timeOut)
                           throws IOException

Return the response code for an URL, without a proxy.

Parameters:

url - the URL

timeOut - the timeOut (-1 for no timeOut)

Returns:

the response code

Throws:

IOException - if an I/O exception occurs

See Also:

getResponseCode(java.net.URL, java.net.Proxy)

isArchive

public static boolean isArchive(URL url)

Return true if an url is an archive.

Parameters:

url - the url

Returns:

true if the url is an archive

isArchive

public static boolean isArchive(File f)

Return true if a File is an archive.

Parameters:

f - the File

Returns:

true if the File is an archive

isURLFound

public static boolean isURLFound(URL url)

Return true if an URL is found, without using a timeOut. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int) with no proxy and a default FireFox 10 User Agent. For this method, 301 or 308 return codes will be accepted as valid responses (URL found).

Parameters:

url - the URL

Returns:

true if the URL is found

See Also:

isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int)

isURLFound

public static boolean isURLFound(URL url,
                                 int options)

Return true if an URL is found, without using a timeOut. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int) with no proxy and a default FireFox 10 User Agent.

Options

There are several options that can be used to check the existence of the URL:

• OPTION_ACCEPT301CODE: if 301 or 308 return codes will be accepted as valid responses (URL found)
• OPTION_FOLLOWREDIRECT: if redirection links will be followed and used to check that the links exists
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist

These options are not mutually incompatible. You can do for example:

 boolean found = isURLFound(url, FileUtilities.OPTION_ACCEPT301CODE | FileUtilities.OPTION_FOLLOWREDIRECT);
 

Parameters:

url - the URL

options - the options

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 int options,
                                 int timeOut)

Return true if an URL is found. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int) with no proxy and a default FireFox 10 User Agent.

Options

There are several options that can be used to check the existence of the URL:

• OPTION_ACCEPT301CODE: if 301 or 308 return codes will be accepted as valid responses (URL found)
• OPTION_FOLLOWREDIRECT: if redirection links will be followed and used to check that the links exists
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist

These options are not mutually incompatible. You can do for example:

 boolean found = isURLFound(url, FileUtilities.OPTION_ACCEPT301CODE | FileUtilities.OPTION_FOLLOWREDIRECT);
 

Parameters:

url - the URL

options - the options

timeOut - the timeOut (-1 for no timeOut)

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy)

Return true if an URL is found, without using a timeOut. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String, int, int) with a default FireFox 10 User Agent. For this method, 301 or 308 return codes will be accepted as valid responses (URL found).

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy,
                                 int timeOut)

Return true if an URL is found. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String) with a default FireFox 10 User Agent. For this method, 301 or 308 return codes will be accepted as valid responses (URL found).

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

timeOut - the timeOut (-1 for no timeOut)

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy,
                                 int options,
                                 int timeOut)

Return true if an URL is found. It can be a local File or an http or https URL. Defer to isURLFound(java.net.URL, java.net.Proxy, java.lang.String) with a default FireFox 10 User Agent.

Options

There are several options that can be used to check the existence of the URL:

• OPTION_ACCEPT301CODE: if 301 or 308 return codes will be accepted as valid responses (URL found)
• OPTION_FOLLOWREDIRECT: if redirection links will be followed and used to check that the links exists
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist

These options are not mutually incompatible. You can do for example:

 boolean found = isURLFound(url, FileUtilities.OPTION_ACCEPT301CODE | FileUtilities.OPTION_FOLLOWREDIRECT);
 

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

options - the options

timeOut - the timeOut (-1 for no timeOut)

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy,
                                 String userAgent)

Return true if an URL is found, without using a timeOut. For this method, 301 or 308 return codes will be accepted as valid responses (URL found).

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

userAgent - the user agent. If the user agent is null, the FIREFOX10_USERAGENT will be used by default

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy,
                                 String userAgent,
                                 int timeOut)

Return true if an URL is found. For this method, 301 or 308 return codes will be accepted as valid responses (URL found).

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

userAgent - the user agent. If the user agent is null, the FIREFOX10_USERAGENT will be used by default

timeOut - the timeOut (-1 for no timeOut)

Returns:

true if the URL is found

isURLFound

public static boolean isURLFound(URL url,
                                 Proxy proxy,
                                 String userAgent,
                                 int options,
                                 int timeOut)

Return true if an URL is found. It can be a local File or an http or https URL.

Algorithm

For local URLs, the method will just check if the URL exists and is a File. For http or https URLs, the method will perform the following algorithm:

• Open an HttpURLConnection on the URL
• Send the "GET" method on this connection
• Return the connection status code
• Check the status code value and the content of the returned URL

Checking http or https status code

For http and https protocols, the expected status codes for found URLs are:

• 200: The standard response for successful http requests. In that case the URL will be considered to be found
• 301: Permanent URL redirection, meaning current links or records using the URL that the response is received for should be updated. It is usually the case for http URLs which should be updated to https. If accept301Code is set to false, this will lead to return false
• 308: Permanent redirect, similar to 301

Note that if the request timeOut, the method will return false. For 301 and 308 response codes, the path content of the returned URL for the HttpURLConnection will be checked:

• If the paths of the input URL and the returned URLs are identical, the URL is considered to be found
• If the paths of the input URL and the returned URLs are different, the URL is considered not to be found

Options

There are several options that can be used to check the existence of the URL:

• OPTION_ACCEPT301CODE: if 301 or 308 return codes will be accepted as valid responses (URL found)
• OPTION_FOLLOWREDIRECT: if redirection links will be followed and used to check that the links exists
• OPTION_FILEEXIST_SKIP_QUERIES: by considering that URL with queries don't exist
• OPTION_FILEEXIST_SKIP_PHP: by considering that URL which point to php resources don't exist

These options are not mutually incompatible. You can do for example:

 boolean found = isURLFound(url, FileUtilities.OPTION_ACCEPT301CODE | FileUtilities.OPTION_FOLLOWREDIRECT);
 

For example:

• "http://docs.oracle.com/javase/8/docs/api/java/awt/Button.html": this link is found with a 301 code and the redirection links to the same link with an https protocol, it will be considered as existing
• "http://docs.oracle.com/javase/8/docs/api/java/awt/Button1111.html": this link is found with a 301 code and the redirection links to a special 404 Oracle link, it will be considered as not existing

Examples

If the input URL is "http://en.wikpedia.org/wiki/markdown", the wikipedia server will return "http://en.wikipedia.org/" with a 301 response code. In that case the two paths differ, so the method will return false. If the input URL is "http://www.flickr.com", the flickr server will return "http://www.flickr.com" with a 301 response code. In that case the two paths are identical, so the method will return true.

Parameters:

url - the URL

proxy - the proxy for http URLs (can be null, in that case no proxy will be used)

userAgent - the user agent. If the user agent is null, the FIREFOX10_USERAGENT will be used by default

options - the options

timeOut - the timeOut (-1 for no timeOut)

Returns:

true if the URL is found

getRedirectURL

public static URL getRedirectURL(URL url)
                          throws IOException

Return the final URL after applying all the possible redirections. The initial provided URL will be returned if:

• The protocol is neither "http" nor "https"
• or there are no redirections

A null URL will be returned if:

• The protocol is "http" nor "https" and the URL is not found

Parameters:

url -

Returns:

the final URL after applying all the possible redirections

Throws:

IOException