org.mdi.app

Class AbstractApplication

java.lang.Object

org.mdi.app.AbstractApplication

All Implemented Interfaces:

CommandLineListener, MDIApplication, PluginsListener

Direct Known Subclasses:

AbstractMDIApplication

public abstract class AbstractApplication
extends java.lang.Object
implements MDIApplication, PluginsListener, CommandLineListener

An abstract MDIApplication which does not provide a GUI. However, it provides the following utilities:

• A Plugin configuration framework
• A Menu Factory
• An action framework
• A Configuration / Preferences framework

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,AppliManifestType>	additionalPluginTypes The additional Plugins Types, optional property.
protected java.util.Map<java.lang.String,java.lang.Boolean>	allowedPluginTypes The allowed Plugins Types, optional property.
protected ApplicationDesc	appDesc The application description.
protected java.util.Map<java.lang.String,java.lang.String>	argsMap The arguments map (null by default).
protected CommandLineHandler	commandLineHandler The command-line handler.
protected Configuration	conf The associated Configuration.
protected ConfigurationManager	confmanager The MDIApplication associated ConfigurationManager.
protected java.util.Map<java.lang.String,java.lang.Short>	customActions The map of custom actions.
protected ErrorLogger	errorLogger The Error logger.
protected java.util.List<Plugin>	plugins The list of loaded Plugins.
protected java.io.File	pluginsConfiguration The plugins definition xml file name.
protected boolean	pluginsDefInFile True if the plugins definition is stored in a XML File (false by default).
protected java.io.File	pluginsDir The plugins directory.
protected PluginsManager	pluginsManager The MDIApplication associated PluginsManager.
protected java.util.Map<java.lang.String,Plugin>	pluginsMap The Map of loaded Plugins.
protected ThreadQueue	queue The MDIApplication associated ThreadQueue (managing Actions).
protected long	time Store the current time when tarting an action, and the time to execute the action after it has been executed.

Constructor Summary

Constructors

Constructor and Description
AbstractApplication()

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalPluginType(java.lang.String key, AppliManifestType manifestType) Add an additional Plugin type.
void	addCustomAction(java.lang.String actionName, short customActionType) Add a custom action.
void	addPluginDirectory(java.net.URL pluginDir) Add an URL defining a directory where to look for Plugins.
protected void	applyCommandLineArguments() Apply the command-line arguments to both the application and its plugins.
protected abstract ThreadQueue	createThreadQueue() Create the ThreadQueue.
void	disposeApplication() Dispose of the Application, and serialize its resources if a Configuration manager has been set.
void	endAction(MDIAction action) Ends a generic action.
void	executeAction(MDIAction action, short blockingType) Execute a generic Action.
void	executeAction(MDIAction action, short blockingType, java.lang.ClassLoader loader) Execute a generic Action, using a specific Classloader.
boolean	executeCustomAction(java.lang.String actionName, java.lang.Object... arguments) Execute a blocking custom action.
boolean	executeCustomAction(java.lang.String actionName, short blockingType, java.lang.Object... arguments) Execute a custom action.
java.util.Map<java.lang.String,AppliManifestType>	getAdditionalPluginTypes() Return the optional additional Plugin Types.
java.util.Map<java.lang.String,java.lang.Boolean>	getAllowedPluginTypes() Return the allowed Plugin Types.
ApplicationDesc	getApplicationDesc() Return the Application description.
java.util.Map<java.lang.String,java.lang.String>	getCommandLineArguments() Return the launch arguments of the application.
CommandLineHandler	getCommandLineHandler() Return the command-line handler.
ConfigurationManager	getConfigurationManager() Return the Configuration Manager.
ErrorLogger	getErrorLogger() Return the error logger.
Plugin	getPlugin(java.lang.String clazz) Return the Plugin, given its associated class path.
Plugin	getPluginForName(java.lang.String name) Return the Plugin, given its associated name.
java.util.List<Plugin>	getPlugins() Return the Plugins List.
PluginsManager	getPluginsManager() Return the PluginsManager.
java.util.Map<java.lang.String,Plugin>	getPluginsMap() Return Plugins Map.
ThreadQueue	getThreadQueue() Return the MDIApplication ThreadQueue.
long	getTime() Return the time after the last operation.
boolean	hasPlugin(java.lang.String name) Return true if the application has a Plugin of the specified name.
boolean	hasPluginsDirectories() Return true if there is a plugins directpry or directory List.
boolean	hasPluginsDirectoryList() Return true if there is a plugins directory List.
boolean	hasSinglePluginsDirectory() Return true if there is a single plugins directory.
protected void	initConfiguration() Creates the Configuration, with no root Preferences.
protected void	initConfiguration(java.util.prefs.Preferences prefRoot) Creates the Configuration, and initialize it with a root Preference.
protected void	initConfiguration(java.util.prefs.Preferences prefRoot, java.io.File dir) Creates the Configuration, and initialize it with a root Preference.
protected void	initConfiguration(java.util.prefs.Preferences prefRoot, java.io.File dir, short mdiPluginsInitMode) Creates the Configuration, and initialize it with a root Preference.
protected void	initConfiguration(java.util.prefs.Preferences prefRoot, short mdiPluginsInitMode) Creates the Configuration, and initialize it with a root Preference.
protected void	initProcessFromRegister() Call the initialization process when in the register phase of the Plugins.
boolean	isDefaultBlockingActions() Return true if actions are blocking by default.
protected void	loadResources() Load resources (as Icons) used in the Application.
void	noTimeMessages() Do nothing by default.
void	noWriteMessages() Do nothing by default.
void	pluginsActionPerformed(PluginsEvent event) Does nothing by default.
protected void	registerPlugins() Register the Plugins.
protected void	serializeConfiguration() Serialize the configuration.
void	setAllowedPluginTypes(java.util.Map<java.lang.String,java.lang.Boolean> allowedPluginTypes) Set the allowed Plugin Types.
void	setCommandLineArguments(java.util.Map<java.lang.String,java.lang.String> args) Set the command-line arguments.
void	setCommandLineArguments(java.lang.String[] args) Set the command-line arguments.
void	setCommandLineArguments(java.lang.String[] args, boolean keepDash) Set the command-line arguments.
void	setCommandLineHandler(CommandLineHandler handler) Set the command-line handler.
protected void	setConfiguration(Configuration conf) Set the application configuration.
void	setDefaultBlockingActions(boolean isBlocking) Set if actions are blocking by default.
void	setErrorLogger(ErrorLogger errorLogger) Set the error logger.
protected void	setPluginsConfiguration(java.io.File pluginsDir) Set the plugins directory.
protected void	setPluginsConfiguration(java.io.File pluginsDir, java.lang.String pluginsConfigFileName) Set the plugins configuration for the application.
protected void	setPluginsConfigurationFile(java.io.File pluginsDir, java.io.File pluginsConfiguration) Set the plugins configuration for the application.
void	showActionException(java.lang.String message, java.lang.Exception e) Show the Exception stackTrace by default.
void	startTime(MDIAction action) Start to count the time for the last operation, and show the statusBar progress.
long	stopTime(MDIAction action) Return the time after the last operation and stop the progress bar if there is any.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mdi.bootstrap.MDIApplication

executeAction, executeAction, getApplicationID, getPluginsEDTSupport, getStartDirectory

Methods inherited from interface org.mdi.bootstrap.launcher.CommandLineListener

getCommandLineConfiguration, handleCommandLineArguments, handleCommandLineArguments, handleCommandLineException

Field Detail

conf

protected Configuration conf

The associated Configuration.

appDesc

protected ApplicationDesc appDesc

The application description.

time

protected volatile long time

