Interface IPluginServletActionParams
-
- All Superinterfaces:
IPluginParameters
,Serializable
- All Known Implementing Classes:
PluginServletActionParams
public interface IPluginServletActionParams extends IPluginParameters, Serializable
Interface for the parameters of a servlet action plugin.- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description EServletAction
getAction()
Benutzer
getBenutzer()
FrontendServer
getFrontendServer()
Map<Serializable,Serializable>
getFrqSessionAttributes()
Map<String,String>
getHeaderMap()
Locale
getLocale()
Mandant
getPluginClient()
Map<String,List<String>>
getRequestParameters()
The parameters from the HTTP request.Map<String,Serializable>
getSessionAttributeMap()
SessionAttributes
getSessionAttributes()
Deprecated.String
getSessionID()
Map<String,List<FileData>>
getUploadFiles()
ValueParameters
getValueParameters()
Deprecated.
-
-
-
Method Detail
-
getSessionAttributeMap
Map<String,Serializable> getSessionAttributeMap()
- Returns:
- A map
Map
with all attributes of the currentHttpSession
. Please note that changes to this map are not reflected or saved in theHttpSession
. - Since:
- 5.0
-
getBenutzer
Benutzer getBenutzer()
- Returns:
- The
Benutzer
from the currentXfcSession
who called the servlet action plugin. - Since:
- 5.0
-
getRequestParameters
Map<String,List<String>> getRequestParameters()
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 asEServletAction.DELETE
, you may have to parse the HTTP request body yourself.- Returns:
- A
Map
with the parameters from theHttpServletRequest
. - See Also:
getUploadFiles()
-
getUploadFiles
Map<String,List<FileData>> getUploadFiles()
- Returns:
- A
Map
between the name of an upload form element and the file(s) that were uploaded for that upload element.
-
getLocale
Locale getLocale()
- Returns:
- The current
Locale
of the request; or the default locale in case no locale could be determined.
-
getAction
EServletAction getAction()
- Returns:
- The HTTP method of the servlet request.
-
getHeaderMap
Map<String,String> getHeaderMap()
- Returns:
- A
Map
that contains the HTTP header parameters.
-
getFrontendServer
FrontendServer getFrontendServer()
- Returns:
- The current
FrontendServer
to which the servlet request was made, ornull
if the request was made directly to the master server.
-
getSessionID
String getSessionID()
- 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). - Since:
- 5.1.0
-
getPluginClient
Mandant getPluginClient()
- Returns:
- The
Mandant
to which the servlet action plugin belongs to; ornull
in case the plugin was installed as a system plugin and no client was provided in the servlet action URL. - Since:
- 5.1.0
-
getSessionAttributes
@Deprecated SessionAttributes getSessionAttributes()
Deprecated.
-
getValueParameters
@Deprecated ValueParameters getValueParameters()
Deprecated.
-
getFrqSessionAttributes
Map<Serializable,Serializable> getFrqSessionAttributes()
- Returns:
- Attributes from the form request session of the current request. If no such session exists, this is an empty map.
- Since:
- 7.0.13
-
-