de.xima.fc.interfaces.plugin.param.servlet

Interface IPluginServletActionParams

All Superinterfaces:

IPluginParameters, Serializable

All Known Implementing Classes:

PluginServletActionParams

public interface IPluginServletActionParams
extends IPluginParameters, Serializable

Interface welches die Parameter für Plugins vom Typ Servlet-Action kapselt

Author:

xima media GmbH, Dresden - Michael Kohlsche - 24.08.2015

Method Summary

Modifier and Type	Method and Description
EServletAction	getAction() Getter für den Typ des Servlet-Aufrufs
Benutzer	getBenutzer() Getter für den Benutzer aus der XfcSession mit welcher das Plugin-Servlet aufgerufen wird.
FrontendServer	getFrontendServer() Getter für den FrontendServer.
Map<String,String>	getHeaderMap() Getter für die Map der Header-Parameter
Locale	getLocale() Getter für das ggf. ermittelte oder standard-Locale
Mandant	getPluginClient() Getting the client in which context the plug-in is executed.
Map<String,List<String>>	getRequestParameters() Getter für die Request-Parameter.
Map<String,Serializable>	getSessionAttributeMap() Getter für das Objekt mit allen verfügbaren POJO-Session-Attribute
SessionAttributes	getSessionAttributes() Deprecated. use getSessionAttributeMap()
String	getSessionID() Getting the session ID for the currently logged in user.
Map<String,List<FileData>>	getUploadFiles() Getter für alle hochgeladenen Dateien aus dem Request
ValueParameters	getValueParameters() Deprecated. use getRequestParameters()

Method Detail

getSessionAttributeMap

Map<String,Serializable> getSessionAttributeMap()

Getter für das Objekt mit allen verfügbaren POJO-Session-Attribute

Returns:

Map mit Session-Attributen

Since:

5.0

getBenutzer

Benutzer getBenutzer()

Getter für den Benutzer aus der XfcSession mit welcher das Plugin-Servlet aufgerufen wird.

Returns:

Benutzer aus der aktuellen XfcSession

Since:

5.0

getRequestParameters

Map<String,List<String>> getRequestParameters()

Getter für die Request-Parameter.

Returns:

Map mit den Request-Parametern

getUploadFiles

Map<String,List<FileData>> getUploadFiles()

Getter für alle hochgeladenen Dateien aus dem Request

Returns:

getLocale

Locale getLocale()

Getter für das ggf. ermittelte oder standard-Locale

Returns:

Locale das Locale

getAction

EServletAction getAction()

Getter für den Typ des Servlet-Aufrufs

Returns:

EServletAction der Typ

getHeaderMap

Map<String,String> getHeaderMap()

Getter für die Map der Header-Parameter

Returns:

Map der Header-Parameter

getFrontendServer

FrontendServer getFrontendServer()

Getter für den FrontendServer.

Returns:

FrontendServer

getSessionID

String getSessionID()

Getting the session ID for the currently logged in user. In case no session and hence no session ID is available null will be returned

Returns:

the session ID for the logged in user

Since:

5.1.0

getPluginClient

Mandant getPluginClient()

Getting the client in which context the plug-in is executed. The client can be null in case the plug-in is a system plugin and runs in an client independend context.

Returns:

the client object or null

Since:

5.1.0

getSessionAttributes

@Deprecated
SessionAttributes getSessionAttributes()

Deprecated. use getSessionAttributeMap()

getValueParameters

@Deprecated
ValueParameters getValueParameters()

Deprecated. use getRequestParameters()

Getter für die Request-Parameter. Diese beinhalten keine Uploads!

Returns:

ValueParameters die Request-Parameter