Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 377.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 368.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.tleu
1 +XWiki.sandra_riediger
Inhalt
... ... @@ -60,9 +60,7 @@
60 60  |(((
61 61  getResultValues
62 62  )))|(((
63 -Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung:
64 -
65 -Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
63 +Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
66 66  )))
67 67  |(% colspan="1" %)(% colspan="1" %)
68 68  (((
... ... @@ -209,33 +209,173 @@
209 209  }
210 210  {{/code}}
211 211  
212 -{{code title="Initialisierung durch LMS" language="xml"}}
213 -@WebMethod(operationName = „initiateSite")
214 -public String initiateSite(
210 +== Abmeldung durch LMS ==
211 +
212 +Abfrage von Lernerresultaten durch LMS
213 +
214 +{{code}}
215 +@WebMethod(operationName = „disarmSite")
216 +public Boolean disarmSite(
215 215  @WebParam(name = „version") final Integer version,
216 216  @WebParam(name = „sessionId") final String sessionId,
217 217  @WebParam(name = „secretToShare") final String secretToShare,
218 -@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
219 -@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
220 220  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
221 221  }
222 222  {{/code}}
223 +
224 +
225 +
226 +=== Parameter disarmSite ===
227 +
228 +|(((
229 +version
230 +)))|(((
231 +Angefragte Version: 1
232 +)))
233 +|(% colspan="1" %)(% colspan="1" %)
234 +(((
235 +sessionId
236 +)))|(% colspan="1" %)(% colspan="1" %)
237 +(((
238 +SessionId, wie von armSite zurück geliefert.
239 +)))
240 +|(((
241 +secretToShare
242 +)))|(((
243 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
244 +)))
245 +|(((
246 +additionalParams
247 +)))|(((
248 +Reserved for future use.
249 +)))
250 +
251 +=== ReturnValue disarmSite ===
252 +
253 +|(((
254 +Boolean
255 +)))|(((
256 +True bei Erfolg, sonst false.
257 +)))
258 +
259 +== Abfrage von Lernerresultaten durch LMS ==
260 +
261 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
262 + @WebMethod(operationName = „getResultValues")
263 +public HashMapWrapper getResultValues(
264 + @WebParam(name = „version") final Integer version,
265 + @WebParam(name = „sessionId") final String sessionId,
266 + @WebParam(name = „secretToShare") final String secretToShare,
267 + @WebParam(name = „requestedValues") final HashMap<String, String>
268 + requestedValues,
269 + @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
270 +}
271 +{{/code}}
272 +
273 +=== Parameter getResultValues ===
274 +
275 +|(((
276 +version
277 +)))|(((
278 +Angefragte Version: 1
279 +)))
280 +|(% colspan="1" %)(% colspan="1" %)
281 +(((
282 +sessionId
283 +)))|(% colspan="1" %)(% colspan="1" %)
284 +(((
285 +SessionId, wie von armSite zurück geliefert.
286 +)))
287 +|(((
288 +secretToShare
289 +)))|(((
290 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
291 +)))
292 +|(((
293 +requestedValues
294 +)))|(((
295 +Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
296 +)))
297 +|(((
298 +additionalParams
299 +)))|(((
300 +Reserved for future use.
301 +)))
302 +
303 +=== ReturnValue getResultValues ===
304 +
305 +|(((
306 +HashMap<String, String>
307 +)))|(((
308 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
309 +)))
310 +
311 +== Abfrage von Ergebnisvariablen durch LMS ==
312 +
313 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
314 + @WebMethod(operationName = „getResultVariables")
315 +public HashMapWrapper getResultVariables(
316 +@WebParam(name = „version") final Integer version,
317 +@WebParam(name = „contentPackage") final byte[] contentPackage,
318 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
319 +}
320 +{{/code}}
321 +
322 +=== Parameter getResultVariables ===
323 +
324 +|(((
325 +version
326 +)))|(((
327 +Angefragte Version: 1
328 +)))
329 +|(((
330 +contentPackage
331 +)))|(((
332 +Content Package (gezippt) als Byte-Array.
333 +)))
334 +|(((
335 +additionalParams
336 +)))|(((
337 +Reserved for future use.
338 +)))
339 +
340 +=== ReturnValue getResultVariables ===
341 +
342 +|(((
343 +HashMap<String, String>
344 +)))|(((
345 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
346 +)))
347 +
348 +== Wrapper ==
349 +
350 +Da die Übertragung von Maps und Listen über JAX-WS Probleme macht (clientseitig gefüllte Listen werden leer über den WS versandt und kommen daher auch leer serverseitig an), müssen diese gewrappt werden.
351 +
352 +=== Wrapper für die HashMap<String, String> ===
353 +
354 +HashMapWrapper.java:
355 +
356 +[[image:attach:HashMapWrapperjava.png]]
357 +
358 +[[image:attach:HashMapWrapperjava2.png]]
359 +
360 +=== Wrapper für die ArrayList<ResultsForStudent> ===
361 +
362 +ResultsForStudentsWrapper.java:
363 +
364 +[[image:attach:ResultsForStudentsWrapperjava.png]]
223 223  {{/layout-cell}}
224 224  {{/layout-section}}
225 225  
226 226  {{layout-section ac:type="two_right_sidebar"}}
227 227  {{layout-cell}}
228 -====== untergeordnete Seiten: ======
229 -
230 -
231 -
232 -{{children all="true"/}}
370 +
233 233  {{/layout-cell}}
234 234  
235 235  {{layout-cell}}
236 236  ====== relevante Links: ======
237 237  
238 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
376 +* [[doc:Schnittstelle ONYX WebPlayer]]
239 239  {{/layout-cell}}
240 240  {{/layout-section}}
241 241  {{/layout}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342394
1 +3342789
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342394/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342789/Schnittstelle ONYX Reporter