com.suncode.plugin.framework

Interface Plugin

public interface Plugin

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.

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Zwraca obiekt ClassLoader tej wtyczki, który może być używany do ładowania klas lub zasobów wtyczki.
PluginContext	getContext()
String	getKey() Zwraca identyfikator tekstowy wtyczki.
Date	getLastUpdateDate()
String	getMessage(String code) Pobiera tłumaczenie wiadomości dla podanego klucza i aktualnego języka przechowywanego w LocaleContextHolder.
String	getMessage(String code, Locale locale, Object... args) Pobiera tłumaczenie wiadomości dla podanego klucza i języka.
String	getMessage(String code, Object... args) Pobiera tłumaczenie wiadomości dla podanego klucza i aktualnego języka przechowywanego w LocaleContextHolder.
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()
PluginStore	getPluginStore() Zwraca PluginStore tej wtyczki.
Reference	getReference()
PluginRequirements	getRequirements()
org.springframework.core.io.Resource	getResource(String location) Zwraca zasób wtyczki określony podaną ścieżką.
<T> ServiceReference<T>	getServiceReference(ServiceDescriptor serviceDescriptor) Pobiera dynamiczną referencję serwisu, opisanego podanym deskryptorem ServiceDescriptor.
Plugin.PluginState	getState()
String	getSystemStartupErrorMessage() Zwraca wiadomość błędu, jeżeli wtyczka nie uruchomiła się przy starcie systemu.
String	getVersion()
boolean	hasValidLicense()
boolean	isActive()
void	start() Uruchamia wtyczkę
void	stop() Zatrzymuje wtyczkę
void	stopTransient() Zatrzymuje wtyczkę.
void	uninstall() Usuwa wtyczkę z systemu
void	update(File file) Aktualizuje wtyczkę z podanego pliku

Method Detail

start

void start()

Uruchamia wtyczkę

stop

void stop()

Zatrzymuje wtyczkę

stopTransient

void stopTransient()

Zatrzymuje wtyczkę. Zapisany stan wtyczki pozostanie bez zmian tzn. wtyczka zostanie uruchomiona przy ponownym uruchomieniu systemu.

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

isActive

boolean isActive()

Returns:

true jeżeli wtyczka jest aktywna Plugin.PluginState.ACTIVE

getKey

String getKey()

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

Returns:

Pełny identyfikator tekstowy

getReference

Reference getReference()

Returns:

klucz i wersja wtyczki

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()

Returns:

obiekt deskryptora wtyczki

getRequirements

PluginRequirements getRequirements()

Returns:

wymagania wtyczki

hasValidLicense

boolean hasValidLicense()

getContext

PluginContext getContext()

Returns:

kontekst wtyczki lub null jeżeli wtyczka nie posiada jeszcze kontekstu - nie jest uruchomiona

getResource

org.springframework.core.io.Resource getResource(String location)

Zwraca zasób wtyczki określony podaną ścieżką. Aby sprawdzić, czy zasób faktycznie istnieje należy wywołać metodę Resource.exists() na zwróconym zasobie.

Parameters:

location - położenie określające ten zasób

Returns:

zasób (nigdy null)

getPluginStore

PluginStore getPluginStore()

Zwraca PluginStore tej wtyczki. Jeżeli PluginStore jeszcze nie istnieje, zostanie utworzony.

PluginStore może być wykorzystywany jako alternatywa dla bazy danych, do przechowywania danych i zapamiętywania ich pomiędzy uruchomieniami wtyczki.

Returns:

PluginStore tej wtyczki

getClassLoader

ClassLoader getClassLoader()

Zwraca obiekt ClassLoader tej wtyczki, który może być używany do ładowania klas lub zasobów wtyczki. ClassLoader może być odczytany tylko i wyłącznie

Returns:

ClassLoader

getMessage

String getMessage(String code)
           throws org.springframework.context.NoSuchMessageException,
                  IllegalStateException

Pobiera tłumaczenie wiadomości dla podanego klucza i aktualnego języka przechowywanego w LocaleContextHolder.

Throws:

org.springframework.context.NoSuchMessageException

IllegalStateException

See Also:

getMessage(String, Locale, Object...);

getMessage

String getMessage(String code,
                  Object... args)
           throws org.springframework.context.NoSuchMessageException,
                  IllegalStateException

Pobiera tłumaczenie wiadomości dla podanego klucza i aktualnego języka przechowywanego w LocaleContextHolder. Dodatkowo możliwe jest zdefiniowanie opcjonalnych argumentów wiadomości.

Throws:

org.springframework.context.NoSuchMessageException

IllegalStateException

See Also:

getMessage(String, Locale, Object...);

getMessage

String getMessage(String code,
                  Locale locale,
                  Object... args)
           throws org.springframework.context.NoSuchMessageException,
                  IllegalStateException

Pobiera tłumaczenie wiadomości dla podanego klucza i języka. Dodatkowo możliwe jest zdefiniowanie opcjonalnych argumentów wiadomości.

Parameters:

code - klucz wiadomości

locale - locale, dla których pobieramy wiadomość

args - dodatkowe argumenty wiadomości

Returns:

przetłumaczona zgodnie z lokalami wiadomość o podanym kluczu

Throws:

org.springframework.context.NoSuchMessageException - wiadomość o takim kodzie nie istnieje

IllegalStateException - wtyczka nie jest uruchomiona

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

getServiceReference

<T> ServiceReference<T> getServiceReference(ServiceDescriptor serviceDescriptor)

Pobiera dynamiczną referencję serwisu, opisanego podanym deskryptorem ServiceDescriptor. Ze względu na dynamiczną naturę serwisów, możemy sprawdzić, czy jest on aktualnie dostępny poprzez wywołanie metody ServiceReference.isAvailable().
Każdą pobraną referencję serwisu należy manualnie zwolnić ServiceReference.release() gdy nie będzie już używana (podczas wyłączenia wtyczki wszystkie referencje są zwalniane automatycznie).

Parameters:

serviceDescriptor - deskryptor opisujący serwis

Returns:

referencja serwisu (nigdy null - ServiceReference.isAvailable())

getSystemStartupErrorMessage

String getSystemStartupErrorMessage()

Zwraca wiadomość błędu, jeżeli wtyczka nie uruchomiła się przy starcie systemu.

Returns: