com.lf.vfslib.net

Class VFSConnection

java.lang.Object

com.lf.vfslib.net.VFSConnection

public class VFSConnection
extends Object

Data holder class representing VFS (virtual file system) connections based on URLs.

Objects of this type are managed using the VFSConnectionDialog. Subclasses may add URL specific parameters as necessary.

Since:

1.6

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_HOST The ip address or the name of the host (String).
static String	PARAM_PATH The (absolute) path on the host (String).
static String	PARAM_PORT The port number for the host access (int).
static String	PARAM_SAVE_PASSWORD Save the password for the user (boolean)?
static String	PARAM_USER The name of the user (String).
static String	PARAM_USER_PASSWORD The password for the user (String).
static String	VAR_CONNECTION_ID Configuration variable name (String).
static String	VAR_CONNECTION_NAME Configuration variable name (String).
static String	VAR_EXPERT_DISPLAY_BEFORE Configuration variable name (boolean).
static String	VAR_EXPERT_ENCODING Configuration variable name (String).
static String	VAR_EXPERT_KEEP_ALIVE Configuration variable name (boolean).
static String	VAR_EXPERT_KEEP_ALIVE_PING Configuration variable name (boolean).
static String	VAR_EXPERT_KEEP_ALIVE_RESOLVE Configuration variable name (boolean).
static String	VAR_EXPERT_KEEP_ALIVE_SECONDS Configuration variable name (int).
static String	VAR_EXPERT_MAX_WAIT Configuration variable name (boolean).
static String	VAR_EXPERT_MAX_WAIT_SECONDS Configuration variable name (int).
static String	VAR_PROTOCOL Configuration variable name (String).

Constructor Summary

Constructors

Constructor and Description
VFSConnection() Constructor method for i18n purposes only.
VFSConnection(VFSFileSystemManager vfsmanager, String id) Constructor method setting default values.
VFSConnection(VFSFileSystemManager vfsmanager, String id, Properties props, org.apache.commons.vfs2.FileSystemOptions options) Constructor method setting the container.

Method Summary

Modifier and Type	Method and Description
boolean	checkUniqueName(Vector<VFSConnection> connections) Checks if the name for the given connection is unique over all connections.
boolean	checkUniqueUser(Vector<VFSConnection> connections) Checks if the user for the given connection is unique over all connections of the same scheme.
VFSConnection	clone() Makes a copy of this object.
static VFSConnection	createConnection(VFSFileSystemManager vfsmanager, String protocol, String id) Creates a fresh new connection appropriate for the given VFS scheme/protocol.
static VFSConnection	createConnection(VFSFileSystemManager vfsmanager, String protocol, String id, Properties config, org.apache.commons.vfs2.FileSystemOptions options) Creates a fresh new connection appropriate for the given VFS scheme/protocol.
static boolean	elementOf(Object object, Object array) Checks if the given object is element of the given array (equals).
static org.apache.commons.vfs2.FileSystemOptions	getDefaultFileSystemOptions(String scheme, String encoding) Provides the default options for a certain protocol.
boolean	getDisplayBefore(boolean fallback) Provides the expert setting if settings shall be displayed before connection is established.
String	getDisplayURI() Assembles the URI which can be displayed safely (no cleartext passwords).
String	getEncoding(String fallback) Provides the expert setting which file system encoding shall be used.
VFSFileSystemManager	getFileSystemManager() Provides the file system manager.
org.apache.commons.vfs2.FileSystemOptions	getFileSystemOptions() The file system specific options for this connection.
String	getHost(String fallback) Provides the URL host part.
String	getID(String fallback) Provides the unique connection identifier.
boolean	getKeepAlive(boolean fallback) Provides the expert setting if connection is kept alive automatically.
boolean	getKeepAlivePing(boolean fallback) Provides the expert setting if connection is kept alive with ping.
boolean	getKeepAliveResolve(boolean fallback) Provides the expert setting if connection is kept alive with entry resolves.
int	getKeepAliveSeconds(int fallback) Provides the keep alive interval.
boolean	getMaxWait(boolean fallback) Provides the expert setting if to wait for connect.
int	getMaxWaitSeconds(int fallback) Provides the maximum number of seconds to wait for connect.
String	getName(String fallback) Provides the connection name.
String	getPassword(String fallback) Provides the URL password part.
String	getPath(String fallback) Provides the URL path part.
int	getPort(int fallback) Provides the URL port part.
String	getProtocol(String fallback) Provides the type of protocol (aka scheme like "sftp").
String	getRootURI() Assembles the root URI which can be used for VFS resolves etc.
String	getRootURI(String username, String password) Assembles the root URI which can be used for VFS resolves etc.
boolean	getSavePassword(boolean save) Provides the info if the password should be remembered.
Properties	getSettings() Provides access to the internal cache of settings (driver parameters, expert settings).
static String	getUniqueConnectionID(Vector<VFSConnection> connections) Provides the next connection identifier unique for this instance.
String	getURI() Assembles the URI which can be used for VFS resolves etc.
String	getURI(String username, String password) Assembles the URI which can be used for VFS resolves etc.
String	getURIHost() Convenience to get the host/IP address represented by this connection.
String	getUser(String fallback) Provides the URL user part.
boolean	hasFileSystemOptions() Any file system specific options for this connection available (internal cache not empty)?
boolean	hasSettings() Provides the info if the internal settings cache is not empty.
boolean	isApplicable(String url, boolean compareuser) Checks if the given entry can be processed/listed by this connection instance.
boolean	isAvailable() Convenience method to get the info if the underlying VFS scheme is available.
boolean	isConnected() Provides the info if this connection is currently alive.
boolean	isReachable() Provides the info if the connection host can be reached (connection test).
String	isValid(Vector<VFSConnection> connections) Provides the info if this connection is configured properly and can therefore be used.
void	setFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions options) The file system specific options for this connection.
void	setName(String value) Sets the connection name.
void	setPassword(String password) Sets the URL password part.
void	setProtocol(String value) Sets the type of protocol (aka scheme like "sftp").
void	setSavePassword(boolean save) Sets the info if the password should be remembered.
void	setUser(String user) Sets the URL user part.
String	toString() Provides the characteristic textual representation of this connection (identifier).

