Module ch.qos.logback.core

Package ch.qos.logback.core.joran.spi

Class ConfigurationWatchList

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.joran.spi.ConfigurationWatchList

All Implemented Interfaces:

ContextAware

public class ConfigurationWatchList
extends ContextAwareBase

This class manages the list of files and/or urls that are watched for changes.

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_PROTOCOL_STR
static final String	HTTP_PROTOCOL_STR
static final String	HTTPS_PROTOCOL_STR

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
ConfigurationWatchList()

Method Summary

Modifier and Type	Method	Description
void	addToWatchList(URL url)	Add the url but only if it is file:// or http(s)://
ConfigurationWatchList	buildClone()
File	changeDetected()	Deprecated. replaced by changeDetectedInFile()
File	changeDetectedInFile()	Has a changed been detected in one of the files being watched?
URL	changeDetectedInURL()
void	clear()
boolean	emptyWatchLists()
List<File>	getCopyOfFileWatchList()
String	getFileWatchListAsStr()	Returns the fileWatchList field as a String
URL	getMainURL()
String	getUrlWatchListAsStr()	Returns the urlWatchList field as a String
boolean	hasAtLeastOneWatchableFile()	Returns true if there are watchable files, false otherwise.
static boolean	isWatchableProtocol(String protocolStr)	Is the given protocol a protocol that we can watch for.
static boolean	isWatchableProtocol(URL url)	Is protocol for the given URL a protocol that we can watch for.
void	setMainURL(URL mainURL)	The mainURL for the configuration file.
boolean	watchPredicateFulfilled()

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Field Details

HTTPS_PROTOCOL_STR

public static final String HTTPS_PROTOCOL_STR

See Also:

• Constant Field Values

HTTP_PROTOCOL_STR

public static final String HTTP_PROTOCOL_STR

See Also:

• Constant Field Values

FILE_PROTOCOL_STR

public static final String FILE_PROTOCOL_STR

See Also:

• Constant Field Values

Constructor Details

ConfigurationWatchList

public ConfigurationWatchList()

Method Details

buildClone

public ConfigurationWatchList buildClone()

clear

public void clear()

setMainURL

public void setMainURL(URL mainURL)

The mainURL for the configuration file. Null values are allowed.

Parameters:

mainURL -

watchPredicateFulfilled

public boolean watchPredicateFulfilled()

addToWatchList

public void addToWatchList(URL url)

Add the url but only if it is file:// or http(s)://

Parameters:

url - should be a file or http(s)

getMainURL

public URL getMainURL()

getCopyOfFileWatchList

public List<File> getCopyOfFileWatchList()

emptyWatchLists

public boolean emptyWatchLists()

changeDetected

public File changeDetected()

Deprecated.

replaced by changeDetectedInFile()

changeDetectedInFile

public File changeDetectedInFile()

Has a changed been detected in one of the files being watched?

Returns:

changeDetectedInURL

public URL changeDetectedInURL()

hasAtLeastOneWatchableFile

public boolean hasAtLeastOneWatchableFile()

Returns true if there are watchable files, false otherwise.

Returns:

true if there are watchable files, false otherwise.

Since:

1.5.8

isWatchableProtocol

public static boolean isWatchableProtocol(URL url)

Is protocol for the given URL a protocol that we can watch for.

Parameters:

url -

Returns:

true if watchable, false otherwise

Since:

1.5.9

isWatchableProtocol

public static boolean isWatchableProtocol(String protocolStr)

Is the given protocol a protocol that we can watch for.

Parameters:

protocolStr -

Returns:

true if watchable, false otherwise

Since:

1.5.9

getUrlWatchListAsStr

public String getUrlWatchListAsStr()

Returns the urlWatchList field as a String

Returns:

the urlWatchList field as a String

Since:

1.5.19

getFileWatchListAsStr

public String getFileWatchListAsStr()

Returns the fileWatchList field as a String

Returns:

the fileWatchList field as a String

Since:

1.5.19