Package de.fhdw.hfw417.dokumentenpostfach.controller

Class DokumentController

java.lang.Object

de.fhdw.hfw417.dokumentenpostfach.controller.DokumentController

@Path("/dokument")
@Component
public class DokumentController
extends Object

Controller-Klasse zu DokumentService. Enthaelt die Schnittstellen, mit denen auf das System zugegriffen werden sollte

Constructor Summary

Constructors

Constructor	Description
DokumentController(DokumentService dokumentService)	Konstruktor fuer die REST-Schnittstelle, um Dokumente zu erstellen.

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	erstelleDokument(DokumentEinstellenDTO dokumentEinstellenDTO)	Erstellt ein Dokument und speichert diese im System ab.
javax.ws.rs.core.Response	getAllDokumente()	Liefert alle Dokumente, die in dem System gespeichert worden sind.
javax.ws.rs.core.Response	getDocumentById(String id)	Liefert das Dokument mit der entsprechenden Identifikationsnummer Falls unter der angegebenen id kein Dokument vorhanden ist, wird eine Exception geworfen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DokumentController

public DokumentController(DokumentService dokumentService)

Konstruktor fuer die REST-Schnittstelle, um Dokumente zu erstellen.

Parameters:

dokumentService - Dokument Service

Method Detail

erstelleDokument

@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response erstelleDokument(DokumentEinstellenDTO dokumentEinstellenDTO)
                                           throws PortalDocException

Erstellt ein Dokument und speichert diese im System ab. Die ID der Dokumente wird vom System gesetzt.

Parameters:

dokumentEinstellenDTO - muss eine vollständiges Dokument darstellen. Muss alle Attribute nicht generierten Attribute aufweisen.

Returns:

DokumentEinstellenDTO in JSON-Notation, falls das Dokument erfolgreich erstellt worden ist.

Throws:

PortalDocException - wirft diesen Fehler

getAllDokumente

@GET
@Produces("application/json")
public javax.ws.rs.core.Response getAllDokumente()
                                          throws PortalDocException

Liefert alle Dokumente, die in dem System gespeichert worden sind. Falls keine Dokumente gefunden werden, wird eine leere Liste zurueckgegeben.

Returns:

Liste von DokumentEinstellenDTO-Objekten in JSON-Notation

Throws:

PortalDocException - wirft diesen Fehler

getDocumentById

@GET
@Path("/{id}")
@Produces("application/json")
public javax.ws.rs.core.Response getDocumentById(@PathParam("id")
                                                 String id)
                                          throws PortalDocException

Liefert das Dokument mit der entsprechenden Identifikationsnummer Falls unter der angegebenen id kein Dokument vorhanden ist, wird eine Exception geworfen.

Parameters:

id - Identifikationsnummer des Dokuments, die zurueckgegeben werden soll.

Returns:

DokumentEinstellenDTO in JSON-Notation

Throws:

PortalDocException - wirft diesen Fehler