Servlet-Aktion
IPluginServletAction
Verwendungsmöglichkeiten
Das Plugin dient der Servlet-bezogenen Auslieferung eigener Inhalte.
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:
Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen.
- 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
Response-Typ | Beschreibung |
---|---|
HTML | Der übergebene Response-String wird als fertiges HTML interpretiert und an den Browser ausgeliefert. |
SHOW_FILE | Die übergeben Daten (Binärdaten und Response-String) werden als Dateidownload an den Browser ausgeliefert, wo der Inhalt des Response-Strings als Dateinamen interpretiert wird. |
TEMPLATE | Es wird ein neues HTML-Dokument erzeugt under der übergebene Response-String als Inhalt des body-Elements genommen. |
TEMPLATE_SYSTEM | Derzeit identisch zu TEMPLATE. |
WEITERLEITUNG | Der übergebene Response-String wird als URL interpretiert und einen Weiterleitung wird durchgeführt. |