com.lf.commons.net

Class VFSConnection

java.lang.Object

com.lf.commons.net.VFSConnection

public class VFSConnection
extends java.lang.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

Version:

$Revision: 1.15 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config Cache for the settings (driver parameters, expert settings, etc.).
static java.lang.String	PARAM_HOST The ip address or the name of the host (String).
static java.lang.String	PARAM_PATH The (absolute) path on the host (String).
static java.lang.String	PARAM_PORT The port number for the host access (int).
static java.lang.String	PARAM_SAVE_PASSWORD Save the password for the user (boolean)?
static java.lang.String	PARAM_USER The name of the user (String).
static java.lang.String	PARAM_USER_PASSWORD The password for the user (String).
static java.lang.String	VAR_CONNECTION_ID Configuration variable name (String).
static java.lang.String	VAR_CONNECTION_NAME Configuration variable name (String).
static java.lang.String	VAR_EXPERT_AUTO_RECONNECT Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_DISPLAY_BEFORE Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_ENCODING Configuration variable name (String).
static java.lang.String	VAR_EXPERT_KEEP_ALIVE Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_KEEP_ALIVE_PING Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_KEEP_ALIVE_RESOLVE Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_KEEP_ALIVE_SECONDS Configuration variable name (int).
static java.lang.String	VAR_EXPERT_MAX_WAIT Configuration variable name (boolean).
static java.lang.String	VAR_EXPERT_MAX_WAIT_SECONDS Configuration variable name (int).
static java.lang.String	VAR_PROTOCOL Configuration variable name (String).
static java.lang.String	VAR_READONLY Configuration variable name (boolean).
protected VFSFileSystemManager	vfsManager The file system manager.

Constructor Summary

Constructors

Constructor and Description
VFSConnection() Constructor method for i18n purposes only.
VFSConnection(VFSFileSystemManager vfsmanager, java.lang.String id) Constructor method setting default values.
VFSConnection(VFSFileSystemManager vfsmanager, java.lang.String id, Configuration config) Constructor method setting the container.

Method Summary

Methods

