Servlet-Aktion

Inhalt [ Verbergen ]

IPluginServletAction

Verwendungsmöglichkeiten

Einordnung des Servlet-Plugins in die Prozesskette von Xima® Formcycle

Das Plugin dient der Servlet-bezogenen Auslieferung eigener Inhalte.

Hinweis

Der Aufruf der Plugin-Servlet-Implementierung erfolgt über das folgende URL-Pattern.
http://<Webdomain>/<FORMCYCLE-Webapplikation>/plugin/?name=<Name der IPluginServletAction-Implementierung>&client-id=<MandantId>
Anstatt des Parameters client-id, kann auch der Parameter project-id angegeben werden. Bei Angabe der project-id wird das für die Verarbeitung notwendige Mandant-Objekt aus dem ermittelten Projekt-Objekt bezogen.

Methodesignaturen

Die Plugin-Schnittstelle IPluginServletAction referenziert alle durch die Basis-Schnittstelle IFCPlugin bereitgestellten Methoden
und zusätzlich noch folgende Plugin-spezifische Methodensignaturen:

IPluginServletActionRetVal execute(IPluginServletActionParams params) throws FCPluginException

Übergabewerte: Der Typ IPluginServletActionParams stellt folgende Eigenschaften bereit:
  • getRequestParameters(): eine Map mit den aktuell übergebenen Request-Parametern (ohne Uploads)
  • getUploadFiles(): eine Map mit allen hochgeladenen Dateien aus dem Request
  • getHeaderMap(): eine Map mit den Header-Informationen aus dem Request
  • getBenutzer(): der aktuell in der Session referenziert Benutzer
  • getSessionAttributeMap(): die aktuell in der Session vorhandenen Parameter
  • getLocale(): Informationen zur aktuell gesetzten Sprache und Region
  • getFrontend-Server(): Verweis auf den Frontend-Server, wenn Servlet-Plugin über Frontend-Server aufgerufen wurde
  • getAction(): Typ des Servlet-Aufrufs
Rückgabewerte: Der Rückgabewert muss vom Typ IPluginServletActionRetVal sein, eine Referenzimplementierung wird durch die Klasse PluginServletActionRetVal bereitgestellt.Das Objekt ermöglicht die Rückgabe eines Objektes vom Typ IServletResponse, welches die Möglichkeit bietet einen einfachen String, aber auch Binärdaten an den Browser auszuliefern. Über die Bestimmung des Response-Typs am IServletResponse-Objekt wird festgelegt, wie die übergebenen Response-Daten interpretiert bzw. ausgeliefert werden:
Response-TypBeschreibung
HTMLDer übergebene Response-String wird als fertiges HTML interpretiert und an den Browser ausgeliefert.
SHOW_FILEDie übergeben Daten (Binärdaten und Response-String) werden als Dateidownload an den Browser ausgeliefert, wo der Inhalt des Response-Strings als Dateinamen interpretiert wird.
TEMPLATEEs wird ein neues HTML-Dokument erzeugt under der übergebene Response-String als Inhalt des body-Elements genommen.
TEMPLATE_SYSTEMDerzeit identisch zu TEMPLATE.
WEITERLEITUNGDer übergebene Response-String wird als URL interpretiert und einen Weiterleitung wird durchgeführt.
Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen.