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

Default implementation of IPluginServletActionParams with a builder.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PluginServletActionParams.Builder

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, IUser, 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 user, Locale locale, EServletAction action, Map<String,String> headerMap, FrontendServer fs, Mandant client, String sessionId)	Deprecated. use PluginServletActionParams(Map, Map, Map, Map, IUser, 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, IUser user, Locale locale, EServletAction action, Map<String,String> headerMap, FrontendServer fs, Mandant client, String sessionId)	Deprecated. Use builder().
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, Map, IUser, 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, IUser, Locale, EServletAction, Map, FrontendServer, Mandant, String) instead.

Method Summary

Modifier and Type	Method	Description
static PluginServletActionParams.Builder	builder()
EServletAction	getAction()
IUser	getBackendUser()	Gets the BACKEND user that made the request to the plugin action servlet.
String	getBaseUrl()	Returns the HTTP request base URL.
Benutzer	getBenutzer()	Deprecated. Use IPluginServletActionParams.getUser() instead.
Long	getClientId()	Gets the ID of the client scope where the servlet action plugin was called, if any.
String	getContextPath()	Returns the portion of the request URI that indicates the context of the request.
Long	getFormRecordId()	Gets the ID of the form record scope where the servlet action plugin was called, if any.
IUser	getFormUser()	Gets the FORM user that made the request to the plugin action servlet.
Long	getFormVersionId()
FrontendServer	getFrontendServer()
Map<Serializable, Serializable>	getFrqSessionAttributes()	Gets the values stored in the current FRQSession.
String	getFrqSessionId()	Gets the ID of the current form request session, if such a session exists.
Map<String,String>	getHeaderMap()
Locale	getLocale()
Mandant	getPluginClient()
Long	getProjectId()	Gets the ID of the project scope where the servlet action plugin was called, if any.
String	getRemoteAddr()	Returns the Internet Protocol (IP) address of the client that sent the request.
InputStream	getRequestBodyInputStream()	Gets a new input stream for the HTTP request body.
Map<String, List<String>>	getRequestParameters()	The parameters from the HTTP request.
String	getRequestUri()	Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
String	getRequestUrl()	Reconstructs the URL the client used to make the request.
Map<String, Serializable>	getSessionAttributeMap()	Deprecated.
SessionAttributes	getSessionAttributes()	Deprecated.
String	getSessionID()
Map<String, List<FileData>>	getUploadFiles()
ValueParameters	getValueParameters()	Deprecated.
Long	getWorkflowVersionId()	Gets the ID of the workflow version where the servlet action plugin was called, if any.

Methods inherited from class Object

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

Methods inherited from interface IPluginServletActionParams

getUser

Constructor Details

PluginServletActionParams

@Deprecated
public PluginServletActionParams(Map<String, Serializable> httpSessionAttributes,
 Map<Serializable, Serializable> frqSessionAttributes,
 Map<String, List<String>> valueParameter,
 Map<String, List<FileData>> uploadFiles,
 IUser user,
 Locale locale,
 EServletAction action,
 Map<String,String> headerMap,
 FrontendServer fs,
 Mandant client,
 String sessionId)

Deprecated.

Use builder().

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. // * @param user 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> httpSessionAttributes,
 Map<Serializable, Serializable> frqSessionAttributes,
 Map<String, List<String>> valueParameter,
 Map<String, List<FileData>> uploadFiles,
 Benutzer user,
 Locale locale,
 EServletAction action,
 Map<String,String> headerMap,
 FrontendServer fs,
 Mandant client,
 String sessionId)

Deprecated.

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

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.

user - 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(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, IUser, 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, IUser, Locale, EServletAction, Map, FrontendServer, Mandant, String) instead.

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

@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, Map, IUser, 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 Details

getAction

public EServletAction getAction()

Specified by:

getAction in interface IPluginServletActionParams

Returns:

The HTTP method of the servlet request.

getBackendUser

public IUser getBackendUser()

Description copied from interface: IPluginServletActionParams

Gets the BACKEND user that made the request to the plugin action servlet.

Specified by:

getBackendUser in interface IPluginServletActionParams

Returns:

The form user, if any, or null otherwise.

getBaseUrl

public String getBaseUrl()

Description copied from interface: IPluginServletActionParams

Returns the HTTP request base URL. This is the URL from the scheme, domain until with context path, including the trailing slash. This is the value you could use in HTML <base> tag in an XHTML view.

Specified by:

getBaseUrl in interface IPluginServletActionParams

Returns:

The HTTP request base URL.

See Also:

• HttpServletRequest.getRequestURI()
• HttpServletRequest.getRequestURL()
• HttpServletRequest.getContextPath()

getBenutzer

@Deprecated
public Benutzer getBenutzer()

Deprecated.

Use IPluginServletActionParams.getUser() instead.

Specified by:

getBenutzer in interface IPluginServletActionParams

Returns:

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

getClientId

public Long getClientId()

Description copied from interface: IPluginServletActionParams

Gets the ID of the client scope where the servlet action plugin was called, if any.

Specified by:

getClientId in interface IPluginServletActionParams

Returns:

