org.sape.carbon.core.config.node.file
Interface FileLinkNodeConfiguration

All Superinterfaces:

Configuration, LinkNodeConfiguration

public interface FileLinkNodeConfiguration

extends LinkNodeConfiguration

Interface defining additional configuration for links to file system nodes Copyright 2002 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.9 $($Author: dvoet $ / $Date: 2003/12/18 18:42:14 $)

Author:

Douglas Voet, April 2002

Field Summary

static boolean	FileMonitorEnabled If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store.
static long	MonitorPollInterval MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed.

Method Summary

String	getLinkToPath() LinkToPath is the path to the target of this link
long	getMonitorPollInterval() MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed.
boolean	isFileMonitorEnabled() If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store.
void	setFileMonitorEnabled(boolean isEnabled) If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store.
void	setLinkToPath(String path) LinkToPath is the path to the target of this link
void	setMonitorPollInterval(long milliseconds) MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed.

Methods inherited from interface org.sape.carbon.core.config.node.link.LinkNodeConfiguration

getLinkNodeFactoryClass, setLinkNodeFactoryClass

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Field Detail

MonitorPollInterval

public static final long MonitorPollInterval

MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed. Defaults to 5000.

See Also:

Constant Field Values

FileMonitorEnabled

public static final boolean FileMonitorEnabled

If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store. Defaults to false.

See Also:

Constant Field Values

Method Detail

getLinkToPath

public String getLinkToPath()

LinkToPath is the path to the target of this link

Returns:

path to the target of this link

setLinkToPath

public void setLinkToPath(String path)

LinkToPath is the path to the target of this link

Parameters:

path - sets the path to the target of this link

getMonitorPollInterval

public long getMonitorPollInterval()

MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed. Defaults to 5000.

setMonitorPollInterval

public void setMonitorPollInterval(long milliseconds)

MonitorPollInterval is the period of time in milliseconds that the file monitor thread sleeps between polling files to see if they have changed. Defaults to 5000.

isFileMonitorEnabled

public boolean isFileMonitorEnabled()

If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store. Defaults to false.

setFileMonitorEnabled

public void setFileMonitorEnabled(boolean isEnabled)

If FileMonitorEnabled is true, when this link is created, a thread is spawned to monitor file changes in the backing data store. Defaults to false.