org.gvsig.andami

Interface PluginsManager

All Known Implementing Classes:

DefaultPluginsManager

public interface PluginsManager

Method Summary

Modifier and Type	Method and Description
void	addShutdownTask(String name, Runnable task, boolean in_event_thread, int priority) This method allows plugins register task to do after close the application.
void	addStartupTask(String name, Runnable task, boolean in_event_thread, int priority) This method allows plugins register task to do before initializacion of all gvSIG plugins.
boolean	desktopBrowse(URI uri) Browses to a given URI
boolean	desktopOpen(File file) Open a given file
void	executeShutdownTasks() This method executes registered task to run after the close of the application.
void	executeStartupTasks() This method executes registered task to run before the initialization of all plugins.
File	getApplicationFolder() Returns the main application folder, where the application is installed.
File	getApplicationHomeFolder() Returns the application folder in the home of user.
File	getApplicationI18nFolder() Returns the default folder where the internationalization files are installed.
String	getApplicationName()
Version	getApplicationVersion()
Arguments	getArguments()
ExclusiveUIExtension	getExclusiveUIExtension() Return the ExclusiveUIExtension installed in the application or null.
IExtension	getExtension(Class<? extends IExtension> extension) Gets the instance of the extension whose class is provided.
IExtension	getExtension(String extension) Gets the instance of the extension whose class name is provided.
Iterator<IExtension>	getExtensions() Return an iterator over al extensions loaded in the application.
FirewallConfiguration	getFirewallConfiguration()
File	getInstallFolder() Returns the default folder with the installable package bundles.
PackageInfo	getPackageInfo() Get the package info associated to the application.
PackageInfo	getPackageInfo(Class<? extends IExtension> extension) Get the package info associated to the plugin of the extension.
PackageInfo	getPackageInfo(String pluginName) Get the package info associated to the plugin with the specified name.
PluginServices	getPlugin(Class<? extends IExtension> extension) Return the associated pluginServices to the extension class passed as parameter.
PluginServices	getPlugin(Object obj) Return the associated pluginServices to the object passed as parameter.
PluginServices	getPlugin(String pluginName) Return the associated pluginServices to the extension plugin.
List<PluginServices>	getPlugins() Return the list of plugins loaded in the application
File	getPluginsDirectory() Deprecated. @see getPluginsFolders()
File	getPluginsFolder() Deprecated. use getPluginsFolders()
List<File>	getPluginsFolders() Returns a list of folder on the plugins are instaleds.
File	getTempFile(String name) Get the file name in the temporary folder of the plugins framework.
File	getTempFile(String name, String sufix) Create a unique file name in the temporary folder of the plugins framework.
File	getTempFolder() Gets the temporary folder of the plugins framework.
String	getText(Object obj, String msg) Deprecated. use translate(String)
List<IUnsavedData>	getUnsavedData() Return a list of unsaved data
void	saveUnsavedData(List<IUnsavedData> unsavedData) Save the provided unsaved data as parameter
void	setExclusiveUIExtension(ExclusiveUIExtension extension) Set an extension to control the visivility of all the extensions of the application.
String	translate(String msg) Translate the message key to the current language used in the application.

Method Detail

getApplicationName

String getApplicationName()

getPlugin

PluginServices getPlugin(Class<? extends IExtension> extension)

Return the associated pluginServices to the extension class passed as parameter.

Parameters:

extension -

Returns:

plugin services

getPlugin

PluginServices getPlugin(Object obj)

Return the associated pluginServices to the object passed as parameter.

Parameters:

object -

Returns:

plugin services

getPlugin

PluginServices getPlugin(String pluginName)

Return the associated pluginServices to the extension plugin.

Parameters:

pluginName, - name of the plugin

Returns:

plugin services

getPackageInfo

PackageInfo getPackageInfo(Class<? extends IExtension> extension)

Get the package info associated to the plugin of the extension.

Parameters:

extension - extension of the plugin

Returns:

plugin package info

getPackageInfo

PackageInfo getPackageInfo(String pluginName)

Get the package info associated to the plugin with the specified name.

Parameters:

pluginName, - name of the plugin

Returns:

plugin package info

getPackageInfo

PackageInfo getPackageInfo()

Get the package info associated to the application.

Returns:

application package info

getPlugins

List<PluginServices> getPlugins()

Return the list of plugins loaded in the application

Returns:

