Wracając wczoraj z Krakowa ze Studenckiego Festiwalu Informatycznego zastanawiałem się jak zrelacjonuję to, czego doświadczyłem. Uczestniczyłem w kilku konferencjach w Europie (jako uczestnik i jako prelegent) i muszę przyznać, że z wielką przyjemnością stwierdzam, że organizację konferencji SFI oceniam na mocną 5-tkę.
Wszystko zaczęło się od zaproszenia, które otrzymałem już na początku roku od Radka Holewy (jednego z organizatorów festiwalu). Seria uzupełniających korespondencji w międzyczasie pozwoliła mi na bardzo efektywne przygotowanie się do konferencji. Było jedno (szczęśliwie przyjemne) ale - ilość uczestników. Po kilku spotkaniach Warszawa JUG w sali MIMUW powoli przyzwyczaiłem się do możliwości spotkania 50 osób zainteresowanych tematyką Javy. Tutaj było inaczej - ogromna sala (część hali sportowej) z dobrze umiejscowionymi gadżetami prezentacyjnymi - wystarczająco obszerny ekran, nagłośnienie, oświetlenie, miejsca siedzące, "ambona", itp. Do tej pory spotkania konferencyjne zazwyczaj przychodziło mi prowadzić w zamkniętych salach (poza panelem Enterprise Java podczas The ServerSide Symposium w Barcelonie bodajże w 2005). Teraz była część hali sportowej przygotowana do celów Festiwalu i liczba osób wahająca się wokół 100-150 osób (a może tylu wydawało mi się, że jest). Tematem prezentacji był Apache Geronimo - Apache Geronimo v2 - serwer aplikacyjny Java EE 5. Czułem tremę, która początkowo ściskała mnie za gardło. Jak niektórzy mogą mniemać nie trwało to długo i kiedy się zebrałem w sobie, dalej poszło gładko tak, że pod koniec udało mi się wycisnąć kilka ciekawych pytań od publiczności. Były pytania o licencję Geronimo vs GlassFish, OSGi (w kontekście prezentacji moich planów, co do jądra Geronimo) i jeszcze jedno, którego niestety nie pamiętam. Jak to zwykle bywa na moich prelekcjach czas został nieznacznie wydłużony, ale mimo, że rozpoczynała się przerwa obiadowa nikt nie czmychnął z sali (Ci, którzy mieli dosyć mojego dywagowania nie na temat, wyszli znacznie wczesniej).
Na uwagę zasługuje fakt, że prezentacje były nagrywane, zrobiono mnóstwo zdjęć (tak, że przez moment nie byłem pewien, czy nadal byłem na tym Festiwalu, na który mnie zaproszono - przekonałem się co może oznaczać życie wśród fleszy ;-)). Wszystko będzie dostępne po zakończeniu Festiwalu - czego nie mogę się już doczekać. Cała godzinna prelekcja nt. Apache Geronimo w moim wydaniu ma być dostępna w Sieci. Na razie nie wiem gdzie. Cierpliwie czekam...
Obiad zjedliśmy w bardzo miłej restauracji na krakowskim rynku w gronie organizatorów i prelegentów, i przy ciepłej pogodzie miło wracało się na pociąg powrotny do Warszawy.
Inną ciekawostką, której doświadczyłem podczas konferencji była rozmowa z Marcinem Smolińskim z Google, który wspomniał o planach pomocy Google przy kolejnym, 7. spotkaniu Warszawa JUG nt GWT prowadzonym przez Michała Margiela. Podobnież Google namierzył temat i postanowił pomóc. Miło! Nie ma to jak uczyć się technologii wprost ze źródła.
Udało mi się również porozmawiać z kilkoma osobami zainteresowanymi prowadzeniem podobnej "działalności" jak mój Notatnik. Wiele osób zainspirowanych moim sposobem angażowania społeczności Javy do zwiekszonej aktywności, tworzenia konferencji, spotkań, etc. deklarowało podobne inicjatywy. Bardzo się cieszę, że idea jaka przyświecała utworzeniu Notatnika spodobała się i plan organizowania się i współdzielenia doświadczeniami zaczyna przynosić efekty. Wierzę, że w ten sposób poziom zaangażowania rodzimych informatyków w projektach otwartych i grupach standaryzujących znacznie się podniesie.
Podsumowując: z wielką niecierpliwością będę oczekiwał kolejnych konferencji organizowanych przez organizatorów SFI. Było miło i sporo nauczyłem się w temacie prowadzenia prezentacji. Niezwykłe doświadczenie, które każdemu polecam! Jeśli ktokolwiek miał wątpliwości, czy warto uczestniczyć w tego rodzaju przedsięwzięciach, wierzę, że ma to już za sobą i podejmie się wyzwania - nie musi to być rola prelegenta, wystarczy aktywnie spędzić czas na prezentacji - nie ma co mieć skrupuły przed zadawaniem pytań. W jaki inny sposób można się czegoś nauczyć przy tak galopującym rozwoju technologicznym, jeśli jednym ze sposobów nie jest zadawanie pytań?! Jeśli publika onieśmiela, zawsze można zadać pytanie po spotkaniu. Ważne, aby to robić!
09 marca 2007
07 marca 2007
Java Persistence - Rozdział 7: Umowy kontenera i dostawcy JPA o instalacji i uruchomieniu
Ale mi się dzisiaj udało z tlumaczeniem! 10-cio stronicowy rozdział 7. zatytułowany w oryginale Container and Provider Contracts for Deployment and Bootstrapping to w moim wolnym tłumaczeniu odpowiada treści umów (kontraktów) kontenera i dostawcy JPA o sposobie instalacji i uruchomieniu aplikacji korzystających z JPA. Wczorajsza lektura o dystrybucji encji to preludium do kontraktów kontenera Java EE i dostawcy JPA dotyczącego instalacji i samego uruchomienia aplikacji JPA. Bardzo techniczny rozdział i szczęśliwie krótki. Przeznaczony wyłącznie dla samych dostawców JPA. Programiści tworzący aplikacje JPA mogą spokojnie ominąć ten rozdział bez żadnej straty (mnie się niestety nie udało ominąć, bo skąd miałem wiedzieć, co w nim będzie bez lektury, nieprawdaż?!)
Rozróżniamy dwa środowiska działania, w których instaluje się i uruchamia aplikację JPA - środowisko Java EE i Java SE. Mimo, że oba muszą dostarczyć środowisko uruchomieniowe dla funkcjonowania JPA to ich sposób działania jest odmienny (ze względu na dostęp do usług pomocniczych, które są opcjonalne w Java SE podczas, gdy są obowiązkowe w Java EE, np. usługa monitora transakcyjnego).
Jak już pisano wcześniej (i wspomina się na każdym kroku w specyfikacji) każdy PU (jednostka utrwalania, ang. persistence unit) zawiera pojedyńczy plik persistence.xml - teraz dopiero zdałem sobie sprawę (a może jest późno i tak mi się tylko zdaje), że istnienie persistence.xml wyznacznikiem potencjalnych encji (dla sprawdzenia dotychczasowych umiejętności JPA proponuję mały test z pytaniem, czy możliwe jest dystrybuowanie archiwum z plikiem persistence.xml bez żadnych klas trwałych - odpowiedź na samym końcu wpisu). Brak persistence.xml to brak PU mimo, że mogłoby się zdarzyć, że istnieją w archiwum klasy udekorowane adnotacją @Entity. Poza persistence.xml PU zawiera pliki mapowania oraz klasy trwałe.
Podczas instalacji aplikacji kontener Java EE zobowiązany jest do przeszukania potencjalnych miejsc istnienia persistence.xml (było o tym w poprzedniej relacji). Każdy odszukany persistence.xml jest analizowany i wszelkie niezgodności formatu pliku ze schematem persistence_1_0.xsd muszą być natychmiast raportowane. Jeśli nie zdefiniowano dostawcy JPA i/lub źródła danych, informacja o nich musi być dostarczona podczas instalacji bądź ich wartości będą odpowiadały wartościom domyślnym kontenera. Kontener może dostarczyć dowolne właściwości specyficzne dla niego do dostawcy JPA podczas tworzenia fabryki zarządców trwałości dla danego PU.
Dla każdego PU odszukiwana jest implementacja javax.persistence.spi.PersistenceProvider. Implementacja PersistenceProvider będzie wołana do stworzenia fabryki zarządcy trwałości dla danego PU poprzez metodę createContainerEntityManagerFactory. Dane konfiguracyjne przekazywane są do metody poprzez egzemplarz klasy javax.persistence.spi.PersistenceUnitInfo. Wyłącznie pojedyńcza fabryka zarządcy trwałości będzie stworzona dla danego PU. Dowolna liczba zarządców trwałości może być utworzona przez pojedyńczą fabrykę.
Reinstalacja PU wymaga wywołania metody close na fabryce zarządców i wykonać createContainerEntityManagerFactory ponownie.
Dostawca JPA zobowiązany jest do przetworzenia informacji o trwałości z adnotacji klas trwałych.
Napotkanie pliku mapowania wymaga zweryfikowania jego poprawności względem orm_1_0.xsd.
Nie przewiduje się wywoływania implementacji javax.persistence.spi.PersistenceProvider z poziomu aplikacji.
W środowisku Java SE utworzenie fabryki zarządcy trwałości odbywa się poprzez metodę javax.persistence.Persistence#createEntityManagerFactory.
Dostawca JPA w środowisku Java SE powinien być dostawcą usługi w sensie Java, tj. w archiwum jar dostawcy w katalogu META-INF/services powinien znajdować się plik javax.persistence.spi.PersistenceProvider, który zawiera nazwę klasy implementującej interfejs javax.persistence.spi.PersistenceProvider. W ten sposób nastąpi automatyczna instalacja dostawcy w środowisku. Tak zainstalowany dostawca JPA będzie dostawcą domyślnym.
Następnie zaprezentowano przykład takiego rozwiązania, gdzie archiwum acme.jar będące archiwum JPA w katalogu META-INF/services zawiera plik javax.persistence.spi.PersistenceProvider, który z kolei zawiera nazwę klasy implementującej PersistenceProvider - com.acme.PersistenceProvider.
Na tym zakończył się rozdział 7.
Dla dociekliwych podaję odpowiedź na wyżej postawione pytanie, czy możliwe jest dystrybuowanie archiwum z plikiem persistence.xml bez żadnych klas trwałych. Odpowiedź jest TAK. W takiej sytuacji definiujemy PU dla aplikacji (modułu) na bazie klas trwałych, które dostępne są na...ścieżce klas (ang. classpath).
Rozróżniamy dwa środowiska działania, w których instaluje się i uruchamia aplikację JPA - środowisko Java EE i Java SE. Mimo, że oba muszą dostarczyć środowisko uruchomieniowe dla funkcjonowania JPA to ich sposób działania jest odmienny (ze względu na dostęp do usług pomocniczych, które są opcjonalne w Java SE podczas, gdy są obowiązkowe w Java EE, np. usługa monitora transakcyjnego).
Jak już pisano wcześniej (i wspomina się na każdym kroku w specyfikacji) każdy PU (jednostka utrwalania, ang. persistence unit) zawiera pojedyńczy plik persistence.xml - teraz dopiero zdałem sobie sprawę (a może jest późno i tak mi się tylko zdaje), że istnienie persistence.xml wyznacznikiem potencjalnych encji (dla sprawdzenia dotychczasowych umiejętności JPA proponuję mały test z pytaniem, czy możliwe jest dystrybuowanie archiwum z plikiem persistence.xml bez żadnych klas trwałych - odpowiedź na samym końcu wpisu). Brak persistence.xml to brak PU mimo, że mogłoby się zdarzyć, że istnieją w archiwum klasy udekorowane adnotacją @Entity. Poza persistence.xml PU zawiera pliki mapowania oraz klasy trwałe.
Podczas instalacji aplikacji kontener Java EE zobowiązany jest do przeszukania potencjalnych miejsc istnienia persistence.xml (było o tym w poprzedniej relacji). Każdy odszukany persistence.xml jest analizowany i wszelkie niezgodności formatu pliku ze schematem persistence_1_0.xsd muszą być natychmiast raportowane. Jeśli nie zdefiniowano dostawcy JPA i/lub źródła danych, informacja o nich musi być dostarczona podczas instalacji bądź ich wartości będą odpowiadały wartościom domyślnym kontenera. Kontener może dostarczyć dowolne właściwości specyficzne dla niego do dostawcy JPA podczas tworzenia fabryki zarządców trwałości dla danego PU.
Dla każdego PU odszukiwana jest implementacja javax.persistence.spi.PersistenceProvider. Implementacja PersistenceProvider będzie wołana do stworzenia fabryki zarządcy trwałości dla danego PU poprzez metodę createContainerEntityManagerFactory. Dane konfiguracyjne przekazywane są do metody poprzez egzemplarz klasy javax.persistence.spi.PersistenceUnitInfo. Wyłącznie pojedyńcza fabryka zarządcy trwałości będzie stworzona dla danego PU. Dowolna liczba zarządców trwałości może być utworzona przez pojedyńczą fabrykę.
Reinstalacja PU wymaga wywołania metody close na fabryce zarządców i wykonać createContainerEntityManagerFactory ponownie.
Dostawca JPA zobowiązany jest do przetworzenia informacji o trwałości z adnotacji klas trwałych.
Napotkanie pliku mapowania wymaga zweryfikowania jego poprawności względem orm_1_0.xsd.
Nie przewiduje się wywoływania implementacji javax.persistence.spi.PersistenceProvider z poziomu aplikacji.
W środowisku Java SE utworzenie fabryki zarządcy trwałości odbywa się poprzez metodę javax.persistence.Persistence#createEntityManagerFactory.
Dostawca JPA w środowisku Java SE powinien być dostawcą usługi w sensie Java, tj. w archiwum jar dostawcy w katalogu META-INF/services powinien znajdować się plik javax.persistence.spi.PersistenceProvider, który zawiera nazwę klasy implementującej interfejs javax.persistence.spi.PersistenceProvider. W ten sposób nastąpi automatyczna instalacja dostawcy w środowisku. Tak zainstalowany dostawca JPA będzie dostawcą domyślnym.
Następnie zaprezentowano przykład takiego rozwiązania, gdzie archiwum acme.jar będące archiwum JPA w katalogu META-INF/services zawiera plik javax.persistence.spi.PersistenceProvider, który z kolei zawiera nazwę klasy implementującej PersistenceProvider - com.acme.PersistenceProvider.
Na tym zakończył się rozdział 7.
Dla dociekliwych podaję odpowiedź na wyżej postawione pytanie, czy możliwe jest dystrybuowanie archiwum z plikiem persistence.xml bez żadnych klas trwałych. Odpowiedź jest TAK. W takiej sytuacji definiujemy PU dla aplikacji (modułu) na bazie klas trwałych, które dostępne są na...ścieżce klas (ang. classpath).
06 marca 2007
VI spotkanie Warszawa JUG za nami. Warszawa JUG ma nowe logo!
VI spotkanie Warszawskiej Grupy Użytkowników Java (Warszawa-JUG), gdzie Bartek Soin prezentował RIA w wykonaniu Adobe Flex za nami. Prezentacja wspaniała! Opanowanie i dobre przygotowanie Bartka sprawiło, że zmieściliśmy się w zapowiadanych 1,5 godzinach bez większego problemu, były pytania i moment na agitację kolejnych prezenterów. Flex dobry i ciekawe, ale tylko tyle. Nie jestem specjalnie nim zainteresowany będąc odstraszony ceną - rozwiązanie nie jest darmowe, a biorąc pod uwagę wiele dobrego i równie ciekawego, darmowego oprogramowania nie obawiam się o nudę w nadchodzących dniach.
Nie miałem czasu (czytaj: byłem zarobiony) zajrzeć do swojej skrzynki pocztowej, gdzie czekała na mnie wieść o nowym emblemacie Warszawa JUG! Nie mogłem uwierzyć, że grupa ma w końcu swoje logo. Dzięki Tomkowi Szymańskiemu (alias szimano) mamy Duka-Syrenkę. Dzięki Tomku!
Dlaczego Duke wygląda jakby miał kolczyk w nosie, a może na nosie, nie mam pojęcia. Chętni do poprawek mile widziani.
Kolejne spotkanie już za 2 tygodnie - 20.03.2007 o godz. 18:00 w wykonaniu Michała Margiela nt. Miesięczna ewaluacja Google Web Toolkit (GWT) - i co, fajne?. Serdecznie zapraszam w imieniu jego i grupy!
Nie miałem czasu (czytaj: byłem zarobiony) zajrzeć do swojej skrzynki pocztowej, gdzie czekała na mnie wieść o nowym emblemacie Warszawa JUG! Nie mogłem uwierzyć, że grupa ma w końcu swoje logo. Dzięki Tomkowi Szymańskiemu (alias szimano) mamy Duka-Syrenkę. Dzięki Tomku!
Dlaczego Duke wygląda jakby miał kolczyk w nosie, a może na nosie, nie mam pojęcia. Chętni do poprawek mile widziani.Kolejne spotkanie już za 2 tygodnie - 20.03.2007 o godz. 18:00 w wykonaniu Michała Margiela nt. Miesięczna ewaluacja Google Web Toolkit (GWT) - i co, fajne?. Serdecznie zapraszam w imieniu jego i grupy!
05 marca 2007
Java Persistence - Rozdział 6. Dystrybuowanie encji
Do przygotowania jednego z przykładów potrzebowałem rozpoznać mechanizmy nadpisywania konfiguracji encji (a właściwie jednostki utrwalania - ang. persistence unit) w zależności od ich wykorzystania, tj. jeśli encje były wykorzystane w samodzielnej aplikacji (ang. standalone application) to ich jednostka utrwalania będzie inna niż ta używana przez aplikację internetową. Poszukiwania odpowiedzi na to pytanie rozpocząłem od specyfikacji Java Persistence API w rozdziale 6 o sposobie opakowywania encji do dystrybucji (Chapter 6 - Entity Packaging).
Jednostka utrwalania, dalej zwana PU, jest logicznym bytem składającym się z:
W ramach środowiska Java EE, plik EJB-JAR, WAR, EAR oraz klienta aplikacyjnego może definiować dowolną ilość PU.
PU może znajdować się w ramach plików jar, które są częścią pliku WAR lub EAR, jako zbiór klas wewnątrz pliku ejb-jar lub wewnątrz katalogu classes w ramach aplikacji internetowej (war) bądź jako kombinacja poniższych.
PU jest określana (definiowana) w pliku persistence.xml. Plik lub katalog w formacie jar, których (pod)katalog META-INF zawiera plik persistence.xml jest nazywany punktem początkowym (korzeniem) PU (ang. PU root). Środowisko Java EE akceptuje następujące miejsca jako punkty początkowe PU:
Każdy PU posiada nazwę. Nazwa musi być unikatowa w ramach pojedyńczego EJB-JAR, pojedyńczego WAR, w pliku jar klienta aplikacyjnego lub wewnątrz EAR (czy to w katalogu głównym EAR czy bibliotekach pomocniczych).
Pojedyńczy plik persistence.xml może definiować wiele PU wyznaczając tym samym zasięg widoczności/działania PU (i wynikające z tego ograniczenia, np. niepowtarzalność nazwy PU).
Specyfikacja gwarantuje, że klasy trwałe zdefiniowane na poziomie pliku EAR muszą być dostępne dla wszystkich innych modułów składowych aplikacji jako te same klasy bez rozróżnienia na PU, których mogą być częścią. Wydaje mi się jednak, że jest to wymaganie do spełnienia przez dostawców serwerów aplikacyjnych Java EE, a nie programistę korzystającego z JPA i w zasadzie nie ma się czym przejmować i próbować to zrozumieć (jeśli wciąż niejasne).
Gwarantuje się przenośność aplikacji korzystających z JPA w środowisku Java SE, jeśli aplikacje deklarują klasy trwałe (klasy encji) w PU explicite (w sekcji class dla danego PU).
6.2.1 Plik PU - persistence.xml
Plik persistence.xml definiuje PU. Służy do definicji klas trwałych w danym PU, metadanych mapowania dla tych klas oraz inne dane konfiguracyjne dla PU, zarządców utrwalania i ich fabryki. Plik persistence.xml znajduje się w katalogu META-INF korzenia (punktu początkowego) PU.
Informacje o mapowaniu mogą być zdefiniowane w PU przez adnotacje w klasach encji, pliki XML zawarte w korzeniu PU, w plikach XML poza korzeniem PU, jednakże dostępnych na ścieżce klas (ang. classpath) i do których następują odwołania z persistence.xml lub ich kombinacje.
Klasy trwałe mogą być zawarte w ramach korzenia PU lub mogą być wskazane przez PU przez wyszczególnienie trwałych klas, archiwów jar trwałych klas czy plików XML z metadanymi mapowania, które na nie wskazują (ale które są wciąż dostępne na ścieżce klas) lub ich kombinacje.
Element persistence w deskryptorze XML składa się z jednego lub wielu elementów elementów persistence-unit.
Element persistence-unit posiada następujące atrybuty:
Rozdział 6.2.1.8 zawiera wiele (aż 5!) przykładowych konfiguracji - plików persistence.xml z wyjaśnionymi konfiguracjami końcowymi.
Ciekawą konfiguracją jest plik persistence.xml zawierający jedynie pojedyńczy element persistence-unit.
Bardzo skromna definicja PU (literalnie), która jednak może być niezwykle bogata w zasoby. Dowolna udekorowana klasa znaleziona w punkcie początkowym PU będzie dodana do listy klas trwałych. Jeśli istnieje również plik META-INF/orm.xml, wszystkie klasy, które są wymienione w pliku oraz informacje o mapowaniu są brane pod uwagę z uwzględnieniem reguł wymienionych wcześniej. Brak wskazania dostawcy JPA wskazuje na wykorzystanie domyślnego dostawcy w środowisku oraz że konfiguracja nie jest zależna od konkretnego dostawcy. Typ transakcyjny (transaction-type) nie jest zdefiniowany, więc w Java EE zakłada się JTA podczas, gdy w Java SE będzie to RESOURCE_LOCAL. Kontener (w środowisku Java EE) musi dostarczyć źródło danych, np. podczas instalacji PU. W środowisku Java SE źródło danych będzie dostarczone w inny, specyficzny dla środowiska, sposób.
6.2.2 Zasięg PU
Dowolny EJB-JAR, WAR, plik jar klienta aplikacyjnego czy EAR mogą definiować PU.
Odwołując się do PU poprzez element unitName adnotacji @PersistenceContext czy @PersistenceUnit, lub element persistence-unit-name w deskryptorze XML, widoczność PU jest wyznaczona przez jej miejsce definicji (przez umiejscowienie pliku persistence.xml). PU nie wykracza poza ramy definiującego ją pliku jar, tj. EJB-JAR, WAR czy klienta aplikacyjnego i jest widoczna wyłącznie dla komponentów zawartych w nich. W przypadku pliku EAR, zasięg widoczności PU obejmuje wszystkie komponenty wchodzące w skład EARa.
Jeśli PU w EAR istnieje o tej samej nazwie w module WAR, EJB-JAR czy klienta aplikacyjnego, PU z EAR nie jest domyślnie widoczny w module definiującym własną PU z tą samą nazwą chyba, że odwołuje się do nazwy PU poprzez wykorzystanie '#', która pozwala na odwołanie się do innego PU w ramach tego samego EARa. Wskazanie do PU o tej samej nazwie w innym module zawiera ścieżkę względną do modułu odwołującego się, np. ../lib/persistenceUnitRoot.jar#myPU, gdzie myPU jest nazwą PU zadeklarowaną w persistence.xml w punkcie początkowym ../lib/persistenceUnitRoot.jar (a to oznacza, że persistence.xml znajduje się w katalogu ../lib/persistenceUnitRoot.jar!/META-INF). Składnia '#' może być wykorzystana w adnotacjach oraz elemencie persistence-unit-name w deskryptorze XML do odwołania się do PU na poziomie EARa.
Na zakończenie rozdziału 6. przedstawiono definicję (XML Schema) pliku persistence.xml.
Jednostka utrwalania, dalej zwana PU, jest logicznym bytem składającym się z:
- Definicji fabryki zarządców encyjnych (ang. entity manager factory) i jej zarządców wraz z ich konfiguracją (sekcja provider).
- Zbioru zarządzanych klas trwałych (encji) zawartych w danym PU (i przez to zarządzanych przez zarządców encyjnych tworzonych przez ustaloną fabrykę zarządcy encyjnego).
- Metadane mapowania (adnotacje lub deskryptor XML), które definiują mapowanie encji do bazy danych.
W ramach środowiska Java EE, plik EJB-JAR, WAR, EAR oraz klienta aplikacyjnego może definiować dowolną ilość PU.
PU może znajdować się w ramach plików jar, które są częścią pliku WAR lub EAR, jako zbiór klas wewnątrz pliku ejb-jar lub wewnątrz katalogu classes w ramach aplikacji internetowej (war) bądź jako kombinacja poniższych.
PU jest określana (definiowana) w pliku persistence.xml. Plik lub katalog w formacie jar, których (pod)katalog META-INF zawiera plik persistence.xml jest nazywany punktem początkowym (korzeniem) PU (ang. PU root). Środowisko Java EE akceptuje następujące miejsca jako punkty początkowe PU:
- plik EJB-JAR
- katalog WEB-INF/classes wewnątrz pliku WAR (tj. plik persistence.xml znajduje się w katalogu WEB-INF/classes/META-INF)
- dowolny plik jar w katalogu WEB-INF/lib wewnątrz pliku WAR
- dowolny plik jar w katalogu głównym pliku EAR
- dowolny plik jar z bibliotek pomocniczych (współdzielonych) w pliku EAR
- plik jar klienta aplikacyjnego
Każdy PU posiada nazwę. Nazwa musi być unikatowa w ramach pojedyńczego EJB-JAR, pojedyńczego WAR, w pliku jar klienta aplikacyjnego lub wewnątrz EAR (czy to w katalogu głównym EAR czy bibliotekach pomocniczych).
Pojedyńczy plik persistence.xml może definiować wiele PU wyznaczając tym samym zasięg widoczności/działania PU (i wynikające z tego ograniczenia, np. niepowtarzalność nazwy PU).
Specyfikacja gwarantuje, że klasy trwałe zdefiniowane na poziomie pliku EAR muszą być dostępne dla wszystkich innych modułów składowych aplikacji jako te same klasy bez rozróżnienia na PU, których mogą być częścią. Wydaje mi się jednak, że jest to wymaganie do spełnienia przez dostawców serwerów aplikacyjnych Java EE, a nie programistę korzystającego z JPA i w zasadzie nie ma się czym przejmować i próbować to zrozumieć (jeśli wciąż niejasne).
Gwarantuje się przenośność aplikacji korzystających z JPA w środowisku Java SE, jeśli aplikacje deklarują klasy trwałe (klasy encji) w PU explicite (w sekcji class dla danego PU).
6.2.1 Plik PU - persistence.xml
Plik persistence.xml definiuje PU. Służy do definicji klas trwałych w danym PU, metadanych mapowania dla tych klas oraz inne dane konfiguracyjne dla PU, zarządców utrwalania i ich fabryki. Plik persistence.xml znajduje się w katalogu META-INF korzenia (punktu początkowego) PU.
Informacje o mapowaniu mogą być zdefiniowane w PU przez adnotacje w klasach encji, pliki XML zawarte w korzeniu PU, w plikach XML poza korzeniem PU, jednakże dostępnych na ścieżce klas (ang. classpath) i do których następują odwołania z persistence.xml lub ich kombinacje.
Klasy trwałe mogą być zawarte w ramach korzenia PU lub mogą być wskazane przez PU przez wyszczególnienie trwałych klas, archiwów jar trwałych klas czy plików XML z metadanymi mapowania, które na nie wskazują (ale które są wciąż dostępne na ścieżce klas) lub ich kombinacje.
Element persistence w deskryptorze XML składa się z jednego lub wielu elementów elementów persistence-unit.
Element persistence-unit posiada następujące atrybuty:
- name - nazwa PU, która musi być unikatowa w ramach korzenia PU. Można odwołać się do niej poprzez adnotacje @PersistenceContext lub @PersistenceUnit oraz poprzez API fabryki zarządcy utrwalania.
- transaction-type - definiuje rodzaj zarządców utrwalania tworzonych przez fabrykę zarządców dla danego PU: zarządcy JTA - wartość JTA - lub zarządcy lokalnego dla zasobu (kontrolowanego przez zasób, ang. resource-local entity/persistence manager) - wartość RESOURCE_LOCAL. Wartość JTA wymaga, aby źródło danych było zarządzane przez kontener - albo poprzez element jta-data-source lub dostarczane przez kontener. W środowisku Java EE, wartość RESOURCE_LOCAL implikuje użycie źródła danych niezarządzanego (w sensie transakcji) przez kontener. Domyślna wartość w środowisku Java EE to JTA podczas, gdy w Java SE to RESOURCE_LOCAL.
- description - opis PU
- provider - definiuje klasę dostawcy JPA implementującą javax.persistence.spi.PersistenceProvider. Brak elementu implikuje wykorzystanie domyślnego dostawcy JPA (np. w GlassFish jest to TopLink Essentials, w Apache Geronimo - Apache OpenJPA, a w JBoss AS - Hibernate)
- jta-data-source, non-jta-data-source - w środowisku Java EE specyfikuje nazwę w JNDI źródła danych JTA lub nietransakcyjnego. Brak deklaracji wymusza, aby podczas instalacji aplikacji podano źródło danych JTA lub źródło danych JTA musi zostać dostarczony przez kontener, z którym zostanie związana fabryka zarządców utrwalania JTA.
Nazwa źródła danych jest lokalna dla środowiska uruchomieniowego i specyficzna dla niego.
W środowisku Java SE użycie elementu (bądź innych sposobów konfiguracji) jest określane przez dostawcę JPA. - mapping-file, jar-file, class, exclude-unlisted-classes - służą do deklaracji klas związanych z encjami (klasy trwałe, zanurzane - ang. embeddable - czy mapowane) włączonych explicite do danego PU.
Zbiór klas trwałych zarządzanych przez dany PU wyznaczany jest przez użycie następujących mechanizmów:- pliki mapowania XML
- pliki jar na ścieżce klas aplikacji
- podana dosłownie lista klas trwałych
- klasy udekorowane adnotacjami trwałymi, które zawarte są w punkcie początkowym (korzeniu) PU (jeśli nie korzysta się z elementu exclude-unlisted-classes).
Plik mapowania XML zawiera informacje o mapowaniu dla klas zawartych w nim. Nazwa pliku to orm.xml i może być umieszczony w katalogu META-INF punktu początkowego (korzenia) PU lub dowolnego pliku jar wskazanego przez persistence.xml. Dodatkowo można wskazać pliki mapowania XML przez elementy mapping-file, które mogą znajdować się w dowolnym miejscy na ścieżce klas. Plik orm.xml i inne związane pliki mapowania XML są ładowane przez dostawcę JPA jako zasoby. Można definiować wiele plików mapowania XML i ich ostateczny wynik dla danego PU będzie ich sumą. Nakładające się konfiguracje mapowania dla tych samych encji z różnych plików w ramach pojedyńczego PU powoduje, że ostateczny wynik wyznaczania konfiguracji utrwalania jest nieokreślony, tj. specyficzny dla dostawcy JPA i może nawet zakończyć się zgłoszeniem błędu.
Element jar-file wskazuje pliki jar przeszukiwane w celu znalezienia klas trwałych oraz plików mapowania XML. Oprócz jar-file można wskazać klasy trwałe przez element mapping-file. Oba elementy nie wykluczają się, a uzupełniają. Ścieżka plików wskazanych przez jar-file jest względna do punktu początkowego (korzenia) PU. Element jar-file nie ma zastosowania dla PU w środowisku Java SE.
Lista nazwanych wprost klas trwałych specyfikowana jest przez element class. Klasa wskazana przez element class musi być udekorowana przez adnotację @Entity, @Embeddable lub @MappedSuperclass. W środowisku Java SE zakłada się, że wszystkie klasy trwałe są wskazane przez element(y) class, aby zagwarantować przenośność aplikacji (nie zaleca się polegania na innych mechanizmach odszukiwania trwałych klas w PU). Może się zdarzyć, że dostawca JPA w środowisku Java SE może wymagać, aby wszystkie klasy trwałe były wprost podane w persistence.xml za pomocą elementu class.
Wszystkie klasy znajdujące się w korzeniu PU są przeszukiwane pod kątem klas trwałych i każda adnotacja będzie brała udział w budowaniu finalnej postaci konfiguracji mapowania (brak adnotacji wskazuje na wykorzystanie wartości domyślnych i również jest konfiguracją). Wykluczenie klas znajdujących się w korzeniu PU z włączenia do PU odbywa się za pomocą elementu exclude-unlisted-classes, co powoduje, że wyłącznie klasy wskazane explicite w persistence.xml będą brane pod uwagę. Nie przewiduje się stosowania elementu exclude-unlisted-classes w środowisku Java SE. Domyślna wartość elementu exclude-unlisted-classes to false, tj. przeszukuj zawierający plik jar lub katalog (innymi słowy cały punkt początkowy PU).
Lista zarządzanych klas przez PU jest sumą wszystkich wymienionych źródeł. Informacje o mapowaniu pozyskane z adnotacji (bądź ich braku, wtedy polega się na wartościach domyślnych) są nadpisywane przez informacje z pliku mapowania XML (jeśli taki plik istnieje dla danej klasy). Gwarantuje się nadpisywanie wartości przez pliki mapowania XML na poziomie pola lub właściwości trwałej (jest to poziom minimalny, gwarantowany przez specyfikację).
Klasy i pliki jar wskazane przez konfigurację PU muszą być dostępne na ścieżce klas. Wskazanie ich w pliku persistence.xml nie powoduje ich umieszczenia na ścieżce klas.
Wszystkie klasy zarządzane (przez dany PU) muszą być umieszczone na ścieżce klas, aby zagwarantować, że zarządcy utrwalania z różnych PU zarządzający klasą trwałą faktycznie będą korzystać z tej samej reprezentacji klasy. - properties - służy do zdefiniowania specyficznych dla dostawcy parametrów konfiguracyjnych, dotyczących konfiguracji fabryki zarządcy utrwalania oraz samego PU.
Jeśli zdefiniowano parametr nieakceptowany przez danego dostawcę JPA (inny niż zdefinowane przez specyfikację) musi być on zignorowany.
Zaleca się, aby parametry konfiguracyjne specyficzne dla dostawcy były nazwami rozpoczynającymi się od specyficznego dla dostawcy przedrostka, np. openjpa dla Apache OpenJPA, hibernate dla Hibernate, czy toplink dla Toplink Essentials. Parametry rozpocznające się javax.persistence są zarezerwowane dla ustandaryzowanych parametrów konfiguracyjnych JPA.
Rozdział 6.2.1.8 zawiera wiele (aż 5!) przykładowych konfiguracji - plików persistence.xml z wyjaśnionymi konfiguracjami końcowymi.
Ciekawą konfiguracją jest plik persistence.xml zawierający jedynie pojedyńczy element persistence-unit.
<persistence-unit name="OrderManagement"/>
6.2.2 Zasięg PU
Dowolny EJB-JAR, WAR, plik jar klienta aplikacyjnego czy EAR mogą definiować PU.
Odwołując się do PU poprzez element unitName adnotacji @PersistenceContext czy @PersistenceUnit, lub element persistence-unit-name w deskryptorze XML, widoczność PU jest wyznaczona przez jej miejsce definicji (przez umiejscowienie pliku persistence.xml). PU nie wykracza poza ramy definiującego ją pliku jar, tj. EJB-JAR, WAR czy klienta aplikacyjnego i jest widoczna wyłącznie dla komponentów zawartych w nich. W przypadku pliku EAR, zasięg widoczności PU obejmuje wszystkie komponenty wchodzące w skład EARa.
Jeśli PU w EAR istnieje o tej samej nazwie w module WAR, EJB-JAR czy klienta aplikacyjnego, PU z EAR nie jest domyślnie widoczny w module definiującym własną PU z tą samą nazwą chyba, że odwołuje się do nazwy PU poprzez wykorzystanie '#', która pozwala na odwołanie się do innego PU w ramach tego samego EARa. Wskazanie do PU o tej samej nazwie w innym module zawiera ścieżkę względną do modułu odwołującego się, np. ../lib/persistenceUnitRoot.jar#myPU, gdzie myPU jest nazwą PU zadeklarowaną w persistence.xml w punkcie początkowym ../lib/persistenceUnitRoot.jar (a to oznacza, że persistence.xml znajduje się w katalogu ../lib/persistenceUnitRoot.jar!/META-INF). Składnia '#' może być wykorzystana w adnotacjach oraz elemencie persistence-unit-name w deskryptorze XML do odwołania się do PU na poziomie EARa.
Na zakończenie rozdziału 6. przedstawiono definicję (XML Schema) pliku persistence.xml.
01 marca 2007
Przepis na środowisko do praktycznego poznawania JPA
Właśnie ukończyłem pisanie kolejnego artykułu, który jest opisem moich doświadczeń z integracji różnych projektów w celu zestawienia środowiska dla urozmaicenia lektury specyfikacji JPA. Z jego pomocą zamierzam jednocześnie czytać i programować, tj. tworzyć własne komponenty encyjne oraz wykonywać testy jednostkowe z nimi w roli głównej.
Nie tak dawno pisałem (a może jedynie myślałem o tym) o popróbowaniu się z TestNG. Było to w momencie, kiedy powracałem do lektury specyfikacji Java Persistence API (JPA), więc pomyślałem o połączeniu przyjemnego z pożytecznym, czyli o możliwości jednoczesnego testowania tego, co czytałem. Można było również inaczej postawić problem - najpierw próbować się z JPA, a później szukać wyjaśnień jej działania wertując kartki specyfikacji. Tak, czy owak nie chciałem jedynie relacjonować specyfikacji JPA, ale również prezentować możliwe zastosowania. Sprowokowało mnie to do zestawienia środowiska, w którym będę tworzył moje komponenty encyjne i aplikacje korzystające z nich oraz posiadał mechanizm wykonywania testów. Skoro dotykałem JPA to konieczna była baza danych - padło na Apache Derby. Do tego dorzuciłem Apache Maven 2 jako narzędzie spinające całość (i dostarczające wielu niewykorzystanych acz wielce produktywnych funkcjonalności), z Eclipse IDE w tle, co ostatecznie przemieniło się w bardzo produktywne środowisko do poznawania JPA w niezwykle praktyczny sposób - tworząc testy jednostkowe w trakcie lektury specyfikacji.
Początkowo miała to być jedynie relacja z moich doświadczeń, ale nie długo trwało zanim zorientowałem się, że wielkość materiału przekracza ramy relacji i wymaga stworzenia artykułu, co uczyniłem.
Jest to środowisko, które uatrakcyjni moją lekturę specyfikacji. Robi się w końcu coraz trudniej i możliwość zobaczenia tego, co się czyta wierzę, że jest ciekawym pomysłem na niwelowanie potencjalnych wybojów. Konfiguracja środowiska z wykorzystaniem JPA z Apache OpenJPA i Apache Derby oraz Apache Maven 2 i TestNG zapewnia mi powtarzalność wykonywania testów i jest jednocześnie ciekawym urozmaiceniem pogłębiania znajomości JPA. Tak "uzbrojony" jestem gotów do podjęcia się wyzwania rozpoznawania specyfikacji Java Persistence API w praktyce!
Artykuł zatytułowany jest Java Persistence API z OpenJPA i Derby oraz TestNG z Eclipse IDE w tle.
Nie tak dawno pisałem (a może jedynie myślałem o tym) o popróbowaniu się z TestNG. Było to w momencie, kiedy powracałem do lektury specyfikacji Java Persistence API (JPA), więc pomyślałem o połączeniu przyjemnego z pożytecznym, czyli o możliwości jednoczesnego testowania tego, co czytałem. Można było również inaczej postawić problem - najpierw próbować się z JPA, a później szukać wyjaśnień jej działania wertując kartki specyfikacji. Tak, czy owak nie chciałem jedynie relacjonować specyfikacji JPA, ale również prezentować możliwe zastosowania. Sprowokowało mnie to do zestawienia środowiska, w którym będę tworzył moje komponenty encyjne i aplikacje korzystające z nich oraz posiadał mechanizm wykonywania testów. Skoro dotykałem JPA to konieczna była baza danych - padło na Apache Derby. Do tego dorzuciłem Apache Maven 2 jako narzędzie spinające całość (i dostarczające wielu niewykorzystanych acz wielce produktywnych funkcjonalności), z Eclipse IDE w tle, co ostatecznie przemieniło się w bardzo produktywne środowisko do poznawania JPA w niezwykle praktyczny sposób - tworząc testy jednostkowe w trakcie lektury specyfikacji.
Początkowo miała to być jedynie relacja z moich doświadczeń, ale nie długo trwało zanim zorientowałem się, że wielkość materiału przekracza ramy relacji i wymaga stworzenia artykułu, co uczyniłem.
Jest to środowisko, które uatrakcyjni moją lekturę specyfikacji. Robi się w końcu coraz trudniej i możliwość zobaczenia tego, co się czyta wierzę, że jest ciekawym pomysłem na niwelowanie potencjalnych wybojów. Konfiguracja środowiska z wykorzystaniem JPA z Apache OpenJPA i Apache Derby oraz Apache Maven 2 i TestNG zapewnia mi powtarzalność wykonywania testów i jest jednocześnie ciekawym urozmaiceniem pogłębiania znajomości JPA. Tak "uzbrojony" jestem gotów do podjęcia się wyzwania rozpoznawania specyfikacji Java Persistence API w praktyce!
Artykuł zatytułowany jest Java Persistence API z OpenJPA i Derby oraz TestNG z Eclipse IDE w tle.
26 lutego 2007
Aplikacja JPA w GlassFish v2 z Firebird v2 i Eclipse IDE 3.3
Po sukcesie z Eclipse Mylar pozostałe wtyczki, z którymi miałem problem zaczęły również w końcu działać! Okazało się, że błędna konfiguracja Eclipse IDE 3.3M5, który korzystał z biblioteki Java 1.4.2 powodowała, że wtyczki zależne od Java 5 zainstalowane nie zgłaszały błędu, ale i nie działały. Odinstalowanie Java 1.4.2 z mojego komputera było nie tylko dobrym krokiem w celu poprawy sytuacji z niedziałającymi wtyczkami, ale również zwiększenia ilości wolnego miejsca na dysku (taki maluczki niedzielny prezent).
Taki sukces wymagał odpowiedniego rozgłosu! Musiał być oznajmiony w odpowiedni sposób - przepisem na przykładową aplikację JPA z Eclipse IDE, GlassFish i Firebird.
Zainstalowawszy WTP 2.0M5 (z narzędziami do JPA i JSF) oraz GlassFish Eclipse Plugin postanowiłem popróbować się z utworzeniem prostej aplikacji JPA, która korzystałaby ze źródła danych w GlassFish v2 do Firebird v2 (temat pojawił się na grupie pl.comp.lang.java - EJB3 SunAppServer i Firebird - i akurat zbiegł się z moim powrotem do lektury specyfikacji JPA). Nigdy nie pracowałem z Firebird, ale poza poznaniem podstawowych komend do uruchomienia bazy danych i jej zatrzymania nie zamierzałem poznawać produktu więcej. To jest właśnie zaleta warstwowych aplikacji, gdzie część odpowiedzialności za tworzenie aplikacji można scedować na inne osoby w projekcie (no cóż, nie pierwszy raz występuję w kilku rolach: administratora bazy danych, serwera aplikacyjnego i programisty). W zasadzie nie potrzebowałem serwera aplikacyjnego do uruchomienia aplikacji z JPA, ale zadane pytanie na p.c.l.java dotyczyło takiego środowiska, a co więcej zarządzanie połączeniami do bazy danych zlecimy serwerowi aplikacyjnemu GlassFish (poznanie kilku komend administracyjnych nie powinno przysłonić właściwej treści wpisu).
Zanim przedstawię przepis na aplikację JPA i otaczający ją świat, kilka słów o wersjach oprogramowania w środowisku wykonawczym (uruchomieniowym):
Poniższy obrazek mówi sam za siebie - Eclipse IDE 3.3 z wtyczkami, które obiecują usprawnić pracę z technologiami Java EE 5 i przybliżyć nas do (bądź wręcz przewyższyć możliwości) NetBeans IDE 6.0 (jeszcze nie tym razem ;-))

