Package 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	Description
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, Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)
PluginServletActionParams(Map<String,Serializable> httpSessionAttributes, Map<Serializable,Serializable> frqSessionAttributes, 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)	Constructor for creating a parameters object with all necessary request data
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. use PluginServletActionParams(Map, 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)	Deprecated. use PluginServletActionParams(Map, Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)

Method Summary

Modifier and Type	Method	Description
EServletAction	getAction()
Benutzer	getBenutzer()
FrontendServer	getFrontendServer()
Map<Serializable,Serializable>	getFrqSessionAttributes()	Gets the values stored in the current FRQSession.
Map<String,String>	getHeaderMap()
Locale	getLocale()
Mandant	getPluginClient()
Map<String,List<String>>	getRequestParameters()	The parameters from the HTTP request.
Map<String,Serializable>	getSessionAttributeMap()	Deprecated.
SessionAttributes	getSessionAttributes()	Deprecated.
String	getSessionID()
Map<String,List<FileData>>	getUploadFiles()
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, Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)

Constructor for creating a parameters object with all necessary request data

Parameters:

sessionAttributes - attributes from the current session

valueParameter - request parameter

uploadFiles - Files that were sent with the request.

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,
                                 Mandant client,
                                 String sessionId)

Deprecated.

use PluginServletActionParams(Map, Map, Map, Map, Benutzer, Locale, EServletAction, Map, FrontendServer, Mandant, String)

Constructor for creating a parameters object with all necessary request data

Parameters:

sessionAttributes - attributes from the current session

valueParameter - request parameter

uploadFiles - Files that were sent with 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

client - The client context, may be null for a system plugin.

sessionId - ID of the current session, may be null or empty when no session exists.

PluginServletActionParams

public PluginServletActionParams(Map<String,Serializable> httpSessionAttributes,
                                 Map<Serializable,Serializable> frqSessionAttributes,
                                 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)

Constructor for creating a parameters object with all necessary request data

Parameters:

httpSessionAttributes - attributes from the current HTTP session

frqSessionAttributes - Attributes from the current form request session, if any.

valueParameter - request parameter

uploadFiles - Files that were sent with 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

client - The client context, may be null for a system plugin.

sessionId - ID of the current session, may be null or empty when no session exists.

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.

use PluginServletActionParams(Map, 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

Gets the values from the current HttpSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the HttpSession. To modify the session attributes, use the IPluginServletActionRetVal.getSessionAttributeMap() return value.

Specified by:

getSessionAttributeMap in interface IPluginServletActionParams

Returns:

A map Map with all attributes of the current HttpSession.

getFrqSessionAttributes

public Map<Serializable,Serializable> getFrqSessionAttributes()

Description copied from interface: IPluginServletActionParams

Gets the values stored in the current FRQSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the FRQSession. To modify the FRQ session attributes, use the IPluginServletActionRetVal.getFrqSessionAttributeMap() return value.

Specified by:

getFrqSessionAttributes in interface IPluginServletActionParams

Returns:

Attributes from the form request session of the current request. If no such session exists, this is an empty map.

getRequestParameters

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

Description copied from interface: IPluginServletActionParams

The parameters from the HTTP request. This includes both URL parameters as well as POST parameters, but excluded uploaded files. Please note that multiple values may have been given for a URL or POST parameter, eg. http://example.com?foo=bar&foo=baz. Also, for some HTTP methods such as EServletAction.DELETE, you may have to parse the HTTP request body yourself.

Specified by:

getRequestParameters in interface IPluginServletActionParams

Returns:

A Map with the parameters from the HttpServletRequest.

See Also:

IPluginServletActionParams.getUploadFiles()

getUploadFiles

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

Specified by:

getUploadFiles in interface IPluginServletActionParams

Returns:

A Map between the name of an upload form element and the file(s) that were uploaded for that upload element.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IPluginServletActionParams

Returns:

The current Locale of the request; or the default locale in case no locale could be determined.

getAction

public EServletAction getAction()

Specified by:

getAction in interface IPluginServletActionParams

Returns:

The HTTP method of the servlet request.

getHeaderMap

public Map<String,String> getHeaderMap()

Specified by:

getHeaderMap in interface IPluginServletActionParams

Returns:

A Map that contains the HTTP header parameters.

getFrontendServer

public FrontendServer getFrontendServer()

Specified by:

getFrontendServer in interface IPluginServletActionParams

Returns:

The current FrontendServer to which the servlet request was made, or null if the request was made directly to the master server.

getBenutzer

public Benutzer getBenutzer()

Specified by:

getBenutzer in interface IPluginServletActionParams

Returns:

The Benutzer from the current XfcSession who called the servlet action plugin.

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IPluginServletActionParams

getValueParameters

@Deprecated
public ValueParameters getValueParameters()

Deprecated.

Specified by:

getValueParameters in interface IPluginServletActionParams

getSessionID

public String getSessionID()

Specified by:

getSessionID in interface IPluginServletActionParams

Returns:

The session ID for the user who is currently logged in; or null in case no session ID is available (which may happen, for example, when the user is not logged in).

getPluginClient

public Mandant getPluginClient()

Specified by:

getPluginClient in interface IPluginServletActionParams

Returns:

The Mandant to which the servlet action plugin belongs to; or null in case the plugin was installed as a system plugin and no client was provided in the servlet action URL.