Katalog plugins i automatyczna instalacja pakunków OSGi na Equinoksie

Już kiedyś wspominałem o tym dokumentcie - Equinox QuickStart Guide - ale nigdy jakoś nie usiadłem nad nim i dokładnie przeanalizowałem jego treści. Tym razem jednak, po kilku dniach zestawiania potrzebnych pakunków do uruchomienia Spring-DM 1.2.0-m2-SNAPSHOT na Eclipse Equinox i przekroczeniu 10 pakunków koniecznych do jego uruchomienia, stwierdziłem, że wystarczy tych ręcznych robótek i pora skrócić moje cierpienia - pójść po rozum do głowy i skorzystać z ułatwień, które są na wyciągnięcie ręki - automatyczne uruchamianie pakunków przy starcie Equinoksa. Przy okazji, poznając działanie Equinoksa poznajemy działanie całego Eclipse, który mechanizm wtyczek oparł całkowicie o OSGi z Equinox w roli środowiska uruchomieniowego.

Podczas uruchamiania Equinoksa poleceniem

 java -jar org.eclipse.osgi_3.5.0.v20080804-1730.jar -console

uruchomiony zostaje automatycznie pakunek systemowy - org.eclipse.osgi. Ma on identyfikator 0 i będzie tak na każdej platformie OSGi (oczywiście nazwa pakunku systemowego będzie inna, specyficzna dla danej platformy).

 jlaskowski@work /cygdrive/c/apps/equinox
 $ java -jar org.eclipse.osgi_3.5.0.v20080804-1730.jar -console

 osgi> ss

 Framework is launched.

 id      State       Bundle
 0       ACTIVE      org.eclipse.osgi_3.5.0.v20080804-1730

Przy pierwszym uruchomieniu tworzony jest katalog configuration w katalogu bieżącym (z możliwością wskazania innego parametrem -configuration).

 jlaskowski@work /cygdrive/c/apps/equinox
 $ ls -lt
 total 988
 drwxr-xr-x+ 3 jlaskowski None       0 Sep 28 21:27 configuration
 -rwx------+ 1 jlaskowski None 1009283 Sep 22 16:07 org.eclipse.osgi_3.5.0.v20080804-1730.jar

Instalacja pakunków odbywa się poleceniem install <plik_pakunku>. Jeśli założę katalog plugins (na razie przyjmijmy, że jest to nazwa całkowicie przypadkowa), a w nim umieszczę pakunek spring-osgi-core-1.2.0-m2-SNAPSHOT.jar, jego instalacja będzie wyglądała następująco:

 jlaskowski@work /cygdrive/c/apps/equinox
 $ java -jar org.eclipse.osgi_3.5.0.v20080804-1730.jar -console

 osgi> ss

 Framework is launched.

 id      State       Bundle
 0       ACTIVE      org.eclipse.osgi_3.5.0.v20080804-1730

 osgi> install file:plugins/spring-osgi-core-1.2.0-m2-SNAPSHOT.jar
 Bundle id is 1

 osgi> ss

 Framework is launched.

 id      State       Bundle
 0       ACTIVE      org.eclipse.osgi_3.5.0.v20080804-1730
 1       INSTALLED   org.springframework.bundle.osgi.core_1.2.0.m2-SNAPSHOT

Kolejne uruchomienie platformy OSGi gwarantuje uruchomienie pakunków do stanu, który był bieżącym przed zatrzymaniem całej Platformy, np. poleceniem close dla Equinoksa. Właśnie katalog configuration jest katalogiem, gdzie utrwalone zostają informacje o stanie pakunku (i skasowanie go powoduje skasowanie danych pakunków, co równoważne jest z uruchomieniem początkowym Equinoksa).

 jlaskowski@work /cygdrive/c/apps/equinox
 $ java -jar org.eclipse.osgi_3.5.0.v20080804-1730.jar -console

 osgi> ss

 Framework is launched.

 id      State       Bundle
 0       ACTIVE      org.eclipse.osgi_3.5.0.v20080804-1730
 1       INSTALLED   org.springframework.bundle.osgi.core_1.2.0.m2-SNAPSHOT

Przy pojedyńczym pakunku sprawa jego instalacji i uruchomienia nie jest poważnym zadaniem. Sprawa zaczyna się komplikować, kiedy przychodzi nam uruchomić, powiedzmy, 20 pakunków. Wtedy pozostaje nam liczyć na poprawny katalog configuration, albo...config.ini.

Plik config.ini w katalogu configuration jest plikiem konfiguracyjnym Equinoksa, w którym definiuje się, jakie pakunki mają zostać uruchomione i gdzie one w ogóle się znajdują. Dodając do tego wsparcie pakunku org.eclipse.update.configurator nie musimy umieszczać nazw wszystkich pakunków do instalacji w pliku config.ini, a wystarczy umieścić je w katalogu plugins.

Zatem plik config.ini prezentuje się następująco:

 eclipse.ignoreApp=true
 osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start

a sama struktura katalogowa tak:

 |____configuration
 | |____config.ini
 |____org.eclipse.equinox.common_3.4.0.v20080421-2006.jar
 |____org.eclipse.osgi_3.5.0.v20080804-1730.jar
 |____org.eclipse.update.configurator_3.2.200.v20080417.jar
 |____plugins
 | |____spring-osgi-core-1.2.0-m2-SNAPSHOT.jar

Pakunek org.eclipse.equinox.common pobrałem ze strony Equinox Stable Build: 3.5M1, natomiast org.eclipse.update.configurator znalazłem w katalogu Eclipse Ganymede w plugins (nigdzie indziej nie mogłem go namierzyć).

Przy powyższej konfiguracji każdy z pakunków umieszczonych w katalogu plugins będzie zainstalowany automatycznie podczas uruchomienia Equinoksa.

 jlaskowski@work /cygdrive/c/apps/equinox
 $ java -jar org.eclipse.osgi_3.5.0.v20080804-1730.jar -console

 osgi> ss

 Framework is launched.

 id      State       Bundle
 0       ACTIVE      org.eclipse.osgi_3.5.0.v20080804-1730
 1       ACTIVE      org.eclipse.equinox.common_3.4.0.v20080421-2006
 2       ACTIVE      org.eclipse.update.configurator_3.2.200.v20080417
 3       INSTALLED   org.springframework.bundle.osgi.core_1.2.0.m2-SNAPSHOT

Z pewnością znacząco uprości zabawę z uruchomieniem wszystkich pakunków Spring-DM niezbędnych do uruchomienia aplikacji webowych na Apache Tomcat 6.0.18 w ramach Equinoksa. Do tej pory wymagało to ręcznego uruchamiania około 20 pakunków przy każdorazowym usunięciu katalogu configuration (!)