fr.paris.lutece.portal.service.plugin

Class PluginService

java.lang.Object

fr.paris.lutece.portal.service.plugin.PluginService

public final class PluginService
extends Object

This class provides services and utilities for plugins management

Method Summary

Modifier and Type	Method and Description
static Plugin	getCore() Gets the core.
static Plugin	getPlugin(String strPluginName) Returns a Plugin object from its name
static Collection<Plugin>	getPluginList() Returns the plugins file list
static void	init() Initialize the service
static boolean	isPluginEnable(String strPluginName) Gets the plugin status enable / disable
static void	notifyListeners(PluginEvent event) Notify an event to all Plugin Event Listeners
static void	registerPluginEventListener(PluginEventListener listener) Register a Plugin Event Listener
static void	updatePluginData(Plugin plugin) Update plugins data.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()
                 throws LuteceInitException

Initialize the service

Throws:

LuteceInitException - If an error occured

getPluginList

public static Collection<Plugin> getPluginList()

Returns the plugins file list

Returns:

the plugins file list as a File[]

getPlugin

public static Plugin getPlugin(String strPluginName)

Returns a Plugin object from its name

Parameters:

strPluginName - The name of the plugin

Returns:

The Plugin object corresponding to the name

getCore

public static Plugin getCore()

Gets the core.

Returns:

the core

updatePluginData

public static void updatePluginData(Plugin plugin)

Update plugins data.

Parameters:

plugin - The plugin object

isPluginEnable

public static boolean isPluginEnable(String strPluginName)

Gets the plugin status enable / disable

Parameters:

strPluginName - The plugin name

Returns:

True if the plugin is enable, otherwise false

registerPluginEventListener

public static void registerPluginEventListener(PluginEventListener listener)

Register a Plugin Event Listener

Parameters:

listener - The listener

notifyListeners

public static void notifyListeners(PluginEvent event)

Notify an event to all Plugin Event Listeners

Parameters:

event - The event