Store the current time when tarting an action, and the time to execute the action after it has been executed.

plugins

protected java.util.List<Plugin> plugins

The list of loaded Plugins.

pluginsMap

protected java.util.Map<java.lang.String,Plugin> pluginsMap

The Map of loaded Plugins.

pluginsDir

protected java.io.File pluginsDir

The plugins directory.

queue

protected ThreadQueue queue

The MDIApplication associated ThreadQueue (managing Actions).

pluginsConfiguration

protected java.io.File pluginsConfiguration

The plugins definition xml file name.

allowedPluginTypes

protected java.util.Map<java.lang.String,java.lang.Boolean> allowedPluginTypes

The allowed Plugins Types, optional property.

additionalPluginTypes

protected java.util.Map<java.lang.String,AppliManifestType> additionalPluginTypes

The additional Plugins Types, optional property.

pluginsDefInFile

protected boolean pluginsDefInFile

True if the plugins definition is stored in a XML File (false by default).

See Also:

pluginsConfiguration

confmanager

protected ConfigurationManager confmanager

The MDIApplication associated ConfigurationManager.

pluginsManager

protected PluginsManager pluginsManager

The MDIApplication associated PluginsManager.

customActions

protected java.util.Map<java.lang.String,java.lang.Short> customActions

The map of custom actions.

errorLogger

protected ErrorLogger errorLogger

The Error logger.

commandLineHandler

protected CommandLineHandler commandLineHandler

The command-line handler.

argsMap

protected java.util.Map<java.lang.String,java.lang.String> argsMap

The arguments map (null by default).

Constructor Detail

AbstractApplication

public AbstractApplication()

Method Detail

initConfiguration

protected final void initConfiguration()

Creates the Configuration, with no root Preferences.

getApplicationDesc

public ApplicationDesc getApplicationDesc()

Return the Application description.

Specified by:

getApplicationDesc in interface MDIApplication

Returns:

the Application description

getAllowedPluginTypes

public java.util.Map<java.lang.String,java.lang.Boolean> getAllowedPluginTypes()

Return the allowed Plugin Types. Plugins which have the PluginsManager.KEY_PLUGIN_TYPE attribute in their manifest will have to match one of the Application allowed plugin type names.

Specified by:

getAllowedPluginTypes in interface MDIApplication

Returns:

the allowed Plugin Types

getAdditionalPluginTypes

public java.util.Map<java.lang.String,AppliManifestType> getAdditionalPluginTypes()

Return the optional additional Plugin Types. Contrary to the allowed Plugin Types the manifest key for these types is up to the application. It allows to define additional constraints which will define if Plugins will be loaded.

Specified by:

getAdditionalPluginTypes in interface MDIApplication

Returns:

the optional additional Plugin Types

See Also:

PluginsManager.setAdditionalPluginTypes(java.util.Map)

addPluginDirectory

public final void addPluginDirectory(java.net.URL pluginDir)

Add an URL defining a directory where to look for Plugins.

Parameters:

pluginDir - the directory as an URL

setAllowedPluginTypes

public final void setAllowedPluginTypes(java.util.Map<java.lang.String,java.lang.Boolean> allowedPluginTypes)

Set the allowed Plugin Types. Plugins which have the PluginsManager.KEY_PLUGIN_TYPE attribute in their manifest will have to match one of the Application allowed plugin type names.

Parameters:

allowedPluginTypes - the Map of allowed Plugin types

See Also:

PluginsManager.setAllowedPluginTypes(java.util.Map)

addAdditionalPluginType

protected void addAdditionalPluginType(java.lang.String key,
                                       AppliManifestType manifestType)

Add an additional Plugin type.

Parameters:

key - the key to look for in the Plugin Manifest

manifestType - the type of the application relative to the manifest key

See Also:

PluginsManager.setAdditionalPluginTypes(java.util.Map)

setErrorLogger

public void setErrorLogger(ErrorLogger errorLogger)

Set the error logger.

Parameters:

errorLogger - the error logger

getErrorLogger

public ErrorLogger getErrorLogger()

Return the error logger.

Specified by:

getErrorLogger in interface MDIApplication

Returns:

the error logger

setDefaultBlockingActions

public void setDefaultBlockingActions(boolean isBlocking)

Set if actions are blocking by default.

Specified by:

setDefaultBlockingActions in interface MDIApplication

Parameters:

isBlocking - true if actions are blocking by default

isDefaultBlockingActions

public boolean isDefaultBlockingActions()

Return true if actions are blocking by default.

Specified by:

isDefaultBlockingActions in interface MDIApplication

Returns:

true if actions are blocking by default

hasPluginsDirectories

public boolean hasPluginsDirectories()

Return true if there is a plugins directpry or directory List.

Returns:

true if there is a plugins directpry or directory List

hasSinglePluginsDirectory

public boolean hasSinglePluginsDirectory()

Return true if there is a single plugins directory.

Returns:

true if there is a single plugins directory

hasPluginsDirectoryList

public boolean hasPluginsDirectoryList()

Return true if there is a plugins directory List.

Returns:

true if there is a plugins directory List

setPluginsConfiguration

protected void setPluginsConfiguration(java.io.File pluginsDir)

Set the plugins directory.

Parameters:

pluginsDir - the directory

setPluginsConfigurationFile

protected void setPluginsConfigurationFile(java.io.File pluginsDir,
                                           java.io.File pluginsConfiguration)

Set the plugins configuration for the application.

Parameters:

pluginsDir - the plugins directory

pluginsConfiguration - the XML File holding the plugins entry-point classes

setPluginsConfiguration

protected void setPluginsConfiguration(java.io.File pluginsDir,
                                       java.lang.String pluginsConfigFileName)

Set the plugins configuration for the application.

Parameters:

pluginsDir - the plugins directory

pluginsConfigFileName - the name of the XML File holding the plugins entry-point classes

pluginsActionPerformed

public void pluginsActionPerformed(PluginsEvent event)

Does nothing by default.

Specified by:

pluginsActionPerformed in interface PluginsListener

Parameters:

event - the PluginsEvent

initConfiguration

protected void initConfiguration(java.util.prefs.Preferences prefRoot)

Creates the Configuration, and initialize it with a root Preference. This method is fairly configurable:

• If the root preference is null, no Configuration manager will be created, and the Configuration won't be deserialized nor serialized
• If the pluginsDir is not null, the application will look for Plugins in this directory. There are two ways of asking the applicatin to load a Plugin in this directory (Plugins are distributed as jar Files in this directory):
  • If the pluginsDefInFile property is set to true, the application will look for an XML File called pluginsConfiguration, defining the Plugin classes to load
  • If the pluginsDefInFile property is set to false, the application will look for the manifest of the Jar files in this directory, defining the Plugin classes to load

Parameters:

prefRoot - the root Preference, or null if there is no Preference for this MDIApplication

See Also:

PluginsManager

initConfiguration

protected void initConfiguration(java.util.prefs.Preferences prefRoot,
                                 short mdiPluginsInitMode)

Creates the Configuration, and initialize it with a root Preference. This method is fairly configurable:

• If the root preference is null, no Configuration manager will be created, and the Configuration won't be deserialized nor serialized
• If the pluginsDir is not null, the application will look for Plugins in this directory. There are two ways of asking the application to load a Plugin in this directory (Plugins are distributed as jar Files in this directory):
  • If the pluginsDefInFile property is set to true, the application will look for an XML File called pluginsConfiguration, defining the Plugin classes to load
  • If the pluginsDefInFile property is set to false, the application will look for the manifest of the Jar files in this directory, defining the Plugin classes to load

Parameters:

prefRoot - the root Preference, or null if there is no Preference for this MDIApplication

