com.lf.digester.core

Class DigesterSettings

java.lang.Object

com.lf.digester.core.DigesterSettings

All Implemented Interfaces:

com.lf.commons.model.ConfigurableUnit, com.lf.commons.plaf.LookAndFeelListener

public class DigesterSettings
extends java.lang.Object
implements com.lf.commons.model.ConfigurableUnit, com.lf.commons.plaf.LookAndFeelListener

Global settings for the digester package.

Logging with log4j that comes with the great VFS library is disabled here since the Leisenfels modules uses java.util.logging.

Remember that the knock-out command line arguments have already been evaluated by the Digester main class. If you plan to add further arguments to be processed here these have to be added to the printUsage() method also.

Since:

1.5

Version:

$Revision: 1.136 $, $Date: 2015/01/23 16:00:15 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
java.io.File	configDir Local directory to use for storage of configuration files.
static java.lang.String	LOG_PREFIX Prefix used for the log messages created by this module.
static java.lang.String	MSG_PREFIX Prefix used for the log messages like "COMMONS-0001".
static java.lang.String	PACKAGE_PREFIX This base package.
protected static DigesterSettings	sharedInstance Shared DigesterSettings instance.

Constructor Summary

Constructors

Constructor and Description
DigesterSettings() Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
void	configureUnit(java.lang.String id, com.lf.commons.config.Configuration config) Restores values from persistent data stores.
void	displaySplashMessage(java.lang.String text) Displays the given text as message for the JVM splash screen.
void	evalArgumentsCLI(java.util.Hashtable<java.lang.String,java.lang.String[]> config, java.lang.String[] args) Evaluates command line arguments passed to the application (except knock-out args).
void	evalArgumentsGUI(java.util.Hashtable<java.lang.String,java.lang.String[]> config, java.lang.String[] args, java.util.Vector<java.util.logging.LogRecord> messages, java.lang.String[] fileargs) Evaluates command line arguments passed to the application (except knock-out args).
static void	exit(int code) Quits this application.
static int	extractLocalization(java.lang.Class clazz) Searches for localization patterns and reads the object texts into the configuration.
static int	extractLocalization(java.lang.Object target) Searches for localization patterns and reads the object texts into the configuration.
protected void	finalize() Cares for proper cleanup after releasing the object.
java.lang.String[]	getArguments() Provides the argument array passed to the main method.
java.io.File	getConfigDir() Get the local path to the configuration directory of the application (in the user's home).
DigesterController	getController() Provides the event callback instance (controller in MVC terms).
com.lf.commons.task.CronTaskManager	getCronManager() Provides the application specific manager running regularly tasks.
com.lf.commons.crypto.CryptoManager	getCryptoManager() Provides the application specific manager for cryptographic operations.
com.lf.commons.crypto.CryptoManager	getCryptoManagerPGP() Provides the application specific manager for cryptographic operations (PGP engine).
java.io.File	getCurrentLogFile() Provides the proper reference of the current log file (rotation is detected).
com.lf.commons.lang.DeployProps	getDeployProps() Gets the global version information.
static java.lang.String	getEnglishMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable) Convenience method to get the original (English) text.
static java.lang.String	getEnglishText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get the original (English) text.
com.lf.commons.i18n.I18NConfiguration	getEnglishTexts() Provides the English texts for the GUI (labels, tooltips etc.).
java.io.File	getEvaluationFile() Provides the local file indicating that the software is still being evaluated for installer.
java.lang.String[]	getFileArgs() Provides the file argument array passed to the main method.
DigesterHelp	getHelpDelegate() Gets the global help delegate.
static java.lang.String	getHelpID(java.lang.String id) Convenience method for utilizing the help delegate.
java.lang.String	getI18NBase() Provides the global resource path for internationalization resources.
com.lf.commons.i18n.I18NConfiguration	getI18NTexts() Provides the locale specific texts for the GUI (labels, tooltips etc.).
java.lang.String	getJVMID() Provides the unique identification of the current JVM (system wide).
org.apache.commons.vfs2.FileObject	getLicenseAgreement() Provides the locale specific license agreement (core package).
java.io.File	getLicenseFile() Provides the local license file reference.
DigesterLicenseManager	getLicenseManager() Provides the application specific manager for cryptographic operations.
java.lang.String	getLogEncoding() Gets the global encoding used for logging.
java.lang.String	getLogfileName() Provides the current log file used by the application.
java.util.logging.Logger	getLogger() Gets the global logging instance.
com.lf.commons.i18n.Locale	getLogLocale() Gets the global locale used for logging.
com.lf.commons.msg.MessageCodes	getMessageCodes() Provides the global message codes handlers.
DigesterModel	getModel() Provides the dynamic configuration reference (model in MVC terms).
com.lf.commons.crypto.PassphraseProvider	getPassphraseProviderAES() Returns the key provider.
com.lf.commons.crypto.PassphraseProvider	getPassphraseProviderSignature() Returns the signature provider.
com.lf.commons.task.PeriodicTaskManager	getPeriodicTaskManager() Provides the application specific manager for periodically executed tasks.
com.lf.commons.dialog.ReleaseNotes	getReleaseNotes() Provides the locale specific release notes (core package).
org.apache.commons.vfs2.FileObject	getReleaseNotesURL() Provides the locale specific release notes (core package).
org.apache.commons.vfs2.FileObject	getRootResourcePath() Provides the global resource path for configuration files.
static DigesterSettings	getSharedInstance() Convenience method to get a shared instance.
java.util.Vector<com.lf.commons.i18n.Locale>	getSupportedLocales(boolean synonyms) Returns the locales currently supported by the package.
java.io.PrintStream	getSystemErr() Provides the original standard error channel.
java.io.PrintStream	getSystemOut() Provides the original standard output channel.
java.lang.String	getTitle() Gets the main window title which may be extracted from the command line parameters.
org.apache.commons.vfs2.FileObject[]	getURLArgs() Provides the URL argument array passed to the main method.
com.lf.commons.i18n.Locale	getUserLocale() Gets the global user locale.
static java.lang.String	getUserMessage(java.lang.String code) Convenience method to get a localized official message for the user.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable) Convenience method to get a localized text for the user.
static java.lang.String	getUserText(java.lang.Class clazz, java.lang.String variable, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to get a localized text for the user.
DigesterView	getView() Provides the main window reference (view in MVC terms).
void	installGlobalAccelerators(javax.swing.JDialog dialog) Convenience to add the global accelerators like "F1" (help) for a specific dialog.
static boolean	isHelpLocaleSupported(com.lf.commons.i18n.Locale locale) Checks whether a help system is available for the given locale.
static int	localize(java.lang.Object target, java.lang.Class targetclazz) Searches for localization patterns and sets the object texts from the configuration.
static void	log(java.util.logging.Level level, java.lang.String message) Convenience method to log a message.
static void	logMessage(java.lang.String code, java.util.logging.Level level) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String[] regex, java.lang.String[] replacement) Convenience method to log a localized official message.
static void	logMessage(java.lang.String code, java.util.logging.Level level, java.lang.String regex, java.lang.String replacement) Convenience method to log a localized official message.
void	lookAndFeelChanged(java.lang.String plaf, java.lang.String theme) Reacts on changes of the look & feel performed by the manager.
void	prepareManagersCLI() Prepares the managers for the CLI application.
static void	registerConfigurable(java.lang.String id, com.lf.commons.model.ConfigurableUnit unit) Convenience method to allow for simple registration of a Digester configurable unit.
void	setConfigDir(java.io.File dir) Set the local path to the configuration directory of the application (in the user's home).
void	setLicenseManager(DigesterLicenseManager manager) Sets the application specific manager for cryptographic operations.
void	setModel(DigesterModel model) Sets the dynamic configuration reference (model in MVC terms).
void	setupUserLocale(com.lf.commons.i18n.Locale locale, java.util.Vector<java.util.logging.LogRecord> messages) Sets the global user locale.
void	setUserLocale(com.lf.commons.i18n.Locale locale) Sets the global user locale.
void	storeUnit(java.lang.String id, com.lf.commons.config.Configuration config) Stores the current configuration values persistently.
void	unitRegistered(com.lf.commons.model.ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(com.lf.commons.model.ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.
static void	unregisterConfigurable(com.lf.commons.model.ConfigurableUnit unit) Convenience method to allow for simple unregistration of a Digester configurable unit.
static void	unregisterConfigurable(java.lang.String id) Convenience method to allow for simple unregistration of a Digester configurable unit.
void	updateComponentTreeUI() The (hidden) components should be refreshed by SwingUtilities.updateComponentTreeUI().
void	updateEDTMonitor() Activates/deactivates the monitor detecting GUI freezes.

Methods inherited from class java.lang.Object

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

Field Detail

sharedInstance

protected static DigesterSettings sharedInstance

Shared DigesterSettings instance.

MSG_PREFIX

public static final java.lang.String MSG_PREFIX

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

See Also:

Constant Field Values

LOG_PREFIX

public static final java.lang.String LOG_PREFIX

Prefix used for the log messages created by this module.

See Also:

Constant Field Values

PACKAGE_PREFIX

public static final java.lang.String PACKAGE_PREFIX

This base package.

See Also:

Constant Field Values

configDir

public java.io.File configDir

Local directory to use for storage of configuration files.

Constructor Detail

DigesterSettings

public DigesterSettings()

Constructor method.

Since:

1.5

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Cares for proper cleanup after releasing the object.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

evalArgumentsGUI

public void evalArgumentsGUI(java.util.Hashtable<java.lang.String,java.lang.String[]> config,
                    java.lang.String[] args,
                    java.util.Vector<java.util.logging.LogRecord> messages,
                    java.lang.String[] fileargs)

Evaluates command line arguments passed to the application (except knock-out args).

Remember to check the flag options also if a regular option with one or multiple values is expected. The user perhaps simply forgets about a proper option value. For instance if the option "-config" was applied without any configuration file the container returns an empty string array since it detected a flag option properly.

Info arguments like "-help" print the data via System.out and exit. Then the logging is installed and all messages after this point will be printed using logging. Then the other arguments supported by the application are evaluated, and finally the unknown arguments are presented to the user while these parameters are simply ignored.

While this method is executed all attributes of the DigesterSettings class are loaded. When it is finished all settings can be fully utilized.

Parameters:

config - The configuration with options

args - Array of strings with console arguments

messages - Optional messages to be logged

fileargs - Optional file argument for call on Windows/Mac

Since:

1.5

prepareManagersCLI

public void prepareManagersCLI()

Prepares the managers for the CLI application.

Since:

1.6

evalArgumentsCLI

public void evalArgumentsCLI(java.util.Hashtable<java.lang.String,java.lang.String[]> config,
                    java.lang.String[] args)

Evaluates command line arguments passed to the application (except knock-out args).

This smaller variant parses the command line options of the CLI application version.

Parameters:

config - The configuration with options

args - Array of strings with console arguments

Since:

1.6

setupUserLocale

public void setupUserLocale(com.lf.commons.i18n.Locale locale,
                   java.util.Vector<java.util.logging.LogRecord> messages)
                     throws java.lang.IllegalArgumentException

Sets the global user locale.

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

Parameters:

locale - Locale instance

messages - Called before logger is installed, so we collect log messages

Throws:

java.lang.IllegalArgumentException - Error indication

getSupportedLocales

public java.util.Vector<com.lf.commons.i18n.Locale> getSupportedLocales(boolean synonyms)

Returns the locales currently supported by the package.

Parameters:

synonyms - Also add the ISO 639-1/2 synonyms like "deu_DE" for "ger_DE"?

Returns:

The supported locales, maybe empty

Since:

1.5

getRootResourcePath

public org.apache.commons.vfs2.FileObject getRootResourcePath()

Provides the global resource path for configuration files.

Returns:

The resource path

Since:

1.5

getI18NBase

public java.lang.String getI18NBase()

Provides the global resource path for internationalization resources.

Returns:

The i18n path to be loaded from separate JARs

Since:

1.5

getMessageCodes

public com.lf.commons.msg.MessageCodes getMessageCodes()

Provides the global message codes handlers.

Returns:

The message codes handlers

Since:

1.5

getUserLocale

public com.lf.commons.i18n.Locale getUserLocale()

Gets the global user locale.

Returns:

Current user locale

setUserLocale

public void setUserLocale(com.lf.commons.i18n.Locale locale)

Sets the global user locale.

This method should only be called if the locale is switched from the menu items and if the application is restarted immediately. The given locale is restored then. Normal locale should be done by calling the setupUserLocale method.

Parameters:

locale - User locale

Since:

1.6

getLogLocale

public com.lf.commons.i18n.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

getLogEncoding

public java.lang.String getLogEncoding()

Gets the global encoding used for logging.

This value can be adjusted using command line parameters.

Returns:

Current logging encoding

getLogger

public java.util.logging.Logger getLogger()

Gets the global logging instance.

Returns:

Logging instance

getConfigDir

public java.io.File getConfigDir()

Get the local path to the configuration directory of the application (in the user's home).

Returns:

The local configuration directory

Since:

1.5

setConfigDir

public void setConfigDir(java.io.File dir)

Set the local path to the configuration directory of the application (in the user's home).

Parameters:

dir - The local configuration directory

Since:

1.5

getJVMID

public java.lang.String getJVMID()

Provides the unique identification of the current JVM (system wide).

Returns:

JVM identifier

getLogfileName

public java.lang.String getLogfileName()

Provides the current log file used by the application.

Due to log rotation this file must not be necessarily be used in reality! It's only the base name for the application to use for logging.

Returns:

Path of the log file

See Also:

getCurrentLogFile()

getCurrentLogFile

public java.io.File getCurrentLogFile()

Provides the proper reference of the current log file (rotation is detected).

Returns:

Current log file

See Also:

getLogfileName()

getSystemOut

public java.io.PrintStream getSystemOut()

Provides the original standard output channel.

Returns:

Standard output channel

getSystemErr

public java.io.PrintStream getSystemErr()

Provides the original standard error channel.

Returns:

Standard error channel

getI18NTexts

public com.lf.commons.i18n.I18NConfiguration getI18NTexts()

Provides the locale specific texts for the GUI (labels, tooltips etc.).

Returns:

The locale specific texts

getEnglishTexts

public com.lf.commons.i18n.I18NConfiguration getEnglishTexts()

Provides the English texts for the GUI (labels, tooltips etc.).

Returns:

The English texts

localize

public static int localize(java.lang.Object target,
           java.lang.Class targetclazz)

Searches for localization patterns and sets the object texts from the configuration.

Parameters:

target - The target object to be localized

targetclazz - The target clazz, maybe a superclass

Returns:

Number of successfully localized fields

Since:

1.5

extractLocalization

public static int extractLocalization(java.lang.Object target)

Searches for localization patterns and reads the object texts into the configuration.

Method checks both annotations from class and fields from instance.

Parameters:

target - The target object to be localized

Returns:

Number of successfully retrieved fields

Since:

1.5

extractLocalization

public static int extractLocalization(java.lang.Class clazz)

Searches for localization patterns and reads the object texts into the configuration.

Method checks annotations from class only e.g. for abstract classes.

Parameters:

clazz - The target class to be localized

Returns:

Number of successfully retrieved fields

Since:

1.5

setModel

public void setModel(DigesterModel model)

Sets the dynamic configuration reference (model in MVC terms).

Parameters:

model - The dynamic configuration

getModel

public DigesterModel getModel()

Provides the dynamic configuration reference (model in MVC terms).

Returns:

The dynamic configuration

getView

public DigesterView getView()

Provides the main window reference (view in MVC terms).

Returns:

The main window

getController

public DigesterController getController()

Provides the event callback instance (controller in MVC terms).

Returns:

Event callback instance

getArguments

public java.lang.String[] getArguments()

Provides the argument array passed to the main method.

Returns:

Command line arguments

getFileArgs

public java.lang.String[] getFileArgs()

Provides the file argument array passed to the main method.

Returns:

File arguments from the command line

getURLArgs

public org.apache.commons.vfs2.FileObject[] getURLArgs()

Provides the URL argument array passed to the main method.

Returns:

URL arguments from the command line

getCryptoManager

public com.lf.commons.crypto.CryptoManager getCryptoManager()

Provides the application specific manager for cryptographic operations.

Returns:

The pre-configured cryptographic manager

getLicenseManager

public DigesterLicenseManager getLicenseManager()

Provides the application specific manager for cryptographic operations.

Returns:

The pre-configured cryptographic manager

setLicenseManager

public void setLicenseManager(DigesterLicenseManager manager)

Sets the application specific manager for cryptographic operations.

Parameters:

manager - The pre-configured cryptographic manager

getCronManager

public com.lf.commons.task.CronTaskManager getCronManager()

Provides the application specific manager running regularly tasks.

Returns:

The pre-configured cron manager

getPeriodicTaskManager

public com.lf.commons.task.PeriodicTaskManager getPeriodicTaskManager()

Provides the application specific manager for periodically executed tasks.

Returns:

The pre-configured manager

getDeployProps

public com.lf.commons.lang.DeployProps getDeployProps()

Gets the global version information.

Returns:

Current version information

getTitle

public java.lang.String getTitle()

Gets the main window title which may be extracted from the command line parameters.

Returns:

Main window title

getLicenseFile

public java.io.File getLicenseFile()

Provides the local license file reference.

Returns:

Current license file

getEvaluationFile

public java.io.File getEvaluationFile()

Provides the local file indicating that the software is still being evaluated for installer.

Returns:

Current evaluation file

getSharedInstance

public static DigesterSettings getSharedInstance()

Convenience method to get a shared instance.

Returns:

Shared instance

log

public static void log(java.util.logging.Level level,
       java.lang.String message)

Convenience method to log a message.

Make sure that the message applies to the current log locale (normally "eng_US"). The log prefix like "[commons]" is not prepended (only libraries do).

Parameters:

level - The log level

message - The log message

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "DIGEST-0006").

Parameters:

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

level - The log level

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String regex,
              java.lang.String replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "DIGEST-0006").

Parameters:

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

level - The log level

regex - The regular expression

replacement - The replacement string

logMessage

public static void logMessage(java.lang.String code,
              java.util.logging.Level level,
              java.lang.String[] regex,
              java.lang.String[] replacement)

Convenience method to log a localized official message.

The message is logged using the current log locale (normally "eng_US"). The domain identifier is printed (e.g. "DIGEST-0006").

Parameters:

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

level - The log level

regex - The regular expressions

replacement - The replacement strings

getUserMessage

public static java.lang.String getUserMessage(java.lang.String code)

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

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

Parameters:

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

Returns:

The message text, null if code does not exist

getEnglishMessage

public static java.lang.String getEnglishMessage(java.lang.String code)

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

The message is returned using the "eng_US" locale. The domain identifier is prepended (e.g. "DIGEST-0006").

Parameters:

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

Returns:

The message text, null if code does not exist

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable)

Convenience method to get a localized text for the user.

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

Parameters:

clazz - The class for getting the class prefix

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

Returns:

The localized text, null if variable does not exist

getUserText

public static java.lang.String getUserText(java.lang.Class clazz,
                           java.lang.String variable,
                           java.lang.String[] regex,
                           java.lang.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:

clazz - The class for getting the class prefix

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

regex - The regular expressions

replacement - The replacement strings

Returns:

The localized text, null if variable does not exist

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable)

Convenience method to get the original (English) text.

The message is returned using the locale "eng_US". These texts are useful for the support.

Parameters:

clazz - The class for getting the class prefix

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

Returns:

The localized text, null if variable does not exist

Since:

1.6

getEnglishText

public static java.lang.String getEnglishText(java.lang.Class clazz,
                              java.lang.String variable,
                              java.lang.String[] regex,
                              java.lang.String[] replacement)

Convenience method to get the original (English) text.

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

Parameters:

clazz - The class for getting the class prefix

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

getReleaseNotesURL

public org.apache.commons.vfs2.FileObject getReleaseNotesURL()

Provides the locale specific release notes (core package).

Returns:

The release notes URL

Since:

1.6

getReleaseNotes

public com.lf.commons.dialog.ReleaseNotes getReleaseNotes()

Provides the locale specific release notes (core package).

Returns:

The release notes

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 com.lf.commons.config.Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface com.lf.commons.model.ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             com.lf.commons.config.Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface com.lf.commons.model.ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(com.lf.commons.model.ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface com.lf.commons.model.ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(com.lf.commons.model.ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface com.lf.commons.model.ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

lookAndFeelChanged

public void lookAndFeelChanged(java.lang.String plaf,
                      java.lang.String theme)

Reacts on changes of the look & feel performed by the manager.

Specified by:

lookAndFeelChanged in interface com.lf.commons.plaf.LookAndFeelListener

Parameters:

plaf - The current look & feel in fully qualified notation

theme - The configuration of the specific look & feel, may be null

Since:

1.6

updateComponentTreeUI

public void updateComponentTreeUI()

The (hidden) components should be refreshed by SwingUtilities.updateComponentTreeUI().

May be called by the manager if font sizes, colors etc. have been changed.

Specified by:

updateComponentTreeUI in interface com.lf.commons.plaf.LookAndFeelListener

Since:

1.6

registerConfigurable

public static void registerConfigurable(java.lang.String id,
                        com.lf.commons.model.ConfigurableUnit unit)

Convenience method to allow for simple registration of a Digester configurable unit.

Parameters:

id - The unique id defined by

unit - The configurable unit to be added

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

unregisterConfigurable

public static void unregisterConfigurable(com.lf.commons.model.ConfigurableUnit unit)

Convenience method to allow for simple unregistration of a Digester configurable unit.

Parameters:

unit - The unit to be removed

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

unregisterConfigurable

public static void unregisterConfigurable(java.lang.String id)

Convenience method to allow for simple unregistration of a Digester configurable unit.

Parameters:

id - The unique identifier

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

isHelpLocaleSupported

public static boolean isHelpLocaleSupported(com.lf.commons.i18n.Locale locale)

Checks whether a help system is available for the given locale.

Parameters:

locale - The locale to be checked

Returns:

Localized help system available?

Since:

1.6

getHelpDelegate

public DigesterHelp getHelpDelegate()

Gets the global help delegate.

Returns:

Help delegate

getHelpID

public static java.lang.String getHelpID(java.lang.String id)

Convenience method for utilizing the help delegate.

Parameters:

id - One of the declared static fields of DigesterHelp

Returns:

The help system link, may be null

updateEDTMonitor

public void updateEDTMonitor()

Activates/deactivates the monitor detecting GUI freezes.

installGlobalAccelerators

public void installGlobalAccelerators(javax.swing.JDialog dialog)

Convenience to add the global accelerators like "F1" (help) for a specific dialog.

Parameters:

dialog - The dialog

Since:

1.6

getCryptoManagerPGP

public com.lf.commons.crypto.CryptoManager getCryptoManagerPGP()

Provides the application specific manager for cryptographic operations (PGP engine).

Returns:

The pre-configured cryptographic manager

getPassphraseProviderAES

public com.lf.commons.crypto.PassphraseProvider getPassphraseProviderAES()

Returns the key provider.

Returns:

The pre-configured provider

getPassphraseProviderSignature

public com.lf.commons.crypto.PassphraseProvider getPassphraseProviderSignature()

Returns the signature provider.

Returns:

The pre-configured provider

getLicenseAgreement

public org.apache.commons.vfs2.FileObject getLicenseAgreement()

Provides the locale specific license agreement (core package).

Returns:

The agreement

Since:

1.6

displaySplashMessage

public void displaySplashMessage(java.lang.String text)

Displays the given text as message for the JVM splash screen.

Parameters:

text - The message to be displayed

Since:

1.6

exit

public static void exit(int code)

Quits this application.

For Web Start it's necessary to do special things finally like redirecting the system streams (may hang otherwise).

Parameters:

code - Return code, 0=OK, 1=error, -1=do not exit finally

Since:

1.6