net.lecousin.framework.application

Class Application

java.lang.Object

net.lecousin.framework.application.Application

public final class Application
extends Object

Class holding application information such as properties, logging...

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CONFIG_DIRECTORY
static String	PROPERTY_INSTALLATION_DIRECTORY
static String	PROPERTY_LANGUAGE_TAG
static String	PROPERTY_LOG_DIRECTORY
static String	PROPERTY_LOGGING_CONFIGURATION_URL
static String	PROPERTY_TMP_DIRECTORY

Method Summary

Modifier and Type	Method and Description
void	closed(AsyncCloseable<?> c) Unregister an instance to close on application shutdown.
void	closed(Closeable c) Unregister an instance to close on application shutdown.
Map<String,String>	getApplicationSpecificProperties()
String	getArtifactId()
ApplicationClassLoader	getClassLoader() Return the application class loader.
List<String>	getCommandLineArguments()
Console	getConsole()
Object	getData(String name) Get a data associated with this application.
Logger	getDefaultLogger()
String	getGroupId()
<T> T	getInstance(Class<T> clazz) Return the singleton stored for this application.
String[]	getLanguageTag()
LibrariesManager	getLibrariesManager()
Locale	getLocale()
LocalizedProperties	getLocalizedProperties()
LoggerFactory	getLoggerFactory()
String	getPreference(String name) Return a preference.
String	getProperty(String name) Return the property value or null.
IO.Readable	getResource(String filename, byte priority) Get a resource from the class loader as an IO.Readable.
long	getStartTime()
ThreadFactory	getThreadFactory()
Version	getVersion()
void	interrupted(Thread t) Unregister a thread that must be interrupted on application shutdown.
boolean	isDebugMode()
boolean	isReleaseMode()
boolean	isStopping()
IAsync<Exception>	loadPreferences() Load preferences.
Object	removeData(String name) Remove a data associated with this application.
<T> T	removeInstance(Class<T> clazz) Remove the singleton stored for this application.
Object	setData(String name, Object value) Set a data associated with this application and return previously associated data with this name.
<T> T	setInstance(Class<T> clazz, T instance) Set the singleton stored for this application.
void	setLocale(Locale l) Set the new application language / locale.
void	setPreference(String name, String value) Set a preference.
void	setProperty(String name, String value) Set a property for this application.
static IAsync<ApplicationBootstrapException>	start(Artifact artifact, boolean debugMode) Method to call at the beginning of the application, typically in the main method.
static IAsync<ApplicationBootstrapException>	start(Artifact artifact, String[] args, boolean debugMode) Method to call at the beginning of the application, typically in the main method.
static IAsync<ApplicationBootstrapException>	start(Artifact artifact, String[] commandLineArguments, Map<String,String> properties, boolean debugMode, ThreadFactory threadFactory, LibrariesManager librariesManager, Appender defaultLogAppender) Method to call at the beginning of the application, typically in the main method.
void	stop() Stop this application and release resources.
void	toClose(AsyncCloseable<?> c) Register an instance to close on application shutdown.
void	toClose(Closeable c) Register an instance to close on application shutdown.
void	toInterruptOnShutdown(Thread t) Register a thread that must be interrupted on application shutdown.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_LOGGING_CONFIGURATION_URL

public static final String PROPERTY_LOGGING_CONFIGURATION_URL

See Also:

Constant Field Values

PROPERTY_INSTALLATION_DIRECTORY

public static final String PROPERTY_INSTALLATION_DIRECTORY

See Also:

Constant Field Values

PROPERTY_CONFIG_DIRECTORY

public static final String PROPERTY_CONFIG_DIRECTORY

See Also:

Constant Field Values

PROPERTY_LOG_DIRECTORY

public static final String PROPERTY_LOG_DIRECTORY

See Also:

Constant Field Values

PROPERTY_TMP_DIRECTORY

public static final String PROPERTY_TMP_DIRECTORY

See Also:

Constant Field Values

PROPERTY_LANGUAGE_TAG

public static final String PROPERTY_LANGUAGE_TAG

See Also:

Constant Field Values

Method Detail

getStartTime

public long getStartTime()

getGroupId

public String getGroupId()

getArtifactId

public String getArtifactId()

getVersion

public Version getVersion()

getCommandLineArguments

public List<String> getCommandLineArguments()

isDebugMode

public boolean isDebugMode()

isReleaseMode

public boolean isReleaseMode()

getProperty

public String getProperty(String name)

Return the property value or null. If it is not specified in application specific properties, it will return the system property if it exists.

setProperty

public void setProperty(String name,
                        String value)

Set a property for this application.

getApplicationSpecificProperties

public Map<String,String> getApplicationSpecificProperties()

getThreadFactory

public ThreadFactory getThreadFactory()

getConsole

public Console getConsole()

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale l)

Set the new application language / locale.

getLocalizedProperties

public LocalizedProperties getLocalizedProperties()

getLanguageTag

public String[] getLanguageTag()

getLoggerFactory

public LoggerFactory getLoggerFactory()

getDefaultLogger

public Logger getDefaultLogger()

getLibrariesManager

public LibrariesManager getLibrariesManager()

getClassLoader

public ApplicationClassLoader getClassLoader()

Return the application class loader.

getResource

public IO.Readable getResource(String filename,
                               byte priority)

Get a resource from the class loader as an IO.Readable.

toClose

public void toClose(Closeable c)

Register an instance to close on application shutdown.

toClose

public void toClose(AsyncCloseable<?> c)

Register an instance to close on application shutdown.

closed

public void closed(Closeable c)

Unregister an instance to close on application shutdown.

closed

public void closed(AsyncCloseable<?> c)

Unregister an instance to close on application shutdown.

toInterruptOnShutdown

public void toInterruptOnShutdown(Thread t)

Register a thread that must be interrupted on application shutdown.

interrupted

public void interrupted(Thread t)

Unregister a thread that must be interrupted on application shutdown.

isStopping

public boolean isStopping()

getInstance

public <T> T getInstance(Class<T> clazz)

Return the singleton stored for this application.

setInstance

public <T> T setInstance(Class<T> clazz,
                         T instance)

Set the singleton stored for this application.

removeInstance

public <T> T removeInstance(Class<T> clazz)

Remove the singleton stored for this application.

getData

public Object getData(String name)

Get a data associated with this application.

setData

public Object setData(String name,
                      Object value)

Set a data associated with this application and return previously associated data with this name.

removeData

public Object removeData(String name)

Remove a data associated with this application.

start

public static IAsync<ApplicationBootstrapException> start(Artifact artifact,
                                                          String[] commandLineArguments,
                                                          Map<String,String> properties,
                                                          boolean debugMode,
                                                          ThreadFactory threadFactory,
                                                          LibrariesManager librariesManager,
                                                          Appender defaultLogAppender)

Method to call at the beginning of the application, typically in the main method.

start

public static IAsync<ApplicationBootstrapException> start(Artifact artifact,
                                                          boolean debugMode)

Method to call at the beginning of the application, typically in the main method.

start

public static IAsync<ApplicationBootstrapException> start(Artifact artifact,
                                                          String[] args,
                                                          boolean debugMode)

Method to call at the beginning of the application, typically in the main method.

stop

public void stop()

Stop this application and release resources.

getPreference

public String getPreference(String name)

Return a preference.

setPreference

public void setPreference(String name,
                          String value)

Set a preference.

loadPreferences

public IAsync<Exception> loadPreferences()

Load preferences.