mdiPluginsInitMode - the plugins initialization mode

See Also:

PluginsManager

createThreadQueue

protected abstract ThreadQueue createThreadQueue()

Create the ThreadQueue.

Returns:

the ThreadQueue

getThreadQueue

public final ThreadQueue getThreadQueue()

Return the MDIApplication ThreadQueue.

Returns:

the MDIApplication ThreadQueue

setConfiguration

protected void setConfiguration(Configuration conf)

Set the application configuration.

Parameters:

conf - the application configuration

initConfiguration

protected void initConfiguration(java.util.prefs.Preferences prefRoot,
                                 java.io.File dir)

Creates the Configuration, and initialize it with a root Preference.

Parameters:

prefRoot - the root Preference, or null if there is no Preference for this MDIApplication

dir - the reference directory for the configuration. If the directory is null, the default one will be used.

See Also:

initConfiguration(java.util.prefs.Preferences), PluginsManager

initConfiguration

protected void initConfiguration(java.util.prefs.Preferences prefRoot,
                                 java.io.File dir,
                                 short mdiPluginsInitMode)

Creates the Configuration, and initialize it with a root Preference.

Parameters:

mdiPluginsInitMode - the plugins initialization mode

prefRoot - the root Preference, or null if there is no Preference for this MDIApplication

dir - the reference directory for the configuration. If the directory is null, the default one will be used.

See Also:

initConfiguration(java.util.prefs.Preferences), PluginsManager

startTime

public void startTime(MDIAction action)

Start to count the time for the last operation, and show the statusBar progress.

Specified by:

startTime in interface MDIApplication

Parameters:

action - the Action

getTime

public final long getTime()

Return the time after the last operation.

Specified by:

getTime in interface MDIApplication

Returns:

the time after the last operation

stopTime

public long stopTime(MDIAction action)

Return the time after the last operation and stop the progress bar if there is any.

Specified by:

stopTime in interface MDIApplication

Parameters:

action - the Action

Returns:

the elapsed time

executeAction

public void executeAction(MDIAction action,
                          short blockingType)

Execute a generic Action.

Blocking types

The blocking type can be:

• BlockingType.DEFAULT: use the default blocking type of the application
• BlockingType.BLOCKING: if the action should be blocking
• BlockingType.NOT_BLOCKING: if the action should not be blocking

Specified by:

executeAction in interface MDIApplication

Parameters:

action - the Action

blockingType - the enumeration specifying if the action should be blocking

executeAction

public void executeAction(MDIAction action,
                          short blockingType,
                          java.lang.ClassLoader loader)

Execute a generic Action, using a specific Classloader.

Blocking types

The blocking type can be:

• BlockingType.DEFAULT: use the default blocking type of the application
• BlockingType.BLOCKING: if the action should be blocking
• BlockingType.NOT_BLOCKING: if the action should not be blocking

Specified by:

executeAction in interface MDIApplication

Parameters:

action - the Action

blockingType - the enumeration specifying if the action should be blocking

loader - the ClassLoader to execute the action

showActionException

public void showActionException(java.lang.String message,
                                java.lang.Exception e)

Show the Exception stackTrace by default. Can be overriden.

Specified by:

showActionException in interface MDIApplication

Parameters:

message - the message to show

e - the Exception

registerPlugins

protected void registerPlugins()

Register the Plugins.

setCommandLineHandler

public void setCommandLineHandler(CommandLineHandler handler)

Set the command-line handler.

Specified by:

setCommandLineHandler in interface CommandLineListener

Parameters:

handler - the handler

getCommandLineHandler

public CommandLineHandler getCommandLineHandler()

Return the command-line handler.

Specified by:

getCommandLineHandler in interface CommandLineListener

Returns:

the handler

getCommandLineArguments

public java.util.Map<java.lang.String,java.lang.String> getCommandLineArguments()

Return the launch arguments of the application. Return null by default.