Methods inherited from class java.lang.Object

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

Field Detail

VAR_CONNECTION_ID

public static final String VAR_CONNECTION_ID

Configuration variable name (String).

See Also:

Constant Field Values

VAR_CONNECTION_NAME

public static final String VAR_CONNECTION_NAME

Configuration variable name (String).

See Also:

Constant Field Values

VAR_PROTOCOL

public static final String VAR_PROTOCOL

Configuration variable name (String).

See Also:

Constant Field Values

VAR_EXPERT_MAX_WAIT

public static final String VAR_EXPERT_MAX_WAIT

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_MAX_WAIT_SECONDS

public static final String VAR_EXPERT_MAX_WAIT_SECONDS

Configuration variable name (int).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE

public static final String VAR_EXPERT_KEEP_ALIVE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_SECONDS

public static final String VAR_EXPERT_KEEP_ALIVE_SECONDS

Configuration variable name (int).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_PING

public static final String VAR_EXPERT_KEEP_ALIVE_PING

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_RESOLVE

public static final String VAR_EXPERT_KEEP_ALIVE_RESOLVE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_DISPLAY_BEFORE

public static final String VAR_EXPERT_DISPLAY_BEFORE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_ENCODING

public static final String VAR_EXPERT_ENCODING

Configuration variable name (String).

See Also:

Constant Field Values

PARAM_HOST

public static final String PARAM_HOST

The ip address or the name of the host (String).

See Also:

Constant Field Values

PARAM_PORT

public static final String PARAM_PORT

The port number for the host access (int).

See Also:

Constant Field Values

PARAM_PATH

public static final String PARAM_PATH

The (absolute) path on the host (String).

See Also:

Constant Field Values

PARAM_USER

public static final String PARAM_USER

The name of the user (String).

See Also:

Constant Field Values

PARAM_USER_PASSWORD

public static final String PARAM_USER_PASSWORD

The password for the user (String).

See Also:

Constant Field Values

PARAM_SAVE_PASSWORD

public static final String PARAM_SAVE_PASSWORD

Save the password for the user (boolean)?

See Also:

Constant Field Values

Constructor Detail

VFSConnection

public VFSConnection()
              throws InstantiationException

Constructor method for i18n purposes only.

Throws:

InstantiationException - Error indication

Since:

1.6

VFSConnection

public VFSConnection(VFSFileSystemManager vfsmanager,
                     String id)

Constructor method setting default values.

Parameters:

vfsmanager - The file system manager

id - The unique connection identifier

Throws:

NullPointerException - If parameter is null

Since:

1.6

VFSConnection

public VFSConnection(VFSFileSystemManager vfsmanager,
                     String id,
                     Properties props,
                     org.apache.commons.vfs2.FileSystemOptions options)

Constructor method setting the container.

Parameters:

vfsmanager - The file system manager

id - The unique connection identifier

props - The container, empty is OK

options - Scheme specific options like FtpFileSystemConfigBuilder.getInstance().setPassiveMode()

Throws:

NullPointerException - If parameter is null

Since:

1.6

Method Detail

getFileSystemManager

public VFSFileSystemManager getFileSystemManager()

Provides the file system manager.

Returns:

File system manager

Since:

1.6

getFileSystemOptions

public org.apache.commons.vfs2.FileSystemOptions getFileSystemOptions()

The file system specific options for this connection.

Returns:

The options, may be null

Since:

1.6