Krok 1. Definicja GlassFish v2 w Eclipse IDE 3.3
Rozpoczynam od definicji GlassFish w Eclipse IDE.

Jak widać powyżej lista dostępnych serwerów aplikacyjnych jest imponująca, ale tym razem padło na GlassFish (reszta musi poczekać).

Po chwili Eclipse IDE już wie jak pracować z GlassFish v2. Na razie idzie gładko. GlassFish jest zdefiniowany i uruchomiony - wszystko z poziomu Eclipse IDE.
Krok 2. Uruchomienie Firebird Superserver
Uruchamiam Firebird Superserver (zalecana konfiguracja na MS Windows, na którym pracuję).

Po tym można już założyć nową bazę danych dedykowaną dla mojej przykładowej aplikacji.
I sprawdzam, że baza danych faktycznie jest stworzona i dostępna z zewnątrz.
Dowiaduję się o możliwości utworzenia synonimów (ang. alias) dla nowoutworzonej bazy danych. Korzystanie z synonimu jest prostsze i dodatkowo skrypt tworzący pulę połączeń w GF nie akceptuje dwukropka w ścieżce bazy danych (':'), który jest separatorem w opcji --property.
W pliku $FIREBIRD_HOME/aliases.conf umieściłem poniższą linię:
Krok 3. Definicja źródła danych do Firebird w GlassFish
Postępujemy zgodnie z dokumentacją GlassFish'a - Chapter 14: Using the JDBC API for Database Access.
Istnieją dwie możliwości zdefiniowania źródła danych w GlassFish:
Najpierw należy przekopiować sterownik JDBC Firebird'a - jaybird-full-2.1.1.jar - do katalogu $GLASSFISH_HOME/domains/domain1/lib/ext.
Następnie wydać polecenia z poziomu konsoli:
W konsoli można sprawdzić, że połączenie faktycznie zostało zdefiniowane, a jak później się okaże i dostępne dla aplikacji.
Krok 4. Utworzenie encji Customer
Mając zainstalowaną i co ważne działającą wtyczkę Eclipse Dali skrzętnie korzystam z jego pomocy przy utworzeniu encji.

