org.das2.util.filesystem

Class FileSystemSettings

java.lang.Object

org.das2.util.filesystem.FileSystemSettings

public class FileSystemSettings
extends java.lang.Object

controls for file systems.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemSettings.Persistence

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	allowableExternalIdleMs the longest amount of time we'll wait for an external process to make progress downloading.
protected boolean	allowOffline
protected java.io.File	localCacheDir
protected FileSystemSettings.Persistence	persistence
static java.lang.String	PROP_ALLOWOFFLINE allow use of persistent, cached files when the file system is not accessible.
static java.lang.String	PROP_LOCALCACHEDIR setting for the location of where the local cache is kept.
static java.lang.String	PROP_OFFLINE
static java.lang.String	PROP_PERSISTENCE setting for how long files should be kept and using in the cache.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileSystemSettings() this should only be called by FileSystem.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
int	getConnectTimeoutMs() return the connection timeout in milliseconds.
java.io.File	getLocalCacheDir() setting for the location of where the local cache is kept.
FileSystemSettings.Persistence	getPersistence() get the setting for how long files should be kept and using in the cache, e.g.
int	getReadTimeoutMs() return the read timeout in milliseconds.
int	getTemporaryFileTimeoutSeconds() return the number of seconds that an unused temporary file will be left on the system before it may be deleted.
static boolean	hasAllPermission() check the security manager to see if all permissions are allowed, True indicates is not an applet running in a sandbox.
boolean	isAllowOffline()
boolean	isOffline() true indicate file system is offline and cached files should be used.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
void	setAllowOffline(boolean allowOffline)
void	setConnectTimeoutMs(int millis) reset the connect timeout.
void	setLocalCacheDir(java.io.File localCacheDir)
void	setOffline(boolean offline) If true, then force the filesystems to be offline.
void	setPersistence(FileSystemSettings.Persistence persistence)
void	setReadTimeoutMs(int millis) reset the time read timeout.
static void	setRestrictPermission(boolean v) true means don't attempt to gain access to applet-restricted functions.

Methods inherited from class java.lang.Object

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

Field Detail

localCacheDir

protected java.io.File localCacheDir

PROP_LOCALCACHEDIR

public static final java.lang.String PROP_LOCALCACHEDIR

setting for the location of where the local cache is kept.

See Also:

Constant Field Values

persistence

protected FileSystemSettings.Persistence persistence

PROP_PERSISTENCE

public static final java.lang.String PROP_PERSISTENCE

setting for how long files should be kept and using in the cache.

See Also:

Constant Field Values

allowOffline

protected boolean allowOffline

PROP_ALLOWOFFLINE

public static final java.lang.String PROP_ALLOWOFFLINE

allow use of persistent, cached files when the file system is not accessible. FileSystem implementations will throw FileNotFound exception when remote resources are not available, and FileSystemOfflineExceptions are not thrown.

See Also:

Constant Field Values

PROP_OFFLINE

public static final java.lang.String PROP_OFFLINE

See Also:

Constant Field Values

allowableExternalIdleMs

protected static final long allowableExternalIdleMs

the longest amount of time we'll wait for an external process to make progress downloading.

See Also:

Constant Field Values

Constructor Detail

FileSystemSettings

protected FileSystemSettings()

this should only be called by FileSystem. Use FileSystem.settings().

Method Detail

hasAllPermission

public static boolean hasAllPermission()

check the security manager to see if all permissions are allowed, True indicates is not an applet running in a sandbox. copy of DasAppliction.hasAllPermission

Returns:

true if all permissions are allowed

setRestrictPermission

public static void setRestrictPermission(boolean v)

true means don't attempt to gain access to applet-restricted functions.

Parameters:

v - true means don't attempt to gain access to applet-restricted functions.

See Also:

DasApplication.setRestrictPermission(boolean)

getConnectTimeoutMs

public int getConnectTimeoutMs()

return the connection timeout in milliseconds.

Returns:

the connection timeout in milliseconds.

setConnectTimeoutMs

public void setConnectTimeoutMs(int millis)

reset the connect timeout. Setting to 0 or a negative number will reset it to the default of 5000ms.

Parameters:

millis -

getReadTimeoutMs

public int getReadTimeoutMs()

return the read timeout in milliseconds.

Returns:

setReadTimeoutMs

public void setReadTimeoutMs(int millis)

reset the time read timeout. Setting to 0 or a negative number will reset it to the default of 60000ms.

Parameters:

millis - number of milliseconds

getTemporaryFileTimeoutSeconds

public int getTemporaryFileTimeoutSeconds()

return the number of seconds that an unused temporary file will be left on the system before it may be deleted. This presumes that the code can determine if a temporary file is in use, which is not really the case.

Returns:

the number of seconds.

getLocalCacheDir

public java.io.File getLocalCacheDir()

setting for the location of where the local cache is kept.

Returns:

File that is the local cache directory.

setLocalCacheDir

public void setLocalCacheDir(java.io.File localCacheDir)

getPersistence

public FileSystemSettings.Persistence getPersistence()

get the setting for how long files should be kept and using in the cache, e.g. Persistence.SESSION means during the session.

Returns:

the setting

setPersistence

public void setPersistence(FileSystemSettings.Persistence persistence)

isAllowOffline

public boolean isAllowOffline()

setAllowOffline

public void setAllowOffline(boolean allowOffline)

isOffline

public boolean isOffline()

true indicate file system is offline and cached files should be used.

Returns:

setOffline

public void setOffline(boolean offline)

If true, then force the filesystems to be offline. If false, then use each filesystem's status. FileSystem.reset() should be called after this.

Parameters:

offline -

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)