com.lf.vfslib.core

Class VFSLibSettings

java.lang.Object

com.lf.vfslib.core.VFSLibSettings

public class VFSLibSettings
extends Object

Global settings for the VFSLib package.

Since:

1.6

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_PREFIX Prefix used for the log messages created by this module.
static String	MSG_PREFIX Prefix used for the log messages like "VFSLIB-0001".

Constructor Summary

Constructors

Constructor and Description
VFSLibSettings() Constructor method.

Method Summary

Modifier and Type	Method and Description
void	check() Performs some simple tests for the caches and configurations and creates log messages.
Properties	getDeployProps() Gets the global version information.
Logger	getLogger() Gets the global logging instance.
Locale	getLogLocale() Gets the global locale used for logging.
static VFSFileSystemManager	getManagerAllProtocols() Get a shared instance of the Commons FileSystemManager with support for all protocols.
static VFSFileSystemManager	getManagerNetwork() Get a shared instance of the Commons FileSystemManager holding the network connections.
byte[]	getReleaseNotes() Provides the locale specific release notes (core package).
static VFSLibSettings	getSharedInstance() Convenience method to get a shared instance.
Locale	getUserLocale() Gets the global user locale.
static String	getUserMessage(String code) Convenience method to get a localized official message for the user.
static String	getUserText(String variable) Convenience method to get a localized text for the user.
static String	getUserText(String variable, String[] regex, String[] replacement) Convenience method to get a localized text for the user.
static void	log(Level level, String message) Convenience method to log a message.
static void	log(Level level, Throwable throwable) Convenience method to log an exception.
static void	logMessage(Level level, String message) Convenience method to log a message.
static void	logMessage(String code, Level level) Convenience method to log a localized official message.
void	setLogger(Logger logger) Sets the global logging instance.
void	setUserLocale(Locale locale) Sets the global user locale.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_PREFIX

public static final String MSG_PREFIX

Prefix used for the log messages like "VFSLIB-0001".

See Also:

Constant Field Values

LOG_PREFIX

public static final String LOG_PREFIX

Prefix used for the log messages created by this module.

See Also:

Constant Field Values

Constructor Detail

VFSLibSettings

public VFSLibSettings()

Constructor method.

Since:

1.6

Method Detail

getManagerNetwork

public static VFSFileSystemManager getManagerNetwork()

Get a shared instance of the Commons FileSystemManager holding the network connections.

Here, the connections are managed while the global VFSFileSystemManager does not. The manager provides support for "real" network protocols like "http" or "sftp", all file based protocols like "jar" and "file" are automatically removed.

Returns:

Shared instance

Since:

1.6

getManagerAllProtocols

public static VFSFileSystemManager getManagerAllProtocols()

Get a shared instance of the Commons FileSystemManager with support for all protocols.

This one should be used when accessing files/folders on the classpath either "jar": or "file:".

Returns:

New instance

Since:

2.8

check

public void check()

Performs some simple tests for the caches and configurations and creates log messages.

If either the configurations, or the message codes, or the build properties are absent, then the application should be interrupted since this is fatal.

Since:

1.6

getLogger

public Logger getLogger()

Gets the global logging instance.

Returns:

Logging instance

Since:

1.6

setLogger

public void setLogger(Logger logger)

Sets the global logging instance.

Parameters:

logger - Logging instance

Throws:

NullPointerException - Error indication

Since:

1.6

getUserLocale

public Locale getUserLocale()

Gets the global user locale.

Returns:

Current user locale

Since:

1.6

setUserLocale

public void setUserLocale(Locale locale)
                   throws IllegalArgumentException

Sets the global user locale.

Make sure that the given new locale is supported by the settings class.

Parameters:

locale - Locale instance

Throws:

IllegalArgumentException - Error indication

Since:

1.6

getLogLocale

public Locale getLogLocale()

Gets the global locale used for logging.

At the moment this is static since exceptions and most System.outs are in English.

Returns:

Current logging locale

Since:

1.6

getDeployProps

public Properties getDeployProps()

Gets the global version information.

Returns:

Current version information

Since:

1.6

getReleaseNotes

public byte[] getReleaseNotes()

Provides the locale specific release notes (core package).

Returns:

The release notes as binary data, null if an error occurred

Since:

2.8

getSharedInstance

public static VFSLibSettings getSharedInstance()

Convenience method to get a shared instance.

Returns:

Shared instance

Since:

1.6

log

public static void log(Level level,
                       String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally English). The log prefix like "[vfslib]" is prepended.

Parameters:

level - The log level

message - The log message

Since:

1.6

log

public static void log(Level level,
                       Throwable throwable)

Convenience method to log an exception.

Make sure that the message applies to the current log locale (normally English). The log prefix like "[vfslib]" is prepended.

Parameters:

level - The log level

throwable - The exception

Since:

2.8

logMessage

public static void logMessage(Level level,
                              String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally English). The log prefix like "[vfslib]" is prepended.

Parameters:

level - The log level

message - The log message

Since:

1.6

logMessage

public static void logMessage(String code,
                              Level level)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally English). The domain identifier is printed (e.g. "VFSLIB-0006") while the package log prefix is omitted (e.g. "[vfslib]").

Parameters:

code - The log message id like "VFSLIB-0006"

level - The log level

Since:

1.6

getUserMessage

public static String getUserMessage(String code)

Convenience method to get a localized official message for the user.

The message is returned using the current user locale. The domain identifier is prepended (e.g. "VFSLIB-0006").

Parameters:

code - The message code of interest, don't pass null values

Returns:

The message text, null if code does not exist

Since:

1.6

getUserText

public static String getUserText(String variable)

Convenience method to get a localized text for the user.

The message is returned using the current user locale.

Parameters:

variable - The variable, don't pass null values

Returns:

The localized text or the variable

Since:

1.6

getUserText

public static String getUserText(String variable,
                                 String[] regex,
                                 String[] replacement)

Convenience method to get a localized text for the user.

The message is returned using the current user locale (e.g. "eng_US").

Parameters:

variable - The variable without class prefix, don't pass null values

regex - The regular expression

replacement - The replacement string

Returns:

The localized text or the variable

Since:

1.6