list of plugins

getExtension

IExtension getExtension(Class<? extends IExtension> extension)

Gets the instance of the extension whose class is provided.

Parameters:

extension, - class of the extension to retrieve

Returns:

The instance of the extension, or null if the instance does not exist.

getExtension

IExtension getExtension(String extension)

Gets the instance of the extension whose class name is provided.

Parameters:

extension, - class name of the extension to retrieve

Returns:

The instance of the extension, or null if the instance does not exist.

getExtensions

Iterator<IExtension> getExtensions()

Return an iterator over al extensions loaded in the application.

Returns:

iterator over extensions

setExclusiveUIExtension

void setExclusiveUIExtension(ExclusiveUIExtension extension)

Set an extension to control the visivility of all the extensions of the application.

Parameters:

extension -

getExclusiveUIExtension

ExclusiveUIExtension getExclusiveUIExtension()

Return the ExclusiveUIExtension installed in the application or null.

Returns:

getText

String getText(Object obj,
               String msg)

Deprecated. use translate(String)

See Also:

#translate(String)}

translate

String translate(String msg)

Translate the message key to the current language used in the application.

Parameters:

msg - key to translate

Returns:

message traslated or the key

getApplicationFolder

File getApplicationFolder()

Returns the main application folder, where the application is installed.

Returns:

the main application folder

getInstallFolder

File getInstallFolder()

Returns the default folder with the installable package bundles.

Returns:

the default folder with the installable package bundles

getApplicationHomeFolder

File getApplicationHomeFolder()

Returns the application folder in the home of user.

Returns:

the main application folder

getApplicationI18nFolder

File getApplicationI18nFolder()

Returns the default folder where the internationalization files are installed.

Returns:

the default folder where the internationalization files are installed.

getPluginsFolder

File getPluginsFolder()

Deprecated. use getPluginsFolders()

Returns the plugins folder.

Returns:

the plugins folder

getPluginsFolders

List<File> getPluginsFolders()

Returns a list of folder on the plugins are instaleds.

Returns:

list of folders File of the plugins.

getPluginsDirectory

File getPluginsDirectory()

Deprecated. @see getPluginsFolders()

addStartupTask

void addStartupTask(String name,
                    Runnable task,
                    boolean in_event_thread,
                    int priority)

This method allows plugins register task to do before initializacion of all gvSIG plugins. Task with higher priority value are executed after.

Parameters:

name - of the task

task - runnable with the code of the task

in_event_thread, - true if the task shoul run in the AWT event thread.

priority - of the task.

addShutdownTask

void addShutdownTask(String name,
                     Runnable task,
                     boolean in_event_thread,
                     int priority)

This method allows plugins register task to do after close the application. Task with higher priority value are executed after.

Parameters:

name - of the task

task - runnable with the code of the task

in_event_thread, - true if the task shoul run in the AWT event thread.

priority - of the task.

executeStartupTasks

void executeStartupTasks()

This method executes registered task to run before the initialization of all plugins. The tasks are sorted according to the priority and executed in a separated thread.

executeShutdownTasks

void executeShutdownTasks()

This method executes registered task to run after the close of the application. The tasks are sorted according to the priority and executed in a separated thread.

getFirewallConfiguration

FirewallConfiguration getFirewallConfiguration()

getApplicationVersion

Version getApplicationVersion()

getUnsavedData

List<IUnsavedData> getUnsavedData()

Return a list of unsaved data

Returns:

saveUnsavedData

void saveUnsavedData(List<IUnsavedData> unsavedData)
              throws UnsavedDataException

Save the provided unsaved data as parameter

Parameters:

unsavedData -

Throws:

UnsavedDataException

getTempFolder

File getTempFolder()

Gets the temporary folder of the plugins framework.

Returns:

the temp folder

getTempFile

File getTempFile(String name)

Get the file name in the temporary folder of the plugins framework.

Parameters:

name -

Returns:

getTempFile

File getTempFile(String name,
                 String sufix)

Create a unique file name in the temporary folder of the plugins framework.

Parameters:

name - base name used for create the unique file name

sufix - to add the the unique file name

Returns:

desktopBrowse

boolean desktopBrowse(URI uri)

Browses to a given URI

Parameters:

uri -

Returns:

desktopOpen

boolean desktopOpen(File file)

Open a given file

Parameters:

file -

Returns:

getArguments

Arguments getArguments()