Wstęp

Wtyczka umożliwia zarządzanie konfiguracjami (plikami konfiguracyjnymi) wtyczek zainstalowanych w systemie. Zamiast tworzenia dedykowanej zakładki do wgrywania/zmiany plików konfiguracyjnych dla każdej wtyczki z osobna, można zintegrować ją z PCM, która umożliwi użytkownikowi zmianę plików konfiguracyjnych dla wszystkich wtyczek w jednym miejscu.

Integracja z wtyczką

Aby zintegrować dowolną wtyczkę z PCM, należy dodać odpowiednie znaczniki deskryptorze wtyczki - plik suncode-plugin.xml. Dostępne są 2 znaczniki:

• manual-plugin-configuration - umożliwia ręczne zarządzanie konfiguracjami wtyczek przez użytkownika. Przydatne dla wtyczek, które mogą mieć wiele plików konfiguracyjnych (np. przy uruchomieniu pewnej funkcjonalności wtyczki należy podać plik konfiguracyjny, który ma być brany pod uwagę)
• predefined-plugin-configuration - umożliwia zmienianie jedynie pojedynczego pliku konfiguracyjnego wtyczki. Przydatne dla wtyczek, które opierają swoje działanie na podstawie jednego globalnego pliku konfiguracyjnego.

Manual

Przykładowy wpis w deskryptorze wtyczki:

<manual-plugin-configuration key="manual-plugin-configuration"/>
<!-- key jest wymagany przez mechanizm modułów wtyczek. Nie ma związku z działaniem tej funkcjonalności -->

Predefined

Przykładowy wpis w deskryptorze wtyczki:

<predefined-plugin-configuration key="predefined-plugin-configuration"
                                 path-provider="com.suncode.plugin.somepluginid.ConfigurationFilePathProvider"/>
<!-- key jest wymagany przez mechanizm modułów wtyczek. Nie ma związku z działaniem tej funkcjonalności -->

Atrybuty:

• path-provider (wymagany) - nazwa klasy implementująca interfejscom.suncode.plugin.pluginconfigurationmanager.configuration.predefined.provider.PluginConfigurationFilePathProvider. Należy zaimplementować metodę zwracającą ścieżkę do pliku konfiguracyjnego. Implementacja interfejsu musi byc beanem Springa.

Widok konfiguracji wtyczek

Po uruchomieniu wtyczki w zakładce Administracja -> Konfiguracja systemu pojawi się nowa zakładka Konfiguracja wtyczek.

Po lewej stronie wyświetlana jest lista obsługiwanych wtyczek. Po zaznaczeniu wtyczki pojawia się widok konfiguracji zależny od tego, czy jest typu manual czy predefined.

Manual

W typie manual możliwe jest ręczne dodawanie konfiguracji, na które składa się:

• identyfikator pliku - identyfikator, po którym wtyczka może pobrać zawartość pliku konfiguracyjnego przez API
• typ pliku - typ/rozszerzenie pliku. Dostępne JSON, XML i pozostałe. Wszystkie typy oprócz "pozostałych" są walidowane przy zapisie
• zawartość pliku - tekstowa zawartość pliku

We wtyczce aby odczytać plik, należy użyć interfejsu com.suncode.plugin.pluginconfigurationmanager.configuration.manual.service.PublicFileConfigurationService

Predefined

W typie predefined można edytować tylko jeden plik. Nie można dodawać nowych konfiguracji, usuwać ich itd. Nie można również zmienić typu pliku.