academe Spezifikationen Datenformate, Schnittstellen und Administrationsumgebung Autor Piero Altomare, addoit GmBH

Transkript

1 academe Spezifikationen Datenformate, Schnittstellen und Administrationsumgebung Autor Piero Altomare, addoit GmBH Copyright 2014

2 Inhaltsverzeichnis D6.1.1 Datenformate 3 D6.1.2 Schnittstellen 3 Java Interface Header Implementation 3 D6.1.1 Administrationsumgebung 9

3 D6.1.1 Datenformate Da momentan keine Datendokumente direkt mit anderen Fremdsystemen ausgetauscht werden müssen, entfällt diese Spezifikation. Der Datenaustausch findet nur über die Webservice-Schnittstelle statt. Für die Flashkartengenerierung wird das HTML Format verwendet. Um eine optimale Qualität beim Endnutzer zu gewährleisten, werden die Flashkarten vor der Synchronisation von HTML in das PDF Format umgewandelt. Die Binaries und die Indexierung der Flashkarten werden in eine SQL Datenbank abgelegt. Die SQLite Datenbank des mobilen Endgeräts dient der individuellen Speicherung. D6.1.2 Schnittstellen Unter wird die Metabeschreibung der WS Schnittstelle angezeigt. Über eine DotNet Umgebung (Visual Studio) oder Eclipse (Java wsconsum) oder C++ mit gsoap (wsdl2h & soapcpp2) können die Wrapper Klassen generiert werden. Die Dokumentationen im File Format lauten: ElasFacadeService.wsdl, ElasFacadeService_schema1.xsd und ElasFacadeService_schema2.xsd). Java Interface Header Implementation public interface ServiceDataManager { / The consumer checks if the given address of the service String String String String PingToken public PingToken ping(string language, String userid, String deviceid, String timeentry) throws ServiceDataManagerException; 3 / The consumer deletes a registered device from the running list All related data to this device becomes String String String String String RegisterToken public RegisterToken deletedevice(string language, String useruid, String deviceid, String sessionuid, String secretword) throws ServiceDataManagerException;

4 / The consumer starts a device registration procedure This is the first call Due to the received session id the registration status can be String String String String String String String String RegisterToken public RegisterToken registerdevice(string language, String organisationaddress, String , String deviceid, String deviceos, String deviceversion, String deviceip, String devicename) throws ServiceDataManagerException; / In dependency of the authentication process on the server the consumer has to send the profile data over this String String String String RegisterToken public RegisterToken isdeviceregistered(string language, String campusuid, String useruid, String deviceid, String registeruid) throws ServiceDataManagerException; 4 / As soon as the device is well configured in the running list on the portal (password confirmation) the consumer has to use the login method each time before dealing with String String String String String LoginToken public LoginToken login(string language, String campusuid, String useruid, String deviceid, String registeruid, String secretword) throws ServiceDataManagerException;

5 / To ensure that all the running resources become released, it is recommended to log-out after working on the String String String String String LoginToken public LoginToken logout(string language, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; / As soon as the device is registered and the consumer has confirmed the password an initial data set will be sent to the String String String String String String DataSyncToken public DataSyncToken downloadlastinitcampusdb(string language, String packagedataversion, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; 5 / Optionally, a new initial data set can be String String String String String String String DataSyncToken public DataSyncToken downloadinitcampusdb(string language, String packagedataversion, String spec- PackageName, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException;

6 / This method ensures the retrieval of the actual data on the device as soon as the packaging process creates and assembles a new data package version of the String String String String String String String DataSyncToken public DataSyncToken updateinitcampusdb(string language, String packagedataversion, String lastpackagename, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; / To ensure that the data are up 2 String String String String String String String String String String DataQueryToken public DataQueryToken querypackagedata(string language, String packagedataversion, String packagename, String moduleuid, String lessontype, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; 6 / Retrieval of a specific data package String String String String String String String String String String String String String String DataSyncToken

7 public DataSyncToken downloadpackagedata(string language, String packagedataversion, String packagename, String packagetimestamp, String datatimestamp, String storagefolder, String objectfolder, String datafile, String dataextension, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; / This handles a consumer String VotingToken String String String String String sessionuid public VotingToken vote( String language, VotingToken vote, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; / This handles a consumer MessageToken sessionuid public MessageToken message(string language, MessageToken msg, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; 7 / This informs the consumer about push messaging waiting (push and gamification service PushInfoToken sessionuid public PushInfoToken pushinfo(string language, PushInfoToken pshinfo, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException;

8 / Data exchange over the push channel (push and gamification service PushMsgToken sessionuid public PushMsgToken pushinfo(string language, PushMsgToken pshmsg, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; / This removes the push messaging from the list (push and gamification service PushToken sessionuid public PushToken push(string language, PushToken psg, String campusuid, String useruid, String deviceid, String registeruid, String sessionuid) throws ServiceDataManagerException; 8

9 D6.1.1 Administrationsumgebung Die Web UI Admin Konsole gehört nicht zu den definierten Workpackage des academe Projekts. Die Konsole entstand aus dem Bedürfnis, das laufende Portal mit geringem Aufwand zu betreiben. Für die Entwicklung des Web Interfaces und der App wurde die Web UI Admin Konsole unvermeidlich. Die Mehrheit der Funktionen unterstützen die Entwickler und stehen nicht für die Anwender von academe zur Verfügung. Einzig die Benutzer und die Registrierungsübersicht der Geräte sind online verwaltbar. 9 Abbildung 1: Benutzerverwaltung Abbildung 2: Registrierungsübersicht der Geräte