Versions Compared

Old Version 4

changes.mady.by.user Unknown User (admin)

Saved on

compared with

New Version Current

changes.mady.by.user Tomasz Parkoła

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Zastrzeżenia

Warning
titlePRZED ROZPOCZĘCIEM KORZYSTANIA Z INTERFEJSU PROGRAMISTYCZNEGO SERWERA dLibra PROSIMY O DOKŁADNE ZAPOZNANIE SIĘ Z PONIŻSZYMI INFORMACJAMI!
  • Podstawowym warunkiem wykorzystania interfejsu programistycznego serwera jest posiadanie licencji na oprogramowanie dLibra.
  • Interfejs programistyczny nie może być wykorzystywany do celów komercyjnych bez uzyskania pisemnej zgody IChB PAN PCSS. Możliwe jest natomiast nieodpłatne udostępnianie aplikacji zrealizowanych z wykorzystaniem tego interfejsu innym licencjobiorcom systemu dLibra.
  • Niewłaściwe wykorzystanie interfejsu programistycznego może doprowadzić do niepoprawnego czy niestabilnego działania biblioteki cyfrowej, do całkowitej utraty danych zgromadzonych w takiej bibliotece lub nawet do awarii sprzętu, na którym uruchomiona jest biblioteka cyfrowa. W związku z tym IChB PAN PCSS nie bierze żadnej odpowiedzialności za skutki wynikłe z używania aplikacji wykorzystujących interfejs programistyczny serwera dLibra.

Podstawowe informacje

Interfejs programistyczny (API) serwera dLibra pozwala na tworzenie aplikacji współpracujących bezpośrednio z serwerem biblioteki cyfrowej opartej na systemie dLibra. Interfejs ten jest zrealizowany w języku Java (wersja 1.5), a komunikacja odbywa się przy pomocy protokołu Java RMI. Mogą to być na przykład bardzo proste aplikacje raportujące lub bardziej złożone aplikacje klienckie. Przykładami takich aplikacji są aplikacje redaktora, administratora i czytelnika dostarczane wraz z serwerem systemu dLibra.

Dokumentacja techniczna API serwera w postaci JavaDoc dostępna jest w repozytorium dystrybucji projektu dLibra, w którym znajdują się również pakiety instalacyjne dLibry. Dokumentacja znajduje się w podkatalogu numer-wersji/api/numer-wydania, czyli np. 4.0/api/4.0.3 i podzielona jest na następujące moduły:

  • dlibra-common - zawiera klasy i interfejsy API serwera dLibry.
  • dlibra-common-util - zawiera klasy i interfejsy pomocnicze, wymagane przez API serwera dLibry.

W celu uzyskania dostępu do repozytorium prosimy o kontakt.

Przykłady kodu

Osoby zainteresowane przykładami (fragmentami kodu Java) pokazującymi wykorzystanie API serwera systemu dLibra lub mające problemy z wykorzystaniem API prosimy o kontakt

Od momentu wydania wersji 3.0 oprogramowania dLibra na tej stronie dostępna będzie dokumentacja techniczna interfejsu komunikacyjnego serwera systemu dLibra. Dokumentacja ta pozwoli na dobudowywanie własnych rozszerzeń do serwera takich jak np. modułu statystyk czy specjalne aplikacje do masowego ładowania publikacji. Dokumentacja dostępna będzie w postaci:

  • automatycznie generowanej dokumentacji technicznej Javadoc
    oraz
  • krótkich przykładów programistycznych pokazujących wykorzystanie podstawowych funkcji interfejsu komunikacyjnego serwera.

Na tej stronie będzie można również udostępniać innym użytkownikom samodzielnie stworzone rozszerzenia systemu dLibra.

Zapraszamy do odwiedzenia tej strony w styczniu 2007 roku.

System dLibra opracowywany jest w języku Java(tm) w wersji 1.5.