The client ID; or null if no client scope is available.

getContextPath

public String getContextPath()

Description copied from interface: IPluginServletActionParams

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.

It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request, and it may differ from the path returned by the ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.

Specified by:

getContextPath in interface IPluginServletActionParams

Returns:

a String specifying the portion of the request URI that indicates the context of the request

See Also:

• HttpServletRequest.getContextPath()

getFormRecordId

public Long getFormRecordId()

Description copied from interface: IPluginServletActionParams

Gets the ID of the form record scope where the servlet action plugin was called, if any.

Specified by:

getFormRecordId in interface IPluginServletActionParams

Returns:

The form record ID; or null if no form record scope is available.

getFormUser

public IUser getFormUser()

Description copied from interface: IPluginServletActionParams

Gets the FORM user that made the request to the plugin action servlet. Requires the frid (form request ID) parameter to be included in the request parameters.

Specified by:

getFormUser in interface IPluginServletActionParams

Returns:

The form user, if any, or null otherwise.

getFormVersionId

public Long getFormVersionId()

Specified by:

getFormVersionId in interface IPluginServletActionParams

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.

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.

See Also:

• IPluginServletActionParams.getFrqSessionId()

getFrqSessionId

public String getFrqSessionId()

Description copied from interface: IPluginServletActionParams

Gets the ID of the current form request session, if such a session exists.

Specified by:

getFrqSessionId in interface IPluginServletActionParams

Returns:

The ID of the current FRQ (form request) session, if such a session exists.

See Also:

• IPluginServletActionParams.getFrqSessionAttributes()

getHeaderMap

public Map<String,String> getHeaderMap()

Specified by:

getHeaderMap in interface IPluginServletActionParams

Returns:

A Map that contains the HTTP header parameters. The map is case-insensitive, i.e. you can access a header with the key "Content-Type" as well as "content-type" etc.

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.

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.

getProjectId

public Long getProjectId()

Description copied from interface: IPluginServletActionParams

Gets the ID of the project scope where the servlet action plugin was called, if any.

Specified by:

getProjectId in interface IPluginServletActionParams

Returns:

The project ID; or null if no project scope is available.

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: IPluginServletActionParams

Returns the Internet Protocol (IP) address of the client that sent the request. This will first check the Forwarded and X-Forwarded-For request headers and if any is present, then return its first IP address, else just return ServletRequest.getRemoteAddr() unmodified.

Specified by:

getRemoteAddr in interface IPluginServletActionParams

Returns:

The IP address of the client.

See Also:

• ServletRequest.getRemoteAddr()

getRequestBodyInputStream

public InputStream getRequestBodyInputStream()

Description copied from interface: IPluginServletActionParams

Gets a new input stream for the HTTP request body. This input stream will be empty if the content type is either "application/x-www-form-urlencoded" or "multipart/form-data". In these cases, use IPluginServletActionParams.getRequestParameters() to access the text parameters and IPluginServletActionParams.getUploadFiles() to access the uploaded files.

The caller is responsible to close the input stream after use.

Specified by:

getRequestBodyInputStream in interface IPluginServletActionParams

Returns:

The InputStream of the HTTP request body.

getRequestParameters

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

Description copied from interface: IPluginServletActionParams

The parameters from the HTTP request. This includes both URL parameters and POST parameters, but excluded uploaded files. Please note that multiple values may have been given for a URL or POST parameter, e.g. 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()

getRequestUri

public String getRequestUri()

Description copied from interface: IPluginServletActionParams

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:

Examples of returned values

First line of HTTP request	Returned Value
POST /some/path.html HTTP/1.1		/some/path.html
GET http://foo.bar/a.html HTTP/1.0		/a.html
HEAD /xyz?a=b HTTP/1.1		/xyz

Specified by:

getRequestUri in interface IPluginServletActionParams

Returns:

a String containing the part of the URL from the protocol name up to the query string

See Also:

• HttpServletRequest.getRequestURI()

getRequestUrl

public String getRequestUrl()

Description copied from interface: IPluginServletActionParams

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

If this request has been forwarded using RequestDispatcher.forward(ServletRequest, ServletResponse), the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

Specified by:

getRequestUrl in interface IPluginServletActionParams

Returns:

a StringBuffer object containing the reconstructed URL

See Also:

• HttpServletRequest.getRequestURL()

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.

getSessionAttributes

@Deprecated
public SessionAttributes getSessionAttributes()

Deprecated.

Specified by:

getSessionAttributes in interface IPluginServletActionParams

Returns:

All serializable session attributes.

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).

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.

getValueParameters

@Deprecated
public ValueParameters getValueParameters()

Deprecated.

Specified by:

getValueParameters in interface IPluginServletActionParams

Returns:

All serializable session attributes.

getWorkflowVersionId

public Long getWorkflowVersionId()

Description copied from interface: IPluginServletActionParams

Gets the ID of the workflow version where the servlet action plugin was called, if any.

Specified by:

getWorkflowVersionId in interface IPluginServletActionParams

Returns:

The workflow version ID; or null if no workflow version scope is available.

builder

public static PluginServletActionParams.Builder builder()