setFileSystemOptions

public void setFileSystemOptions(org.apache.commons.vfs2.FileSystemOptions options)

The file system specific options for this connection.

Parameters:

options - The options, may be empty

Since:

1.6

hasFileSystemOptions

public boolean hasFileSystemOptions()

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

Returns:

Options available?

Since:

1.6

isAvailable

public boolean isAvailable()

Convenience method to get the info if the underlying VFS scheme is available.

Availability here means if the VFS driver is available on the classpath.

Returns:

Connection available?

Since:

1.6

getID

public String getID(String fallback)

Provides the unique connection identifier.

Parameters:

fallback - The default value

Returns:

Connection name, may be null

Since:

1.6

getName

public String getName(String fallback)

Provides the connection name.

Parameters:

fallback - The default value

Returns:

Connection name, may be null

Since:

1.6

setName

public void setName(String value)

Sets the connection name.

Parameters:

value - The connection name, removed if null

Since:

1.6

getProtocol

public String getProtocol(String fallback)

Provides the type of protocol (aka scheme like "sftp").

Parameters:

fallback - The default value

Returns:

Protocol, may be null

Since:

1.6

setProtocol

public void setProtocol(String value)

Sets the type of protocol (aka scheme like "sftp").

Parameters:

value - The protocol, removed if null

Since:

1.6

getMaxWait

public boolean getMaxWait(boolean fallback)

Provides the expert setting if to wait for connect.

Parameters:

fallback - The default value

Returns:

Wait for connect?

Since:

1.6

getMaxWaitSeconds

public int getMaxWaitSeconds(int fallback)

Provides the maximum number of seconds to wait for connect.

Parameters:

fallback - The default value

Returns:

Seconds

Since:

1.6

getKeepAlive

public boolean getKeepAlive(boolean fallback)

Provides the expert setting if connection is kept alive automatically.

Parameters:

fallback - The default value

Returns:

Keep alive?

Since:

1.6

getKeepAliveSeconds

public int getKeepAliveSeconds(int fallback)

Provides the keep alive interval.

Parameters:

fallback - The default value

Returns:

Seconds

Since:

1.6

getKeepAlivePing

public boolean getKeepAlivePing(boolean fallback)

Provides the expert setting if connection is kept alive with ping.

Parameters:

fallback - The default value

Returns:

Keep alive via ping?

Since:

1.6

getKeepAliveResolve

public boolean getKeepAliveResolve(boolean fallback)

Provides the expert setting if connection is kept alive with entry resolves.

Parameters:

fallback - The default value

Returns:

Keep alive via resolves?

Since:

1.6

getDisplayBefore

public boolean getDisplayBefore(boolean fallback)

Provides the expert setting if settings shall be displayed before connection is established.

Parameters:

fallback - The default value

Returns:

Display settings?

Since:

1.6

getEncoding

public String getEncoding(String fallback)

Provides the expert setting which file system encoding shall be used.

Parameters:

fallback - The default value

Returns:

Encoding

Since:

1.6

getHost

public String getHost(String fallback)

Provides the URL host part.

Parameters:

fallback - The default value

Returns:

URL host, may be null

Since:

1.6

getPort

public int getPort(int fallback)

Provides the URL port part.

Parameters:

fallback - The default value

Returns:

URL port, may be null

Since:

1.6

getPath

public String getPath(String fallback)

Provides the URL path part.

Parameters:

fallback - The default value

Returns:

URL path, may be null

Since:

1.6

getUser

public String getUser(String fallback)

Provides the URL user part.

Parameters:

fallback - The default value

Returns:

URL user, may be null

Since:

1.6

setUser

public void setUser(String user)

Sets the URL user part.

Parameters:

user - The user name

Since:

1.6

getPassword

public String getPassword(String fallback)

Provides the URL password part.

Parameters:

fallback - The default value

Returns:

URL password, may be null

Since:

1.6

setPassword

public void setPassword(String password)

Sets the URL password part.

Parameters:

password - The user password

Since:

1.6

getSavePassword

public boolean getSavePassword(boolean save)

Provides the info if the password should be remembered.

Parameters:

save - The default value

Returns:

Save password?

Since:

1.6

setSavePassword

public void setSavePassword(boolean save)

Sets the info if the password should be remembered.

Parameters:

save - Remember?

Since:

1.6

getSettings

public Properties getSettings()

Provides access to the internal cache of settings (driver parameters, expert settings).

Returns:

The settings

Since:

2.8

hasSettings

public boolean hasSettings()

Provides the info if the internal settings cache is not empty.

Returns:

Any settings?

Since:

2.8

getUniqueConnectionID

public static String getUniqueConnectionID(Vector<VFSConnection> connections)

Provides the next connection identifier unique for this instance.

Parameters:

connections - The container holding the IDs in use

Returns:

The unique identifier

