de.xima.fc.plugin.models.params.servlet

Class PluginServletActionParams

java.lang.Object

de.xima.fc.plugin.models.params.servlet.PluginServletActionParams

All Implemented Interfaces:

IPluginParameters, IPluginServletActionParams, Serializable

public class PluginServletActionParams
extends Object
implements IPluginServletActionParams

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginServletActionParams(Map<String,Serializable> sessionAttributes, Map<String,List<String>> valueParameter, Map<String,List<FileData>> uploadFiles, Benutzer benutzer, Locale locale, EServletAction action, Map<String,String> headerMap, FrontendServer fs) Deprecated. since 5.1.0 use PluginServletActionParams(Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)
PluginServletActionParams(Map<String,Serializable> sessionAttributes, Map<String,List<String>> valueParameter, Map<String,List<FileData>> uploadFiles, Benutzer benutzer, Locale locale, EServletAction action, Map<String,String> headerMap, FrontendServer fs, Mandant client, String sessionId) Constuctor for creating a parameters object with all necessary request data
PluginServletActionParams(SessionAttributes sessionAttributes, HashMap<String,List<String>> valueParameter, HashMap<String,List<FileData>> uploadFiles, Locale locale, EServletAction action, Map<String,String> headerMap, FrontendServer fs) Deprecated. use #PluginServletActionParams(Map, HashMap, HashMap, Benutzer, Locale, EServletAction, Map, FrontendServer)

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() Deprecated.
SessionAttributes	getSessionAttributes() Deprecated.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginServletActionParams

@Deprecated
public PluginServletActionParams(SessionAttributes sessionAttributes,
                                             HashMap<String,List<String>> valueParameter,
                                             HashMap<String,List<FileData>> uploadFiles,
                                             Locale locale,
                                             EServletAction action,
                                             Map<String,String> headerMap,
                                             FrontendServer fs)

Deprecated. use #PluginServletActionParams(Map, HashMap, HashMap, Benutzer, Locale, EServletAction, Map, FrontendServer)

PluginServletActionParams

public PluginServletActionParams(Map<String,Serializable> sessionAttributes,
                                 Map<String,List<String>> valueParameter,
                                 Map<String,List<FileData>> uploadFiles,
                                 Benutzer benutzer,
                                 Locale locale,
                                 EServletAction action,
                                 Map<String,String> headerMap,
                                 FrontendServer fs,
                                 Mandant client,
                                 String sessionId)

Constuctor for creating a parameters object with all necessary request data

Parameters:

sessionAttributes - attributes from the current session

valueParameter - request parameter

uploadFiles - files that are overhanded by the request

benutzer - the current logged in user that sent the form

locale - the currently set local

action - an enumeration representing the HTTP method of the request

headerMap - request header fields

fs - the FrontendServer that sent the request

PluginServletActionParams

@Deprecated
public PluginServletActionParams(Map<String,Serializable> sessionAttributes,
                                             Map<String,List<String>> valueParameter,
                                             Map<String,List<FileData>> uploadFiles,
                                             Benutzer benutzer,
                                             Locale locale,
                                             EServletAction action,
                                             Map<String,String> headerMap,
                                             FrontendServer fs)

Deprecated. since 5.1.0 use PluginServletActionParams(Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)

Parameters:

sessionAttributes - attributes from the current session

valueParameter - request parameter

uploadFiles - files that are overhanded by the request

benutzer - the current logged in user that sent the form

locale - the currently set local

action - an enumeration representing the HTTP method of the request

headerMap - request header fields

fs - the FrontendServer that sent the request

Method Detail

getSessionAttributeMap

@Deprecated
public Map<String,Serializable> getSessionAttributeMap()

Deprecated.

Description copied from interface: IPluginServletActionParams

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

Specified by:

getSessionAttributeMap in interface IPluginServletActionParams

Returns:

Map mit Session-Attributen

getRequestParameters

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

Description copied from interface: IPluginServletActionParams

Getter für die Request-Parameter.

Specified by:

getRequestParameters in interface IPluginServletActionParams

Returns:

Map mit den Request-Parametern

getUploadFiles

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

Description copied from interface: IPluginServletActionParams

Getter für alle hochgeladenen Dateien aus dem Request

Specified by:

getUploadFiles in interface IPluginServletActionParams

Returns:

getLocale

public Locale getLocale()

Description copied from interface: IPluginServletActionParams

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

Specified by:

getLocale in interface IPluginServletActionParams

Returns:

Locale das Locale

getAction

public EServletAction getAction()

Description copied from interface: IPluginServletActionParams

Getter für den Typ des Servlet-Aufrufs

Specified by:

getAction in interface IPluginServletActionParams

Returns:

EServletAction der Typ

getHeaderMap

public Map<String,String> getHeaderMap()

Description copied from interface: IPluginServletActionParams

Getter für die Map der Header-Parameter

Specified by:

getHeaderMap in interface IPluginServletActionParams

Returns:

Map der Header-Parameter

getFrontendServer

public FrontendServer getFrontendServer()

Description copied from interface: IPluginServletActionParams

Getter für den FrontendServer.

Specified by:

getFrontendServer in interface IPluginServletActionParams

Returns:

FrontendServer

getBenutzer

public Benutzer getBenutzer()

Description copied from interface: IPluginServletActionParams

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

Specified by:

getBenutzer in interface IPluginServletActionParams

Returns:

Benutzer aus der aktuellen XfcSession

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IPluginServletActionParams

getValueParameters

@Deprecated
public ValueParameters getValueParameters()

Deprecated.

Description copied from interface: IPluginServletActionParams

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

Specified by:

getValueParameters in interface IPluginServletActionParams

Returns:

ValueParameters die Request-Parameter

getSessionID

public String getSessionID()

Description copied from interface: IPluginServletActionParams

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

Specified by:

getSessionID in interface IPluginServletActionParams

Returns:

the session ID for the logged in user

getPluginClient

public Mandant getPluginClient()

Description copied from interface: IPluginServletActionParams

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.

Specified by:

getPluginClient in interface IPluginServletActionParams

Returns:

the client object or null