com.lf.vfslib.net

Class VFSUtils

java.lang.Object

com.lf.vfslib.net.VFSUtils

public class VFSUtils
extends Object

This class holds various methods for common use with Apache Commons VFS networking.

Since:

1.6

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
VFSUtils() Constructor method for i18n purposes only.

Method Summary

Modifier and Type	Method and Description
static String	addMissingCredentials(String uri, VFSConnection vfsconn) Convenience to automatically apply user and password defined for a connection.
static boolean	available(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL is currently available (like a PING check).
static Boolean	canRead(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL can be read.
static boolean	canRead(org.apache.commons.vfs2.FileObject url, boolean fallback) Safely gets the info if the URL can be read.
static Boolean	canWrite(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL can be written.
static boolean	canWrite(org.apache.commons.vfs2.FileObject url, boolean fallback) Safely gets the info if the URL can be written.
static void	clearDirectory(org.apache.commons.vfs2.FileObject target) Tries to remove all directories and files from a given directory.
static void	collectEntries(org.apache.commons.vfs2.FileObject searchdir, Vector<org.apache.commons.vfs2.FileObject> entries) Searches the given directory recursively for files and directories adds the results to the container.
static boolean	compareContents(org.apache.commons.vfs2.FileObject url, File file) Checks if the given network file contents is equal to the given local file.
static boolean	contains(Vector<org.apache.commons.vfs2.FileObject> container, org.apache.commons.vfs2.FileObject url) Checks, if the given container holds the given URL.
static String	debugPrint(org.apache.commons.vfs2.FileSystemOptions options) Prints file system specific options for a connection.
static String	debugPrintFileName(org.apache.commons.vfs2.FileObject url) Provides a name without passwords to be displayed, logged etc.
static boolean	delete(org.apache.commons.vfs2.FileObject target) Tries to delete the given network file/directory (directory must be empty).
static void	deleteAll(org.apache.commons.vfs2.FileObject target) Tries to delete the given network directory recursively.
static Boolean	exists(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL exists.
static boolean	exists(org.apache.commons.vfs2.FileObject url, boolean fallback) Safely gets the info if the URL exists.
static VFSConnection	findVFSConnection(VFSFileSystemManager vfsmanager, String id) Determines the VFS connection associated with the given ID.
static VFSConnection[]	findVFSConnections(VFSFileSystemManager vfsmanager, org.apache.commons.vfs2.FileObject entry) Determines the VFS connections which can be used to show the given network file.
static VFSConnection[]	findVFSConnections(VFSFileSystemManager vfsmanager, String url) Determines the VFS connections which can be used to show the given network file.
static String	getCapabilityDescription(org.apache.commons.vfs2.Capability capa) Provides the user language description of the given file system capability.
static org.apache.commons.vfs2.FileObject[]	getChildren(org.apache.commons.vfs2.FileObject directory) Provides the children found in a directory.
static org.apache.commons.vfs2.FileObject[]	getChildren(org.apache.commons.vfs2.FileObject directory, org.apache.commons.vfs2.FileObject[] fallback) Provides the children found in a directory.
static int	getDefaultPort(String protocol) Provides the numerical port number appropriate for the given VFS protocol/scheme.
static String	getDisplayBaseName(org.apache.commons.vfs2.FileObject url, VFSConnection vfsconn) Provides the base name of the given URL (without path, credentials etc.).
static String	getDisplayPath(org.apache.commons.vfs2.FileObject url, VFSConnection vfsconn) Provides the path of the given URL.
static String	getDisplayURIObfuscated(org.apache.commons.vfs2.FileObject url, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static String	getDisplayURIUsernameOnly(org.apache.commons.vfs2.FileObject entry, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static String	getDisplayURIUsernameOnly(String url, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static String	getDisplayURIUsernameOnly(VFSURI entry, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static String	getDisplayURIWithoutCredentials(org.apache.commons.vfs2.FileObject url, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static String	getDisplayURIWithoutCredentials(VFSURI vfsuri, VFSConnection vfsconn) Provides a name without passwords to be displayed, logged etc.
static File	getDownloadFile(File directory, org.apache.commons.vfs2.FileObject url) Assembles the preferred target file name for downloads.
static String	getDRWX(org.apache.commons.vfs2.FileObject url) Generates the accessibility string ("drwx") for files and directories.
static Comparator<org.apache.commons.vfs2.FileObject>	getFileObjectComparator() Creates a new comparator used together with TreeMap to handle FileObject's properly.
static Long	getLength(org.apache.commons.vfs2.FileObject url) Safely gets the URL content length.
static long	getLength(org.apache.commons.vfs2.FileObject url, long fallback) Safely gets the URL content length.
static org.apache.commons.vfs2.FileObject	getParent(org.apache.commons.vfs2.FileObject url) Safely gets the URL parent folder.
static VFSURI	getParent(VFSURI child) Provides the parent directory of the given URL.
static Vector<org.apache.commons.vfs2.FileObject>	getParents(org.apache.commons.vfs2.FileObject url) Extracts the parent paths of the given URL.
static String	getProtocol(String uri) Extracts the scheme part of the given URI.
static org.apache.commons.vfs2.FileObject	getRelativeFileURL(org.apache.commons.vfs2.FileSystemManager vfsmanager, org.apache.commons.vfs2.FileObject parenturl, String relpath) Safely gets the URL assembled of parent and relative path.
static String	getRWX(org.apache.commons.vfs2.FileObject url) Generates the accessibility string ("rwx") for network files and directories.
static org.apache.commons.vfs2.FileType	getType(org.apache.commons.vfs2.FileObject url) Safely gets the entry type.
static org.apache.commons.vfs2.FileObject	getURL(org.apache.commons.vfs2.FileSystemManager vfsmanager, String url) Creates a VFS network resource object for the given path which should be a URL.
static org.apache.commons.vfs2.FileObject	getURL(VFSFileSystemManager vfsmanager, String url, VFSConnection vfsconn) Creates a VFS network resource object for the given path which should be a URL.
static Boolean	hasCapability(org.apache.commons.vfs2.FileObject url, org.apache.commons.vfs2.Capability capability) Safely gets the info if the URL file system has a certain capability.
static boolean	hasCapability(org.apache.commons.vfs2.FileObject url, org.apache.commons.vfs2.Capability capability, boolean fallback) Safely gets the info if the URL file system has a certain capability.
static boolean	hasFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions options) Any file system specific options available (internal cache not empty)?
static boolean	isChildOf(org.apache.commons.vfs2.FileObject url, org.apache.commons.vfs2.FileObject parent) Determines whether the given URL is a child of the given parent.
static boolean	isChildOf(VFSURI url, VFSURI parent) Determines whether the given URL is a child of the given parent.
static boolean	isContentLengthRequired(org.apache.commons.vfs2.FileObject url) Checks if the given protocol requires setting the VFSLibConstants.ATTR_CONTENT_LENGTH attribute.
static Boolean	isDirectory(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL is a folder/directory.
static boolean	isDirectory(org.apache.commons.vfs2.FileObject url, boolean fallback) Safely gets the info if the URL is a folder/directory.
static boolean	isDirectory(VFSURI vfsuri, boolean fallback) Safely gets the info if the URL is a folder/directory.
static boolean	isExistingFile(org.apache.commons.vfs2.FileObject url) Convenience to check if a given URL exists and is a regular file.
static Boolean	isFile(org.apache.commons.vfs2.FileObject url) Safely gets the info if the URL is a file.
static boolean	isFile(org.apache.commons.vfs2.FileObject url, boolean fallback) Safely gets the info if the URL is a file.
static boolean	isFile(VFSURI vfsuri, boolean fallback) Safely gets the info if the URL is a file.
static boolean	isParentOf(org.apache.commons.vfs2.FileObject url, org.apache.commons.vfs2.FileObject child) Determines whether the given URL is a the parent of the given child.
static boolean	isRoot(org.apache.commons.vfs2.FileObject url) Checks if the given URL is a root directory.
static boolean	isSameServer(org.apache.commons.vfs2.FileObject url1, org.apache.commons.vfs2.FileObject url2) Checks if the given network files are on the same server.
static boolean	isStateful(String protocol) Is the given VFS protocol/scheme stateful?
static Long	lastModified(org.apache.commons.vfs2.FileObject url) Safely gets the URL's last modifcation time.
static long	lastModified(org.apache.commons.vfs2.FileObject url, long fallback) Safely gets the URL's last modifcation time.
static boolean	moveToArchive(org.apache.commons.vfs2.FileObject source, String subfolder) Moves the given network file into the archive subfolder.
static InputStream	openCachedURL(org.apache.commons.vfs2.FileObject url, TreeMap<org.apache.commons.vfs2.FileObject,byte[]> urlcache, long maxsize) Opens an input stream to read URL data either from cache or directly.
static void	setLastModified(org.apache.commons.vfs2.FileObject url, long timestamp) Safely sets the URL's last modifcation time.
static boolean	writeFile(org.apache.commons.vfs2.FileObject url, InputStream istream, long length) Writes binary data into a network file.

Methods inherited from class java.lang.Object

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

Constructor Detail

VFSUtils

public VFSUtils()
         throws InstantiationException

Constructor method for i18n purposes only.

Throws:

InstantiationException - Error indication

Since:

1.6

Method Detail

getLength

public static Long getLength(org.apache.commons.vfs2.FileObject url)

Safely gets the URL content length.

Parameters:

url - The network resource to check

Returns:

The length or null if not available

Since:

1.6

getLength

public static long getLength(org.apache.commons.vfs2.FileObject url,
                             long fallback)

Safely gets the URL content length.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

The length or null if not available

Since:

1.6

lastModified

public static Long lastModified(org.apache.commons.vfs2.FileObject url)

Safely gets the URL's last modifcation time.

Parameters:

url - The network resource to check

Returns:

The last modification time or null if not available

Since:

1.6

lastModified

public static long lastModified(org.apache.commons.vfs2.FileObject url,
                                long fallback)

Safely gets the URL's last modifcation time.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

The last modification time or null if not available

Since:

1.6

setLastModified

public static void setLastModified(org.apache.commons.vfs2.FileObject url,
                                   long timestamp)

Safely sets the URL's last modifcation time.

Parameters:

url - The network resource to check

timestamp - The timestamp

Since:

1.6

isDirectory

public static Boolean isDirectory(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL is a folder/directory.

Parameters:

url - The network resource to check

Returns:

Directory? null if not available.

Since:

1.6

isDirectory

public static boolean isDirectory(org.apache.commons.vfs2.FileObject url,
                                  boolean fallback)

Safely gets the info if the URL is a folder/directory.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

Directory? null if not available.

Since:

1.6

isDirectory

public static boolean isDirectory(VFSURI vfsuri,
                                  boolean fallback)

Safely gets the info if the URL is a folder/directory.

Parameters:

vfsuri - The network resource to check

fallback - The default value

Returns:

Directory? null if not available.

Since:

1.6

isFile

public static Boolean isFile(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL is a file.

Parameters:

url - The network resource to check

Returns:

File? null if not available.

Since:

1.6

isFile

public static boolean isFile(org.apache.commons.vfs2.FileObject url,
                             boolean fallback)

Safely gets the info if the URL is a file.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

File? null if not available.

Since:

1.6

isFile

public static boolean isFile(VFSURI vfsuri,
                             boolean fallback)

Safely gets the info if the URL is a file.

Parameters:

vfsuri - The network resource to check

fallback - The default value

Returns:

File? null if not available.

Since:

1.6

getType

public static org.apache.commons.vfs2.FileType getType(org.apache.commons.vfs2.FileObject url)

Safely gets the entry type.

Parameters:

url - The network resource to check

Returns:

The type, null if not available.

Since:

2.8

exists

public static Boolean exists(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL exists.

Parameters:

url - The network resource to check

Returns:

Exists? null if not available.

Since:

1.6

exists

public static boolean exists(org.apache.commons.vfs2.FileObject url,
                             boolean fallback)

Safely gets the info if the URL exists.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

Exists? null if not available.

Since:

1.6

canRead

public static Boolean canRead(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL can be read.

Parameters:

url - The network resource to check

Returns:

Readable? null if not available.

Since:

1.6

canRead

public static boolean canRead(org.apache.commons.vfs2.FileObject url,
                              boolean fallback)

Safely gets the info if the URL can be read.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

Readable? null if not available.

Since:

1.6

canWrite

public static Boolean canWrite(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL can be written.

Parameters:

url - The network resource to check

Returns:

Writable? null if not available.

Since:

1.6

canWrite

public static boolean canWrite(org.apache.commons.vfs2.FileObject url,
                               boolean fallback)

Safely gets the info if the URL can be written.

Parameters:

url - The network resource to check

fallback - The default value

Returns:

Writable? null if not available.

Since:

1.6

hasCapability

public static Boolean hasCapability(org.apache.commons.vfs2.FileObject url,
                                    org.apache.commons.vfs2.Capability capability)

Safely gets the info if the URL file system has a certain capability.

Parameters:

url - The network resource to check

capability - The capability

Returns:

Available? null if not available.

Since:

1.6

hasCapability

public static boolean hasCapability(org.apache.commons.vfs2.FileObject url,
                                    org.apache.commons.vfs2.Capability capability,
                                    boolean fallback)

Safely gets the info if the URL file system has a certain capability.

Parameters:

url - The network resource to check

capability - The capability

fallback - The default value

Returns:

Available? null if not available.

Since:

1.6

getParent

public static org.apache.commons.vfs2.FileObject getParent(org.apache.commons.vfs2.FileObject url)

Safely gets the URL parent folder.

Parameters:

url - The network resource to check

Returns:

The parent folder or null if not available

Since:

1.6

getRelativeFileURL

public static org.apache.commons.vfs2.FileObject getRelativeFileURL(org.apache.commons.vfs2.FileSystemManager vfsmanager,
                                                                    org.apache.commons.vfs2.FileObject parenturl,
                                                                    String relpath)

Safely gets the URL assembled of parent and relative path.

Parameters:

vfsmanager - The file system manager, use default if null

parenturl - The parental network resource (folder)

relpath - The relative path

Returns:

The assembled file or null if not available

Since:

1.6

getDownloadFile

public static File getDownloadFile(File directory,
                                   org.apache.commons.vfs2.FileObject url)

Assembles the preferred target file name for downloads.

Parameters:

directory - The target directory

url - The network resource to download

Returns:

The preferred file or null if not available

Since:

1.6

openCachedURL

public static InputStream openCachedURL(org.apache.commons.vfs2.FileObject url,
                                        TreeMap<org.apache.commons.vfs2.FileObject,byte[]> urlcache,
                                        long maxsize)

Opens an input stream to read URL data either from cache or directly.

Caution: Do not use Hashtable

Parameters:

url - The network resource to check

urlcache - The download cache

maxsize - The maximum file size to be cached

Returns:

The input stream or null if not available

Since:

1.6

getURL

public static org.apache.commons.vfs2.FileObject getURL(org.apache.commons.vfs2.FileSystemManager vfsmanager,
                                                        String url)

Creates a VFS network resource object for the given path which should be a URL.

Parameters:

vfsmanager - The file system manager, use default if null

url - The network resource path

Returns:

The URL object or null if not available

Since:

1.6

getURL

public static org.apache.commons.vfs2.FileObject getURL(VFSFileSystemManager vfsmanager,
                                                        String url,
                                                        VFSConnection vfsconn)

Creates a VFS network resource object for the given path which should be a URL.

Parameters:

vfsmanager - The file system manager, use default if null

url - The network resource path

vfsconn - The connection (optional, best guess otherwise)

Returns:

The URL object or null if not available

Since:

1.6

available

public static boolean available(org.apache.commons.vfs2.FileObject url)

Safely gets the info if the URL is currently available (like a PING check).

This method works well for SFTP but not for FTP.

Parameters:

url - The network resource to check

Returns:

Available?

Since:

1.6

isChildOf

public static boolean isChildOf(org.apache.commons.vfs2.FileObject url,
                                org.apache.commons.vfs2.FileObject parent)

Determines whether the given URL is a child of the given parent.

Parameters:

url - The URL to be checked

parent - The parent URL to be checked

Returns:

Is it child?

Since:

1.6

isChildOf

public static boolean isChildOf(VFSURI url,
                                VFSURI parent)

Determines whether the given URL is a child of the given parent.

Parameters:

url - The URL to be checked

parent - The parent URL to be checked

Returns:

Is it child?

Since:

1.6

getParent

public static VFSURI getParent(VFSURI child)

Provides the parent directory of the given URL.

Parameters:

child - The child URL

Returns:

The parent URL object, null for root

Since:

1.6

getRWX

public static String getRWX(org.apache.commons.vfs2.FileObject url)

Generates the accessibility string ("rwx") for network files and directories.

Parameters:

url - The URL to be checked

Returns:

Accessibility string e. g. "rwx" or "-r-"

Since:

1.6

getDRWX

public static String getDRWX(org.apache.commons.vfs2.FileObject url)

Generates the accessibility string ("drwx") for files and directories.

Parameters:

url - The URL to be checked

Returns:

Accessibility string e. g. "drwx" (directory) or "--r-" (file)

Since:

1.6

getDisplayBaseName

public static String getDisplayBaseName(org.apache.commons.vfs2.FileObject url,
                                        VFSConnection vfsconn)

Provides the base name of the given URL (without path, credentials etc.).

Special server encodings are converted here if the connection is specified.

Parameters:

url - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayPath

public static String getDisplayPath(org.apache.commons.vfs2.FileObject url,
                                    VFSConnection vfsconn)

Provides the path of the given URL.

Special server encodings are converted here if the connection is specified.

Parameters:

url - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIObfuscated

public static String getDisplayURIObfuscated(org.apache.commons.vfs2.FileObject url,
                                             VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

Remember that exception stack traces also may contain passwords as clear text! Special server encodings are converted here if the connection is specified.

Parameters:

url - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIUsernameOnly

public static String getDisplayURIUsernameOnly(org.apache.commons.vfs2.FileObject entry,
                                               VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

This variant shows the username if it is available, but never the password. Special server encodings are converted here if the connection is specified.

Parameters:

entry - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIUsernameOnly

public static String getDisplayURIUsernameOnly(VFSURI entry,
                                               VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

This variant shows the username if it is available, but never the password. Special server encodings are converted here if the connection is specified.

Parameters:

entry - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIUsernameOnly

public static String getDisplayURIUsernameOnly(String url,
                                               VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

This variant shows the username if it is available, but never the password. Special server encodings are converted here if the connection is specified.

Parameters:

url - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIWithoutCredentials

public static String getDisplayURIWithoutCredentials(org.apache.commons.vfs2.FileObject url,
                                                     VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

Remember that exception stack traces also may contain passwords as clear text! Special server encodings are converted here if the connection is specified.

Parameters:

url - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

getDisplayURIWithoutCredentials

public static String getDisplayURIWithoutCredentials(VFSURI vfsuri,
                                                     VFSConnection vfsconn)

Provides a name without passwords to be displayed, logged etc.

Remember that exception stack traces also may contain passwords as clear text! Special server encodings are converted here if the connection is specified.

Parameters:

vfsuri - The URL

vfsconn - The connection for encoding (optional)

Returns:

The display name

Since:

1.6

debugPrintFileName

public static String debugPrintFileName(org.apache.commons.vfs2.FileObject url)

Provides a name without passwords to be displayed, logged etc.

Parameters:

url - The URL

Returns:

The text

Since:

1.6

isParentOf

public static boolean isParentOf(org.apache.commons.vfs2.FileObject url,
                                 org.apache.commons.vfs2.FileObject child)

Determines whether the given URL is a the parent of the given child.

Parameters:

url - The URL to be checked

child - The child URL to be checked

Returns:

It it parent?

Throws:

NullPointerException - If a parameter is null

Since:

1.6

getParents

public static Vector<org.apache.commons.vfs2.FileObject> getParents(org.apache.commons.vfs2.FileObject url)

Extracts the parent paths of the given URL.

Parameters:

url - The URL to be checked

Returns:

Container with parents, direct parent at index 0

Throws:

NullPointerException - If the file is null

Since:

1.6

getCapabilityDescription

public static String getCapabilityDescription(org.apache.commons.vfs2.Capability capa)

Provides the user language description of the given file system capability.

Parameters:

capa - The capability value

Returns:

The capability description, null otherwise

Since:

1.6

getChildren

public static org.apache.commons.vfs2.FileObject[] getChildren(org.apache.commons.vfs2.FileObject directory)
                                                        throws org.apache.commons.vfs2.FileSystemException

Provides the children found in a directory.

Since FileObject.getChildren() may take very long, this method warns with a stack trace if this code is called from the event displatch thread. Application developers should call this method instead of FileObject.getChildren() to be warned.

Parameters:

directory - The directory

Returns:

The childs

Throws:

org.apache.commons.vfs2.FileSystemException - If an error occurs

Since:

1.6

getChildren

public static org.apache.commons.vfs2.FileObject[] getChildren(org.apache.commons.vfs2.FileObject directory,
                                                               org.apache.commons.vfs2.FileObject[] fallback)

Provides the children found in a directory.

Since FileObject.getChildren() may take very long, this method warns with a stack trace if this code is called from the event displatch thread. Application developers should call this method instead of FileObject.getChildren() to be warned.

Parameters:

directory - The directory

fallback - The default value

Returns:

The childs, fallback otherwise

Since:

1.6

isRoot

public static boolean isRoot(org.apache.commons.vfs2.FileObject url)

Checks if the given URL is a root directory.

Parameters:

url - The directory

Returns:

Root?

Since:

1.6

clearDirectory

public static void clearDirectory(org.apache.commons.vfs2.FileObject target)

Tries to remove all directories and files from a given directory.

Use this method with care since all entries are removed recursively without transferring them into the Windows system garbage or so!

Parameters:

target - The directory to be cleared

Throws:

NullPointerException - If parameters are null

Since:

1.6

collectEntries

public static void collectEntries(org.apache.commons.vfs2.FileObject searchdir,
                                  Vector<org.apache.commons.vfs2.FileObject> entries)

Searches the given directory recursively for files and directories adds the results to the container.

The search directory itself is NOT included!

Parameters:

searchdir - The directory to begin searching

entries - Container with paths (File)

Since:

1.6

isExistingFile

public static boolean isExistingFile(org.apache.commons.vfs2.FileObject url)

Convenience to check if a given URL exists and is a regular file.

Parameters:

url - The URL to be checked

Returns:

File?

Throws:

NullPointerException - If the URL is null

Since:

1.6

writeFile

public static boolean writeFile(org.apache.commons.vfs2.FileObject url,
                                InputStream istream,
                                long length)

Writes binary data into a network file.

Parameters:

url - Network file to be written

istream - Binary data stream

length - Number of bytes to write, -1 = unknown

Returns:

Successful?

Since:

1.6

contains

public static boolean contains(Vector<org.apache.commons.vfs2.FileObject> container,
                               org.apache.commons.vfs2.FileObject url)

Checks, if the given container holds the given URL.

This is a workaround since FileObject.equals() does not properly detect identical entries properly. Here, the text representations are checked instead.

Parameters:

container - The URL set

url - The URL to be checked

Returns:

URL is element of container?

Throws:

NullPointerException - If the file is null

Since:

1.6

delete

public static boolean delete(org.apache.commons.vfs2.FileObject target)

Tries to delete the given network file/directory (directory must be empty).

Parameters:

target - The directory to be removed

Returns:

Successful?

Throws:

NullPointerException - If parameters are null

Since:

1.6

deleteAll

public static void deleteAll(org.apache.commons.vfs2.FileObject target)

Tries to delete the given network directory recursively.

Parameters:

target - The directory to be removed

Throws:

NullPointerException - If parameters are null

Since:

2.8

moveToArchive

public static boolean moveToArchive(org.apache.commons.vfs2.FileObject source,
                                    String subfolder)

Moves the given network file into the archive subfolder.

Parameters:

source - File to be moved

subfolder - Defaults to "ARCHIVE"

Returns:

Successful?

Throws:

NullPointerException - If parameters are null

Since:

1.6

hasFileSystemOptions

public static boolean hasFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions options)

Any file system specific options available (internal cache not empty)?

Parameters:

options - The options to check

Returns:

Options available?

Since:

1.6

debugPrint

public static String debugPrint(org.apache.commons.vfs2.FileSystemOptions options)

Prints file system specific options for a connection.

Parameters:

options - The options to check

Returns:

Text

Since:

1.6

findVFSConnection

public static VFSConnection findVFSConnection(VFSFileSystemManager vfsmanager,
                                              String id)

Determines the VFS connection associated with the given ID.

Parameters:

vfsmanager - The manager

id - The connection ID

Returns:

The connection, null if not available

Since:

1.6

findVFSConnections

public static VFSConnection[] findVFSConnections(VFSFileSystemManager vfsmanager,
                                                 org.apache.commons.vfs2.FileObject entry)

Determines the VFS connections which can be used to show the given network file.

The connection must be available (scheme supported) and applicable for the given URL (host, credentials etc. must match).

Parameters:

vfsmanager - The manager

entry - The URL

Returns:

The connections, null if not available

Since:

1.6

findVFSConnections

public static VFSConnection[] findVFSConnections(VFSFileSystemManager vfsmanager,
                                                 String url)

Determines the VFS connections which can be used to show the given network file.

The connection must be available (scheme supported) and applicable for the given URL (host, credentials etc. must match).

Parameters:

vfsmanager - The manager

url - The URL

Returns:

The connections, null if not available

Since:

1.6

addMissingCredentials

public static String addMissingCredentials(String uri,
                                           VFSConnection vfsconn)

Convenience to automatically apply user and password defined for a connection.

Parameters:

uri - The URI to resolve

vfsconn - The connection with options

Returns:

The modified URI, uri parameter otherwise

Since:

1.6

isSameServer

public static boolean isSameServer(org.apache.commons.vfs2.FileObject url1,
                                   org.apache.commons.vfs2.FileObject url2)

Checks if the given network files are on the same server.

Should be checked when the FileObject.moveTo() feature is to be used.

Parameters:

url1 - The first network file

url2 - The second network file

Returns:

The modified URI, uri parameter otherwise

Since:

1.6

isStateful

public static boolean isStateful(String protocol)

Is the given VFS protocol/scheme stateful?

Stateful measn that a connection requires a session to be established and closed. For example, FTP and SFTP are stateful protocols, while HTTP is not.

Parameters:

protocol - The VFS scheme/protocol like "sftp"

Returns:

Stateful?

Since:

1.6

getProtocol

public static String getProtocol(String uri)

Extracts the scheme part of the given URI.

Parameters:

uri - The URI to parse

Returns:

The protocol like "sftp", null otherwise

Since:

1.6

getDefaultPort

public static int getDefaultPort(String protocol)

Provides the numerical port number appropriate for the given VFS protocol/scheme.

Parameters:

protocol - The VFS scheme/protocol like "sftp"

Returns:

The port, -1 otherwise (e.g. for "zip")

Since:

1.6

getFileObjectComparator

public static Comparator<org.apache.commons.vfs2.FileObject> getFileObjectComparator()

Creates a new comparator used together with TreeMap to handle FileObject's properly.

Caution: Do not use Hashtable

Returns:

The comparator

Since:

1.6

isContentLengthRequired

public static boolean isContentLengthRequired(org.apache.commons.vfs2.FileObject url)

Checks if the given protocol requires setting the VFSLibConstants.ATTR_CONTENT_LENGTH attribute.

This attribute is known to be required for proper file handling with the Amazon S3 provider.

Parameters:

url - The network file

Returns:

Required?

Throws:

NullPointerException - If a parameter is null

Since:

1.6

compareContents

public static boolean compareContents(org.apache.commons.vfs2.FileObject url,
                                      File file)

Checks if the given network file contents is equal to the given local file.

Parameters:

url - The network file

file - The local file

Returns:

Contents match?

Throws:

NullPointerException - If a parameter is null

Since:

2.8