Ohjelmointirajapintapalvelun toteuttaminen tietoverkossa

Abstract

Tässä opinnäytetyössä suunniteltiin ja toteutettiin ohjelmointirajapinta joka mahdollistaa mySync-palvelun hallinnoinnin tietoverkon kautta. Rajapintaa käyttäen palvelun käyttäjät voivat rakentaa omia käyttöliittymiä tai muita työkaluja palvelun hallinnointiin.

Ohjelmointirajapinta toteutettiin REST-arkkitehtuurityylin mukaisesti. Rajapintapalvelu toimii muiden mySync-palveluiden tavoin Java Servlet -palvelimella. Palvelun toteutuksessa käytettiin Restlet-sovelluskehystä, joka hoitaa HTTP-kommunikoinnin perustasolla. Sovelluskehyksen ja arkkitehtuurityylin mukaisesti toteutettiin resurssiluokkia, jotka suorittavat rajapinnan käyttäjän pyytämät toiminnot.

Palvelu käyttää kommunikoinnissa XML-tietorakenteita. Tietorakenteet luodaan pääosin automatisoidusti käyttäen XStream-kirjastoa, joka muuntaa Java-objekteja XML-tietorakenteiksi ja päin vastoin.

Ohjelmointirajapintapalveluun saatiin toteutettua kaikki halutut ominaisuudet, ja se on aktiivisessa tuotantokäytössä.

The subject of this thesis was to desing and implement an application programming interface that enables managing of the mySync-service via data networks. By using this interface, the users of the service can create their own user interfaces or other tools to manage the service.

The application programming interface was designed according to the RESTful architectural style. The interface service operates on a Java Servlet server among other mySync service parts. The service was implemented using the Restlet software framework, which manages basic HTTP communication. Resource classes were implemented according with the framework and the RESTful style to perform the tasks requested by users.

The service uses XML structures to communicate with client applications. The structures are created mainly using automated tools, specifically the XStream library, which transforms Java objects to XML structures and back.

The application programming interface service was implemented with all requirements met and it is in active usage.