com.suncode.plugin.framework

Interface Plugin

All Superinterfaces:

org.springframework.core.io.ResourceLoader

public interface Plugin
extends org.springframework.core.io.ResourceLoader

Plugin to dynamiczny element systemu, który może być zainstalowany, zaktualizowany, odinstalowany w systemie bez konieczności ponownego uruchamiania. Pluginy mogą udostępniać serwisy innym komponentom.

Author:

Cezary Kozar 21-09-2012

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Plugin.PluginState Stan wtyczki.

Field Summary

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
PluginContext	getContext()
String	getKey() Zwraca identyfikator tekstowy wtyczki.
Date	getLastUpdateDate()
String	getMessage(String code)
String	getMessage(String code, Locale locale, Object... args)
String	getMessage(String code, Object... args)
Module<?>	getModule(String key) Zwraca deskryptor modułu o podanym kluczu
List<Module<?>>	getModules()
<T> List<Module<T>>	getModules(Class<T> clazz)
String	getName()
PluginDescriptor	getPluginDescriptor()
PluginFramework	getPluginFramework()
Plugin.PluginState	getState()
String	getVersion()
void	start() Uruchamia wtyczkę
void	stop() Zatrzymuje wtyczkę
void	uninstall() Usuwa wtyczkę z systemu
void	update(File file) Aktualizuje wtyczkę z podanego pliku

Methods inherited from interface org.springframework.core.io.ResourceLoader

getClassLoader, getResource

Method Detail

start

void start()

Uruchamia wtyczkę

stop

void stop()

Zatrzymuje wtyczkę

update

void update(File file)
            throws InvalidPluginException,
                   IOException

Aktualizuje wtyczkę z podanego pliku

Parameters:

file - plik zawierający nową wersję tej wtyczki

Throws:

IOException

InvalidPluginException

uninstall

void uninstall()

Usuwa wtyczkę z systemu

getState

Plugin.PluginState getState()

Returns:

Stan wtyczki Plugin.PluginState

getKey

String getKey()

Zwraca identyfikator tekstowy wtyczki. Na jego podstawie system kojarzy wtyczkę z odopowiednim bundlem OSGi.

Returns:

Pełny identyfikator tekstowy

getName

String getName()

Returns:

Pełna nazwa wtyczki

getLastUpdateDate

Date getLastUpdateDate()

Returns:

Data ostatniej aktualizacji

getVersion

String getVersion()

Returns:

Wersja wtyczki.

getPluginFramework

PluginFramework getPluginFramework()

Returns:

instancja mechanizmu wtyczek, która zainstalowała tą wtyczkę

getPluginDescriptor

PluginDescriptor getPluginDescriptor()

getContext

PluginContext getContext()

getMessage

String getMessage(String code)

getMessage

String getMessage(String code,
                Object... args)

getMessage

String getMessage(String code,
                Locale locale,
                Object... args)

getModule

Module<?> getModule(String key)

Zwraca deskryptor modułu o podanym kluczu

Parameters:

moduleKey - Identyfikator modułu

Returns:

Moduł o podanym kluczu lub null, jeżeli moduł nie istnieje

getModules

List<Module<?>> getModules()

Returns:

Lista wszystkich modułów tej wtyczki w oryginalnej kolejności.

getModules

<T> List<Module<T>> getModules(Class<T> clazz)

Parameters:

clazz - Klasa dla której moduły muszą spełniać warunek Class.isAssignableFrom(Class)

Returns:

Lista deskryptorów, produkująca moduły zgodne z podanym typem