Since:

1.6

createConnection

public static VFSConnection createConnection(VFSFileSystemManager vfsmanager,
                                             String protocol,
                                             String id)

Creates a fresh new connection appropriate for the given VFS scheme/protocol.

Parameters:

vfsmanager - The file system manager

protocol - VFS scheme like "sftp"

id - The unique identifier

Returns:

The new connection, null indicates error

Since:

1.6

createConnection

public static VFSConnection createConnection(VFSFileSystemManager vfsmanager,
                                             String protocol,
                                             String id,
                                             Properties config,
                                             org.apache.commons.vfs2.FileSystemOptions options)

Creates a fresh new connection appropriate for the given VFS scheme/protocol.

Parameters:

vfsmanager - The file system manager

protocol - VFS scheme like "sftp"

id - The unique identifier

config - The settings to use

options - Scheme specific options like FtpFileSystemConfigBuilder.getInstance().setPassiveMode()

Returns:

The new connection, null indicates error

Since:

1.6

toString

public String toString()

Provides the characteristic textual representation of this connection (identifier).

Overrides:

toString in class Object

Returns:

The manager

Since:

1.6

isConnected

public boolean isConnected()

Provides the info if this connection is currently alive.

Returns:

Currently connected?

Since:

1.6

getURIHost

public String getURIHost()

Convenience to get the host/IP address represented by this connection.

Returns:

The host name/IP address, may be null

Since:

1.6

isValid

public String isValid(Vector<VFSConnection> connections)

Provides the info if this connection is configured properly and can therefore be used.

For cloud file systems an access token must be well-known. Although the user name is just for display here we have to make sure it is unique for each scheme (do not mix up pool connections!). Also the connection name must be unique for the same reasons.

Parameters:

connections - The other connections (optional)

Returns:

null = connection OK, message in user's language otherwise

Since:

1.6

isReachable

public boolean isReachable()

Provides the info if the connection host can be reached (connection test).

Returns:

Connection OK?

Since:

1.6

clone

public VFSConnection clone()
                    throws CloneNotSupportedException

Makes a copy of this object.

Overrides:

clone in class Object

Returns:

The copy

Throws:

CloneNotSupportedException - If cloning is not supported

Since:

1.6

getURI

public String getURI()

Assembles the URI which can be used for VFS resolves etc.

Returns:

The URI, null indicates error

Since:

1.6

getURI

public String getURI(String username,
                     String password)

Assembles the URI which can be used for VFS resolves etc.

Parameters:

username - The login name, use connection credentials otherwise

password - The password, use connection credentials otherwise

Returns:

The URI, null indicates error

Since:

1.6

getRootURI

public String getRootURI()

Assembles the root URI which can be used for VFS resolves etc.

Returns:

The root URI, null indicates error

Since:

1.6

getRootURI

public String getRootURI(String username,
                         String password)

Assembles the root URI which can be used for VFS resolves etc.

Parameters:

username - The login name, use connection credentials otherwise

password - The password, use connection credentials otherwise

Returns:

The root URI, null indicates error

Since:

1.6

getDisplayURI

public String getDisplayURI()

Assembles the URI which can be displayed safely (no cleartext passwords).

Returns:

The display URI, null indicates error

Since:

1.6

isApplicable

public boolean isApplicable(String url,
                            boolean compareuser)

Checks if the given entry can be processed/listed by this connection instance.

Parameters:

url - The network file/directory

compareuser - Compare user info?

Returns:

Connection OK?

Since:

1.6

getDefaultFileSystemOptions

public static org.apache.commons.vfs2.FileSystemOptions getDefaultFileSystemOptions(String scheme,
                                                                                    String encoding)

Provides the default options for a certain protocol.

Here, all scheme specific options are being preconfigured that are supported by the dialog protocol panels.

Parameters:

scheme - The protocol/scheme like "sftp"

encoding - The encoding like UTF-8 (optional)

Returns:

The options, may be empty

Throws:

NullPointerException - If parameter is null

Since:

1.6

checkUniqueUser

public boolean checkUniqueUser(Vector<VFSConnection> connections)

Checks if the user for the given connection is unique over all connections of the same scheme.

Parameters:

connections - The other connections

Returns:

User name unique?

Throws:

NullPointerException - If a parameter is null

Since:

1.6

checkUniqueName

public boolean checkUniqueName(Vector<VFSConnection> connections)

Checks if the name for the given connection is unique over all connections.

Parameters:

connections - The other connections

Returns:

User name unique?

Throws:

NullPointerException - If a parameter is null

Since:

1.6

elementOf

public static boolean elementOf(Object object,
                                Object array)

Checks if the given object is element of the given array (equals).

Parameters:

object - The object to be checked

array - The array to check against

Returns:

Is the object element of the array?

Throws:

NullPointerException - If object and/or array is null

Since:

1.6