, a następnie
Po chwili mam kompletną klasę encji, która jest o tyle ciekawa, że jak się później okazało wymagała adnotacji wcześniej przeze mnie nie wykorzystywanych - @NamedQuery oraz @Column z atrybutem columnDefinition. Użycie @NamedQuery było opcjonalne i służyło jedynie upraszczeniu zarządzania zapytaniem (możliwe późniejsze modyfikacje) podczas, gdy użycie z @Column(columnDefinition="NUMERIC(10)") było konieczne dla poprawnego działania TopLink z Firebird. TopLink jest domyślnym środowiskiem JPA w GlassFish i niestety nie posiada wsparcia dla Firebird, a domyślna konfiguracja TopLink wskazuje na Oracle i stąd pewne rozbieżności w tworzonych komendach SQL.
Do pełnej konfiguracji encji Customer potrzebny był jeszcze plik konfiguracyjny - persistence.xml.
Krok 5. Utworzenie aplikacji internetowej - firebird
Stworzyłem bardzo trywialny servlet, który podlega zarządzaniu zależnościami w Java EE 5 i mogłem skorzystać z adnotacji.
z poniższym deskryptorem instalacji aplikacji internetowej - WEB-INF/web.xml:
Pozostało stworzyć stronę prezentującą wyniki działania aplikacji - customers.jsp:
Wybieram menu kontekstowe Run As->Run on Server:

i po chwili w zakładce konsoli pojawiają się nieciekawe, ale oczekiwane komunikaty o uruchomieniu aplikacji:
a w dzienniku zdarzeń GlassFish'a:
, czyli działa! A zatem na dzisiaj koniec.
Problemy
Najczęstszy to brak pamięci, który pojawia się pracując z plikami XML w tak "rozszerzonym" Eclipse IDE. Być może zwiększenie pamięci naprawiłoby problem, ale nie chciało mi się szukać.
I drugi, równie bolesny, to utrata stanu GlassFish przez wtyczkę GlassFish Eclipse plugin, kiedy w trakcie zatrzymywania serwera próbowałem uruchomić go ponownie. Rozwiązanie okazało się wymagające monitorowania stanu GF - podgląd dziennika zdarzeń GF ($GLASSFISH_HOME/domains/domain1/logs/server.log). Możemy uruchomić GF dopiero po pojawieniu się następujących wpisów w dzienniku zdarzeń:
Wcześniejsza próba uruchomienia będzie objawiała się tym, że Eclipse będzie raportował o próbie uruchomienia GF (Status=Starting...)

mimo, że tak na prawdę nie kontroluje GF i komunikat będzie trwał i trwał. Jedynym wyjściem wydaje się być zatrzymanie serwera z poziomu Eclipse IDE (tj. wciśnięcie ikony w postaci czerwonego kwadratu) i ponowne jego uruchomienie.
Czasami podczas uaktualniania aplikacji (ponownej jej instalacji na serwerze) pojawiał się błąd:
co obchodzimy przez zatrzymanie GF i ponowne uruchomienie.
Skłaniam się ku stwierdzeniu, że najmniej uciążliwym sposobem uaktualnienia aplikacji na serwerze GlassFish z użyciem wtyczki GlassFish Eclipse plugin jest po prostu zatrzymywanie serwera i jej instalacja za pomocą menu kontekstowego Publish (co automatycznie uruchomi również serwer, jeśli zatrzymany).
Taki sukces wymagał odpowiedniego rozgłosu! Musiał być oznajmiony w odpowiedni sposób - przepisem na przykładową aplikację JPA z Eclipse IDE, GlassFish i Firebird.
Zainstalowawszy WTP 2.0M5 (z narzędziami do JPA i JSF) oraz GlassFish Eclipse Plugin postanowiłem popróbować się z utworzeniem prostej aplikacji JPA, która korzystałaby ze źródła danych w GlassFish v2 do Firebird v2 (temat pojawił się na grupie pl.comp.lang.java - EJB3 SunAppServer i Firebird - i akurat zbiegł się z moim powrotem do lektury specyfikacji JPA). Nigdy nie pracowałem z Firebird, ale poza poznaniem podstawowych komend do uruchomienia bazy danych i jej zatrzymania nie zamierzałem poznawać produktu więcej. To jest właśnie zaleta warstwowych aplikacji, gdzie część odpowiedzialności za tworzenie aplikacji można scedować na inne osoby w projekcie (no cóż, nie pierwszy raz występuję w kilku rolach: administratora bazy danych, serwera aplikacyjnego i programisty). W zasadzie nie potrzebowałem serwera aplikacyjnego do uruchomienia aplikacji z JPA, ale zadane pytanie na p.c.l.java dotyczyło takiego środowiska, a co więcej zarządzanie połączeniami do bazy danych zlecimy serwerowi aplikacyjnemu GlassFish (poznanie kilku komend administracyjnych nie powinno przysłonić właściwej treści wpisu).
Zanim przedstawię przepis na aplikację JPA i otaczający ją świat, kilka słów o wersjach oprogramowania w środowisku wykonawczym (uruchomieniowym):
Poniższy obrazek mówi sam za siebie - Eclipse IDE 3.3 z wtyczkami, które obiecują usprawnić pracę z technologiami Java EE 5 i przybliżyć nas do (bądź wręcz przewyższyć możliwości) NetBeans IDE 6.0 (jeszcze nie tym razem ;-))
Krok 1. Definicja GlassFish v2 w Eclipse IDE 3.3
Rozpoczynam od definicji GlassFish w Eclipse IDE.
Jak widać powyżej lista dostępnych serwerów aplikacyjnych jest imponująca, ale tym razem padło na GlassFish (reszta musi poczekać).
Po chwili Eclipse IDE już wie jak pracować z GlassFish v2. Na razie idzie gładko. GlassFish jest zdefiniowany i uruchomiony - wszystko z poziomu Eclipse IDE.
Krok 2. Uruchomienie Firebird Superserver
Uruchamiam Firebird Superserver (zalecana konfiguracja na MS Windows, na którym pracuję).
$ cd $FIREBIRD_HOME, co tworzy dwa serwisy Firebird Guardian oraz Firebird Server - oba powinny już być uruchomione.
$ ./bin/install_super.bat
Po tym można już założyć nową bazę danych dedykowaną dla mojej przykładowej aplikacji.
$ cd $FIREBIRD_HOME
$ ./bin/isql.exe
Use CONNECT or CREATE DATABASE to specify a database
SQL> create database 'c:\temp\glassfish-jpa.fdb' page_size 8192
CON> user 'SYSDBA' password 'masterkey';
SQL> exit;
I sprawdzam, że baza danych faktycznie jest stworzona i dostępna z zewnątrz.
$ ./bin/isql.exe
Use CONNECT or CREATE DATABASE to specify a database
SQL> connect 'localhost:c:\temp\glassfish-jpa.fdb' user 'sysdba' password 'masterkey';
Database: 'localhost:c:\temp\glassfish-jpa.fdb', User: sysdba
SQL> exit;
Dowiaduję się o możliwości utworzenia synonimów (ang. alias) dla nowoutworzonej bazy danych. Korzystanie z synonimu jest prostsze i dodatkowo skrypt tworzący pulę połączeń w GF nie akceptuje dwukropka w ścieżce bazy danych (':'), który jest separatorem w opcji --property.
W pliku $FIREBIRD_HOME/aliases.conf umieściłem poniższą linię:
glassfish-jpa=c:\temp\glassfish-jpa.fdb
Krok 3. Definicja źródła danych do Firebird w GlassFish
Postępujemy zgodnie z dokumentacją GlassFish'a - Chapter 14: Using the JDBC API for Database Access.
Istnieją dwie możliwości zdefiniowania źródła danych w GlassFish:
- Polecenie asadmin create-jdbc-connection-pool
- Konsola administracyjna pod adresem http://localhost:4848/
Najpierw należy przekopiować sterownik JDBC Firebird'a - jaybird-full-2.1.1.jar - do katalogu $GLASSFISH_HOME/domains/domain1/lib/ext.
Następnie wydać polecenia z poziomu konsoli:
$ ./bin/asadmin.bat create-jdbc-connection-pool \
--datasourceclassname org.firebirdsql.jdbc.FBWrappingDataSource \
--restype javax.sql.DataSource \
--property password=masterkey:userName=sysdba:databaseName=//localhost/glassfish-jpa:pooling=true:minSize=5:maxSize=30:type=type4 \
FirebirdPool
$ ./bin/asadmin.bat ping-connection-pool FirebirdPool
Command ping-connection-pool executed successfully.
$ ./bin/asadmin.bat create-jdbc-resource --connectionpoolid FirebirdPool jdbc/Firebird
W konsoli można sprawdzić, że połączenie faktycznie zostało zdefiniowane, a jak później się okaże i dostępne dla aplikacji.
Krok 4. Utworzenie encji Customer
Mając zainstalowaną i co ważne działającą wtyczkę Eclipse Dali skrzętnie korzystam z jego pomocy przy utworzeniu encji.
, a następnie
package pl.jaceklaskowski.jpa.firebird.entities;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.NamedQuery;
@Entity
@NamedQuery(name = "znajdzWszystkichKlientow", query = "SELECT c FROM Customer c")
public class Customer {
private int pesel;
private String name;
public Customer() {
}
public Customer(int pesel, String name) {
this.pesel = pesel;
this.name = name;
}
@Id
@Column(columnDefinition = "NUMERIC(10)")
public int getPesel() {
return pesel;
}
public void setPesel(int pesel) {
this.pesel = pesel;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
Do pełnej konfiguracji encji Customer potrzebny był jeszcze plik konfiguracyjny - persistence.xml.
<?xml version="1.0" encoding="UTF-8"?>
<persistence version="1.0" xmlns="http://java.sun.com/xml/ns/persistence"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">
<persistence-unit name="firebird">
<jta-data-source>jdbc/Firebird</jta-data-source>
<class>pl.jaceklaskowski.jpa.firebird.entities.Customer</class>
<properties>
<property name="toplink.ddl-generation" value="drop-and-create-tables"/>
<property name="toplink.logging.level" value="ALL"/>
</properties>
</persistence-unit>
</persistence>
Krok 5. Utworzenie aplikacji internetowej - firebird
Stworzyłem bardzo trywialny servlet, który podlega zarządzaniu zależnościami w Java EE 5 i mogłem skorzystać z adnotacji.
package pl.jaceklaskowski.jpa.firebird.servlets;
import java.io.IOException;
import java.util.List;
import javax.annotation.Resource;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.transaction.UserTransaction;
import pl.jaceklaskowski.jpa.firebird.entities.Customer;
@SuppressWarnings("serial")
public class CreateCustomerServlet extends javax.servlet.http.HttpServlet implements javax.servlet.Servlet {
@PersistenceContext(unitName = "firebird")
private EntityManager em;
@Resource
private UserTransaction ut;
@SuppressWarnings("unchecked")
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
int pesel = Integer.parseInt(request.getParameter("pesel"));
String name = request.getParameter("name");
if (pesel > 0 && name != null) {
Customer customer = new Customer(pesel, name);
try {
ut.begin();
em.persist(customer);
ut.commit();
} catch (Exception e) {
throw new ServletException(e);
}
}
List<Customer> customers = em.createNamedQuery("znajdzWszystkichKlientow").getResultList();
request.setAttribute("customers", customers);
request.getRequestDispatcher("/customers.jsp").forward(request, response);
}
}
z poniższym deskryptorem instalacji aplikacji internetowej - WEB-INF/web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee web-app_2_5.xsd" version="2.5">
<display-name>firebird-web</display-name>
<servlet>
<description></description>
<display-name>CreateCustomerServlet</display-name>
<servlet-name>CreateCustomerServlet</servlet-name>
<servlet-class>pl.jaceklaskowski.jpa.firebird.servlets.CreateCustomerServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>CreateCustomerServlet</servlet-name>
<url-pattern>/createCustomer</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>customers.jsp</welcome-file>
</welcome-file-list>
</web-app>
Pozostało stworzyć stronę prezentującą wyniki działania aplikacji - customers.jsp:
Krok 6. Uruchomienie aplikacji
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
pageEncoding="ISO-8859-1"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Klienci</title>
</head>
<body>
<form action="createCustomer">
<table>
<tr>
<td>PESEL:</td>
<td><input name="pesel" /></td>
</tr>
<tr>
<td>Nazwa:</td>
<td><input name="name" /></td>
</tr>
<tr>
<td><input type="submit" value="Stwórz" /></td>
</tr>
</table>
</form>
<table border="0" cellpadding="1" cellspacing="1">
<tr>
<td>Lp.</td>
<td>PESEL</td>
<td>Nazwa</td>
</tr>
<c:forEach var="customer" items="${customers}" varStatus="status">
<tr>
<td>${status.count}</td>
<td>${customer.pesel}</td>
<td>${customer.name}</td>
</tr>
</c:forEach>
</table>
</body>
</html>
Wybieram menu kontekstowe Run As->Run on Server:
i po chwili w zakładce konsoli pojawiają się nieciekawe, ale oczekiwane komunikaty o uruchomieniu aplikacji:
Buildfile: C:\.eclipse\jpa\.metadata\.plugins\org.eclipse.jst.server.generic.core\serverdef\sunappsrv-ant.xml
deploy.j2ee.web:
[echo] C:/.eclipse/jpa/.metadata/.plugins/org.eclipse.wst.server.core/tmp0/firebird-web
[jar] Building jar: C:\.eclipse\jpa\.metadata\.plugins\org.eclipse.jst.server.generic.core\serverdef\firebird-web.war
tools:
deploy:
[exec] Command deploy executed successfully.
deploy-url-message:
[echo] Application Deployed at: http://127.0.0.1:8080/firebird-web
BUILD SUCCESSFUL
Total time: 8 seconds
a w dzienniku zdarzeń GlassFish'a:
[#|2007-02-26T08:18:15.546+0100|INFO|sun-appserver9.1|oracle.toplink.essentials.session.file:/C:/apps/glassfish/domains/domain1/applications/j2ee-modules/firebird-web/WEB-INF/lib/f
irebird.jar-firebird|_ThreadID=14;_ThreadName=Thread-24;|Not able to detect platform for vendor name [Firebird 2.0*WI-V2.0.0.12748 Firebird 2.0/tcp (dev)/P10]. Defaulting to [oracl
e.toplink.essentials.platform.database.DatabasePlatform]. The database dialect used may not match with the database you are using. Please explicitly provide a platform using proper
ty toplink.platform.class.name.|#]
[#|2007-02-26T08:18:15.562+0100|CONFIG|sun-appserver9.1|oracle.toplink.essentials.session.file:/C:/apps/glassfish/domains/domain1/applications/j2ee-modules/firebird-web/WEB-INF/lib
/firebird.jar-firebird.connection|_ThreadID=14;_ThreadName=Thread-24;|connecting(DatabaseLogin(
platform=>DatabasePlatform
user name=> ""
connector=>JNDIConnector datasource name=>null
))|#]
[#|2007-02-26T08:18:15.562+0100|CONFIG|sun-appserver9.1|oracle.toplink.essentials.session.file:/C:/apps/glassfish/domains/domain1/applications/j2ee-modules/firebird-web/WEB-INF/lib
/firebird.jar-firebird.connection|_ThreadID=14;_ThreadName=Thread-24;|Connected: jdbc:firebirdsql:java://localhost/glassfish-jpa
User: sysdba
Database: Firebird 2.0*WI-V2.0.0.12748 Firebird 2.0/tcp (dev)/P10 Version: WI-V2.0.0.12748 Firebird 2.0*WI-V2.0.0.12748 Firebird 2.0/tcp (dev)/P10
Driver: Jaybird JCA/JDBC driver Version: 2.1|#]
[#|2007-02-26T08:18:15.562+0100|CONFIG|sun-appserver9.1|oracle.toplink.essentials.session.file:/C:/apps/glassfish/domains/domain1/applications/j2ee-modules/firebird-web/WEB-INF/lib
/firebird.jar-firebird.connection|_ThreadID=14;_ThreadName=Thread-24;|connecting(DatabaseLogin(
platform=>DatabasePlatform
user name=> ""
connector=>JNDIConnector datasource name=>null
))|#]
[#|2007-02-26T08:18:15.562+0100|CONFIG|sun-appserver9.1|oracle.toplink.essentials.session.file:/C:/apps/glassfish/domains/domain1/applications/j2ee-modules/firebird-web/WEB-INF/lib
/firebird.jar-firebird.connection|_ThreadID=14;_ThreadName=Thread-24;|Connected: jdbc:firebirdsql:java://localhost/glassfish-jpa
User: sysdba
Database: Firebird 2.0*WI-V2.0.0.12748 Firebird 2.0/tcp (dev)/P10 Version: WI-V2.0.0.12748 Firebird 2.0*WI-V2.0.0.12748 Firebird 2.0/tcp (dev)/P10
Driver: Jaybird JCA/JDBC driver Version: 2.1|#]
, czyli działa! A zatem na dzisiaj koniec.
Problemy
Najczęstszy to brak pamięci, który pojawia się pracując z plikami XML w tak "rozszerzonym" Eclipse IDE. Być może zwiększenie pamięci naprawiłoby problem, ale nie chciało mi się szukać.
I drugi, równie bolesny, to utrata stanu GlassFish przez wtyczkę GlassFish Eclipse plugin, kiedy w trakcie zatrzymywania serwera próbowałem uruchomić go ponownie. Rozwiązanie okazało się wymagające monitorowania stanu GF - podgląd dziennika zdarzeń GF ($GLASSFISH_HOME/domains/domain1/logs/server.log). Możemy uruchomić GF dopiero po pojawieniu się następujących wpisów w dzienniku zdarzeń:
[#|2007-02-26T08:19:39.796+0100|INFO|sun-appserver9.1|javax.enterprise.system.core|_ThreadID=15;_ThreadName=RMI TCP Connection(6)-127.0.0.1;|CORE5052: Application shutdown complete
.|#]
[#|2007-02-26T08:19:40.109+0100|INFO|sun-appserver9.1|javax.enterprise.system.tools.deployment|_ThreadID=15;_ThreadName=RMI TCP Connection(6)-127.0.0.1;|[AutoDeploy] Disabling Auto
Deployment service.|#]
Wcześniejsza próba uruchomienia będzie objawiała się tym, że Eclipse będzie raportował o próbie uruchomienia GF (Status=Starting...)
mimo, że tak na prawdę nie kontroluje GF i komunikat będzie trwał i trwał. Jedynym wyjściem wydaje się być zatrzymanie serwera z poziomu Eclipse IDE (tj. wciśnięcie ikony w postaci czerwonego kwadratu) i ponowne jego uruchomienie.
Czasami podczas uaktualniania aplikacji (ponownej jej instalacji na serwerze) pojawiał się błąd:
Buildfile: C:\.eclipse\jpa\.metadata\.plugins\org.eclipse.jst.server.generic.core\serverdef\sunappsrv-ant.xml
deploy.j2ee.web:
[echo] C:/.eclipse/jpa/.metadata/.plugins/org.eclipse.wst.server.core/tmp0/firebird-web
[jar] Building jar: C:\.eclipse\jpa\.metadata\.plugins\org.eclipse.jst.server.generic.core\serverdef\firebird-web.war
tools:
deploy:
[exec] Command deploy executed successfully with following warning messages: WARNING:
[exec] The following file(s) were left(locked) from the previous deployment; they were not updated during this deployment and could interfere with the application:
[exec] C:\apps\glassfish\domains\domain1\applications\j2ee-modules\firebird-web\WEB-INF\lib\firebird.jar
deploy-url-message:
[echo] Application Deployed at: http://127.0.0.1:8080/firebird-web
BUILD SUCCESSFUL
Total time: 4 seconds
co obchodzimy przez zatrzymanie GF i ponowne uruchomienie.
Skłaniam się ku stwierdzeniu, że najmniej uciążliwym sposobem uaktualnienia aplikacji na serwerze GlassFish z użyciem wtyczki GlassFish Eclipse plugin jest po prostu zatrzymywanie serwera i jej instalacja za pomocą menu kontekstowego Publish (co automatycznie uruchomi również serwer, jeśli zatrzymany).
25 lutego 2007
Eclipse Mylar - JIRA, Bugzilla i Trac w Eclipse 3.3
Ale się ucieszyłem! W końcu jest! Eclipse Mylar 2.0M1 działa w mojej instalacji Eclipse IDE 3.3m5eh. Walczyłem z tym przez ponad 2 tygodnie (wcześniej z poprzednimi wersjami 3.3) szukając rozwiązania po wszystkich forach, systemach zarządzania zgłoszeniami, próbując różnych konfiguracji Eclipse IDE oraz wtyczek, itp. Byłem już bliski śledzenia wykonywania (ang. debugging) wtyczki, aż wczoraj, ot tak przypadkiem, bliski zrezygnowania z Mylar, zauważyłem, że Eclipse korzysta z pliku jvm.dll z katalogu C:/Program Files/Java/jre1.4.2_13 (można to zobaczyć w Help->About Eclipse SDK->Configuration Details, a tam parametr -vm, który teraz po zmianie wskazuje na C:\apps\jre5\bin\client\jvm.dll).
Jeszcze w sobotę, znalazłem informację o wymaganiach Eclipse Dali (inna wtyczka, która nie chce współpracować), gdzie wyraźnie zaznaczono, że wymagane jest uruchomienie Eclipse z Java 5, aby funkcjonalność JPA działała poprawnie (czytaj: w ogóle była dostępna). Ta informacja, problemy z Mylar i fakt, że w zasadzie Java 1.4.2 nie była mi już potrzebna, sprawiły, że zdecydowałem się usunąć Java 1.4.2 całkowicie.
Jakież było moje zdumienie, kiedy po ponownym uruchomieniu komputera i uruchomieniu Eclipse zobaczyłem Help->Mylar UI Legend

, czy Window->Open Perspective->Other...->Planning

, nowe widoki w kategorii Mylar i Mylar Sandbox

, czy w końcu nowa ikona w widoku Package Explorer.

A skąd tyle zainteresowania i uporu w uruchomieniu wtyczki Mylar?! To wiedziałem jeszcze zanim działała mi wtyczka. Zarządzanie zgłoszeniami w dowolnym systemie zgłoszeń (JIRA, BugZilla, czy Trac) to praca z przeglądarką - wyszukiwanie zgłoszenia, pobranie poprawki (łaty, ang. patch), jeśli dostępna, dołączenie do projektu, kompilacja, nierzadko poprawa samej poprawki, zmiana stanu zgłoszenia, tworzenie poprawki, itp. Gdybym mógł zarządzać zgłoszeniami z poziomu środowiska IDE (przy projektach Apache Geronimo i Apache OpenEJB jest to JIRA) zdecydowanie ułatwiłoby mi to pracę (i być może znalazłbym go więcej dla nich ;-)). Po przejrzeniu prezentacji na temat Mylar - Webinar: Task-Focused Programming with Mylar i poznaniu oferowanych możliwości, np. możliwość włączenia poprawki do projektu z poziomu Eclipse, nie mogę uwierzyć, że tak mało pisze się o nim. Przecież to powinna być wtyczka na stanie każdego programisty korzystającego z Eclipse IDE (!) Poza wtyczkami WTP, TestNG, Subclipse/Subversive, Spring IDE, JBoss IDE, Apache Geronimo, GlassFish, Groovy i zapewne kilku innych, wtyczka Eclipse Mylar stała się dla mnie numerem 1. Po wydaniu nowej wersji rozwojowej WTP (z Eclipse Dali jako narzędzie JPA) praca z Eclipse staje się niezwykle ciekawa i prostsza (myli się jednak ten, kto myśli, że NetBeans IDE jest daleko w tyle! Ostatnia wersja NetBeans IDE 6.0 m7 to...może następnym razem. Pora na Mylar!).
Jeszcze w sobotę, znalazłem informację o wymaganiach Eclipse Dali (inna wtyczka, która nie chce współpracować), gdzie wyraźnie zaznaczono, że wymagane jest uruchomienie Eclipse z Java 5, aby funkcjonalność JPA działała poprawnie (czytaj: w ogóle była dostępna). Ta informacja, problemy z Mylar i fakt, że w zasadzie Java 1.4.2 nie była mi już potrzebna, sprawiły, że zdecydowałem się usunąć Java 1.4.2 całkowicie.
Jakież było moje zdumienie, kiedy po ponownym uruchomieniu komputera i uruchomieniu Eclipse zobaczyłem Help->Mylar UI Legend

, czy Window->Open Perspective->Other...->Planning
, nowe widoki w kategorii Mylar i Mylar Sandbox
, czy w końcu nowa ikona w widoku Package Explorer.
A skąd tyle zainteresowania i uporu w uruchomieniu wtyczki Mylar?! To wiedziałem jeszcze zanim działała mi wtyczka. Zarządzanie zgłoszeniami w dowolnym systemie zgłoszeń (JIRA, BugZilla, czy Trac) to praca z przeglądarką - wyszukiwanie zgłoszenia, pobranie poprawki (łaty, ang. patch), jeśli dostępna, dołączenie do projektu, kompilacja, nierzadko poprawa samej poprawki, zmiana stanu zgłoszenia, tworzenie poprawki, itp. Gdybym mógł zarządzać zgłoszeniami z poziomu środowiska IDE (przy projektach Apache Geronimo i Apache OpenEJB jest to JIRA) zdecydowanie ułatwiłoby mi to pracę (i być może znalazłbym go więcej dla nich ;-)). Po przejrzeniu prezentacji na temat Mylar - Webinar: Task-Focused Programming with Mylar i poznaniu oferowanych możliwości, np. możliwość włączenia poprawki do projektu z poziomu Eclipse, nie mogę uwierzyć, że tak mało pisze się o nim. Przecież to powinna być wtyczka na stanie każdego programisty korzystającego z Eclipse IDE (!) Poza wtyczkami WTP, TestNG, Subclipse/Subversive, Spring IDE, JBoss IDE, Apache Geronimo, GlassFish, Groovy i zapewne kilku innych, wtyczka Eclipse Mylar stała się dla mnie numerem 1. Po wydaniu nowej wersji rozwojowej WTP (z Eclipse Dali jako narzędzie JPA) praca z Eclipse staje się niezwykle ciekawa i prostsza (myli się jednak ten, kto myśli, że NetBeans IDE jest daleko w tyle! Ostatnia wersja NetBeans IDE 6.0 m7 to...może następnym razem. Pora na Mylar!).
Subskrybuj:
Posty (Atom)