Modifier and Type	Method and Description
VFSConnection	clone() Makes a copy of this object.
static VFSConnection	createConnection(VFSFileSystemManager vfsmanager, java.lang.String protocol, java.lang.String id) Creates a fresh new connection appropriate for the given VFS scheme/protocol.
static VFSConnection	createConnection(VFSFileSystemManager vfsmanager, java.lang.String protocol, java.lang.String id, Configuration config) Creates a fresh new connection appropriate for the given VFS scheme/protocol.
boolean	getAutoReconnect(boolean fallback) Provides the expert setting if to reconnect to dead peers.
Configuration	getCache() Provides access to the internal cache with properties.
boolean	getDisplayBefore(boolean fallback) Provides the expert setting if settings shall be displayed before connection is established.
java.lang.String	getDisplayURI() Assembles the URI which can be displayed safely (no cleartext passwords).
java.lang.String	getEncoding(java.lang.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(java.lang.String protocol) The file system specific options (optional).
java.lang.String	getHost(java.lang.String fallback) Provides the URL host part.
java.lang.String	getID(java.lang.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.
java.lang.String	getName(java.lang.String fallback) Provides the connection name.
java.lang.String	getPassword(java.lang.String fallback) Provides the URL password part.
java.lang.String	getPath(java.lang.String fallback) Provides the URL path part.
int	getPort(int fallback) Provides the URL port part.
java.lang.String	getProtocol(java.lang.String fallback) Provides the type of protocol (aka scheme like "sftp").
boolean	getSavePassword(boolean save) Provides the info if the password should be remembered.
static java.lang.String	getUniqueConnectionID(java.util.Vector<VFSConnection> connections) Provides the next connection identifier unique for this instance.
java.lang.String	getURI() Assembles the URI which can be used for VFS resolves etc.
java.lang.String	getURI(java.lang.String username, java.lang.String password) Assembles the URI which can be used for VFS resolves etc.
java.lang.String	getURIHost() Convenience to get the host/IP address represented by this connection.
java.lang.String	getUser(java.lang.String fallback) Provides the URL user part.
boolean	isApplicable(org.apache.commons.vfs2.FileObject url) 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	isCacheEmpty() Provides the info if the internal cache is empty.
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).
boolean	isReadOnly(boolean fallback) Provides the info if connection parameters are read-only.
boolean	isValid() Provides the info if this connection is configured properly and can therefore be used.
void	setName(java.lang.String value) Sets the connection name.
void	setPassword(java.lang.String password) Sets the URL password part.
void	setProtocol(java.lang.String value) Sets the type of protocol (aka scheme like "sftp").
void	setReadOnly(boolean value) Sets the info if connection parameters are read-only.
void	setSavePassword(boolean save) Sets the info if the password should be remembered.
void	setUser(java.lang.String user) Sets the URL user part.
java.lang.String	toString() Provides the characteristic textual representation of this connection (identifier).

Methods inherited from class java.lang.Object

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

Field Detail

VAR_CONNECTION_ID

public static final java.lang.String VAR_CONNECTION_ID

Configuration variable name (String).

See Also:

Constant Field Values

VAR_CONNECTION_NAME

public static final java.lang.String VAR_CONNECTION_NAME

Configuration variable name (String).

See Also:

Constant Field Values

VAR_PROTOCOL

public static final java.lang.String VAR_PROTOCOL

Configuration variable name (String).

See Also:

Constant Field Values

VAR_READONLY

public static final java.lang.String VAR_READONLY

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_MAX_WAIT

public static final java.lang.String VAR_EXPERT_MAX_WAIT

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_MAX_WAIT_SECONDS

public static final java.lang.String VAR_EXPERT_MAX_WAIT_SECONDS

Configuration variable name (int).

See Also:

Constant Field Values

VAR_EXPERT_AUTO_RECONNECT

public static final java.lang.String VAR_EXPERT_AUTO_RECONNECT

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE

public static final java.lang.String VAR_EXPERT_KEEP_ALIVE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_SECONDS

public static final java.lang.String VAR_EXPERT_KEEP_ALIVE_SECONDS

Configuration variable name (int).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_PING

public static final java.lang.String VAR_EXPERT_KEEP_ALIVE_PING

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_KEEP_ALIVE_RESOLVE

public static final java.lang.String VAR_EXPERT_KEEP_ALIVE_RESOLVE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_DISPLAY_BEFORE

public static final java.lang.String VAR_EXPERT_DISPLAY_BEFORE

Configuration variable name (boolean).

See Also:

Constant Field Values

VAR_EXPERT_ENCODING

public static final java.lang.String VAR_EXPERT_ENCODING

Configuration variable name (String).

See Also:

Constant Field Values

PARAM_HOST

public static final java.lang.String PARAM_HOST

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

See Also:

Constant Field Values

PARAM_PORT

public static final java.lang.String PARAM_PORT

The port number for the host access (int).

See Also:

Constant Field Values

PARAM_PATH

public static final java.lang.String PARAM_PATH

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

See Also:

Constant Field Values

PARAM_USER

public static final java.lang.String PARAM_USER

The name of the user (String).

See Also:

Constant Field Values

PARAM_USER_PASSWORD

public static final java.lang.String PARAM_USER_PASSWORD

The password for the user (String).

See Also:

Constant Field Values

PARAM_SAVE_PASSWORD

public static final java.lang.String PARAM_SAVE_PASSWORD

Save the password for the user (boolean)?

See Also:

Constant Field Values

config

protected Configuration config

Cache for the settings (driver parameters, expert settings, etc.).

vfsManager

protected VFSFileSystemManager vfsManager

The file system manager.

Constructor Detail

VFSConnection

public VFSConnection()
              throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

VFSConnection

public VFSConnection(VFSFileSystemManager vfsmanager,
             java.lang.String id)

Constructor method setting default values.

Parameters:

vfsmanager - The file system manager

id - The unique connection identifier

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

VFSConnection

public VFSConnection(VFSFileSystemManager vfsmanager,
             java.lang.String id,
             Configuration config)

Constructor method setting the container.

Parameters:

vfsmanager - The file system manager

id - The unique connection identifier

config - The container, empty is OK

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

Method Detail

getFileSystemManager

public VFSFileSystemManager getFileSystemManager()

Provides the file system manager.

Returns:

File system manager

getFileSystemOptions

public org.apache.commons.vfs2.FileSystemOptions getFileSystemOptions(java.lang.String protocol)

The file system specific options (optional).

Parameters:

protocol - The VFS scheme like "sftp"

Returns:

The options, may be null

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?

getID

public java.lang.String getID(java.lang.String fallback)

Provides the unique connection identifier.

Parameters:

fallback - The default value

Returns:

Connection name, may be null

getName

public java.lang.String getName(java.lang.String fallback)

Provides the connection name.

Parameters:

fallback - The default value

Returns:

Connection name, may be null

setName

public void setName(java.lang.String value)

Sets the connection name.

Parameters:

value - The connection name, removed if null

getProtocol

public java.lang.String getProtocol(java.lang.String fallback)

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

Parameters:

fallback - The default value

Returns:

Protocol, may be null

setProtocol

public void setProtocol(java.lang.String value)

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

Parameters:

value - The protocol, removed if null

isReadOnly

public boolean isReadOnly(boolean fallback)

Provides the info if connection parameters are read-only.

Parameters:

fallback - The default value

Returns:

Read-only?

setReadOnly

public void setReadOnly(boolean value)

Sets the info if connection parameters are read-only.

Parameters:

value - Read-only?

getMaxWait

public boolean getMaxWait(boolean fallback)

Provides the expert setting if to wait for connect.

Parameters:

fallback - The default value

Returns:

Wait for connect?

getMaxWaitSeconds

public int getMaxWaitSeconds(int fallback)

Provides the maximum number of seconds to wait for connect.

Parameters:

fallback - The default value

Returns:

Seconds

getAutoReconnect

public boolean getAutoReconnect(boolean fallback)

Provides the expert setting if to reconnect to dead peers.

Parameters:

fallback - The default value

Returns:

Reconnect?

getKeepAlive

public boolean getKeepAlive(boolean fallback)

Provides the expert setting if connection is kept alive automatically.

Parameters:

fallback - The default value

Returns:

Keep alive?

getKeepAliveSeconds

public int getKeepAliveSeconds(int fallback)

Provides the keep alive interval.

Parameters:

fallback - The default value

Returns:

Seconds

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?

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?

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?

getEncoding

public java.lang.String getEncoding(java.lang.String fallback)

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

Parameters:

fallback - The default value

Returns:

Encoding

getHost

public java.lang.String getHost(java.lang.String fallback)

Provides the URL host part.

Parameters:

fallback - The default value

Returns:

URL host, may be null

getPort

public int getPort(int fallback)

Provides the URL port part.

Parameters:

fallback - The default value

Returns:

URL port, may be null

getPath

public java.lang.String getPath(java.lang.String fallback)

Provides the URL path part.

Parameters:

fallback - The default value

Returns:

URL path, may be null

getUser

public java.lang.String getUser(java.lang.String fallback)

Provides the URL user part.

Parameters:

fallback - The default value

Returns:

URL user, may be null

setUser

public void setUser(java.lang.String user)

Sets the URL user part.

Parameters:

user - The user name

getPassword

public java.lang.String getPassword(java.lang.String fallback)

Provides the URL password part.

Parameters:

fallback - The default value

Returns:

URL password, may be null

setPassword

public void setPassword(java.lang.String password)

Sets the URL password part.

Parameters:

password - The user password

getSavePassword

public boolean getSavePassword(boolean save)

Provides the info if the password should be remembered.

Parameters:

save - The default value

Returns:

Save password?

setSavePassword

public void setSavePassword(boolean save)

Sets the info if the password should be remembered.

Parameters:

save - Remember?

getCache

public Configuration getCache()

Provides access to the internal cache with properties.

Returns:

The internal cache

isCacheEmpty

public boolean isCacheEmpty()

Provides the info if the internal cache is empty.

Returns:

Empty cache?

getUniqueConnectionID

public static java.lang.String getUniqueConnectionID(java.util.Vector<VFSConnection> connections)

Provides the next connection identifier unique for this instance.

Parameters:

connections - The cache holding the IDs in use

Returns:

The unique identifier

Since:

1.6

createConnection

public static VFSConnection createConnection(VFSFileSystemManager vfsmanager,
                             java.lang.String protocol,
                             java.lang.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,
                             java.lang.String protocol,
                             java.lang.String id,
                             Configuration config)

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

Returns:

The new connection, null indicates error

Since:

1.6

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

The manager

isConnected

public boolean isConnected()

Provides the info if this connection is currently alive.

Returns:

Currently connected?

Since:

1.6

getURIHost

public java.lang.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 boolean isValid()

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

Returns:

Connection OK?

isReachable

public boolean isReachable()

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

Returns:

Connection OK?

clone

public VFSConnection clone()
                    throws java.lang.CloneNotSupportedException

Makes a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

The copy

Throws:

java.lang.CloneNotSupportedException - If cloning is not supported

getURI

public java.lang.String getURI()

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

Returns:

The URI, null indicates error

getURI

public java.lang.String getURI(java.lang.String username,
                      java.lang.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

getDisplayURI

public java.lang.String getDisplayURI()

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

Returns:

The display URI, null indicates error

isApplicable

public boolean isApplicable(org.apache.commons.vfs2.FileObject url)

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

Parameters:

url - The network file/directory

Returns:

Connection OK?