Specified by:

getCommandLineArguments in interface MDIApplication

Returns:

the launch arguments of the application

setCommandLineArguments

public void setCommandLineArguments(java.lang.String[] args,
                                    boolean keepDash)

Set the command-line arguments.

Parameters:

args - the arguments

keepDash - true if the dash character at the beginning of each argument must be kept

setCommandLineArguments

public void setCommandLineArguments(java.lang.String[] args)

Set the command-line arguments.

Parameters:

args - the arguments

setCommandLineArguments

public void setCommandLineArguments(java.util.Map<java.lang.String,java.lang.String> args)

Set the command-line arguments.

Parameters:

args - the arguments

applyCommandLineArguments

protected void applyCommandLineArguments()

Apply the command-line arguments to both the application and its plugins.

initProcessFromRegister

protected void initProcessFromRegister()

Call the initialization process when in the register phase of the Plugins.

getConfigurationManager

public ConfigurationManager getConfigurationManager()

Return the Configuration Manager.

Specified by:

getConfigurationManager in interface MDIApplication

Returns:

the Configuration Manager

getPluginsManager

public PluginsManager getPluginsManager()

Return the PluginsManager.

Specified by:

getPluginsManager in interface MDIApplication

Returns:

the PluginsManager

getPlugins

public final java.util.List<Plugin> getPlugins()

Return the Plugins List.

Specified by:

getPlugins in interface MDIApplication

Returns:

the Plugins List

getPluginsMap

public final java.util.Map<java.lang.String,Plugin> getPluginsMap()

Return Plugins Map.

Specified by:

getPluginsMap in interface MDIApplication

Returns:

the Plugins Map

hasPlugin

public boolean hasPlugin(java.lang.String name)

Return true if the application has a Plugin of the specified name.

Specified by:

hasPlugin in interface MDIApplication

Parameters:

name - the Plugin name

Returns:

true if the application has a Plugin of the specified name

getPluginForName

public final Plugin getPluginForName(java.lang.String name)

Return the Plugin, given its associated name.

Specified by:

getPluginForName in interface MDIApplication

Parameters:

name - the Plugin name

Returns:

the Plugin

getPlugin

public final Plugin getPlugin(java.lang.String clazz)

Return the Plugin, given its associated class path.

Specified by:

getPlugin in interface MDIApplication

Parameters:

clazz - the plugin class path

Returns:

the Plugin

addCustomAction

public void addCustomAction(java.lang.String actionName,
                            short customActionType)

Add a custom action.

Parameters:

actionName - the custom action name

customActionType - the custom action type

executeCustomAction

public boolean executeCustomAction(java.lang.String actionName,
                                   java.lang.Object... arguments)

Execute a blocking custom action.

Parameters:

actionName - the custom action name

arguments - the arguments

Returns:

true if a plugin executed the custom action

executeCustomAction

public boolean executeCustomAction(java.lang.String actionName,
                                   short blockingType,
                                   java.lang.Object... arguments)

Execute a custom action.

Parameters:

actionName - the custom action name

blockingType - the blocking type

arguments - the arguments

Returns:

true if a plugin executed the custom action

loadResources

protected void loadResources()

Load resources (as Icons) used in the Application. Do nothing by default.

endAction

public void endAction(MDIAction action)

Ends a generic action.

Specified by:

endAction in interface MDIApplication

Parameters:

action - the action

disposeApplication

public void disposeApplication()

Dispose of the Application, and serialize its resources if a Configuration manager has been set.

Specified by:

disposeApplication in interface MDIApplication

serializeConfiguration

protected void serializeConfiguration()

Serialize the configuration.

noWriteMessages

public void noWriteMessages()

Do nothing by default.

Specified by:

noWriteMessages in interface MDIApplication

noTimeMessages

public void noTimeMessages()

Do nothing by default.

Specified by:

noTimeMessages in interface MDIApplication