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 for the parameters of a servlet action plugin.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
EServletAction	getAction()
Benutzer	getBenutzer()
FrontendServer	getFrontendServer()
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. Use getSessionAttributeMap()
String	getSessionID()
Map<String,List<FileData>>	getUploadFiles()
ValueParameters	getValueParameters() Deprecated. Use getRequestParameters()

Method Detail

getSessionAttributeMap

Map<String,Serializable> getSessionAttributeMap()

Returns:

A map Map with all attributes of the current HttpSession. Please note that changes to this map are not reflected or saved in the HttpSession.

Since:

5.0

getBenutzer

Benutzer getBenutzer()

Returns:

The Benutzer from the current XfcSession 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 as EServletAction.DELETE, you may have to parse the HTTP request body yourself.

Returns:

A Map with the parameters from the HttpServletRequest.

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, or null 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; or null 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. Use getSessionAttributeMap()

getValueParameters

@Deprecated
ValueParameters getValueParameters()

Deprecated. Use getRequestParameters()