Class PluginServletActionRetVal
- java.lang.Object
-
- de.xima.fc.plugin.models.retval.servlet.PluginServletActionRetVal
-
- All Implemented Interfaces:
IPluginReturnValue
,IPluginServletActionRetVal
,Serializable
public class PluginServletActionRetVal extends Object implements IPluginServletActionRetVal
POJO implementation ofIPluginServletActionRetVal
.- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PluginServletActionRetVal(IServletResponse result)
Creates a new POJO with the given servlet response.PluginServletActionRetVal(IServletResponse result, int statusCode)
Creates a new POJO with the given servlet response.PluginServletActionRetVal(IServletResponse result, int statusCode, Map<String,Serializable> sessionAttributes, Map<String,Serializable> frqAttributes)
Creates a new POJO with the given servlet response.PluginServletActionRetVal(IServletResponse result, Map<String,Serializable> sessionAttributes, Map<String,Serializable> frqAttributes)
Creates a new POJO with the given servlet response.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,Serializable>
getFrqSessionAttributeMap()
A map of key-value pairs with FRQ session attributes that are written to theFRQSession
.int
getHttpStatusCode()
IServletResponse
getResponse()
Map<String,Serializable>
getSessionAttributeMap()
A map of key-value pairs with session attributes that are written to theHttpSession
.
-
-
-
Constructor Detail
-
PluginServletActionRetVal
public PluginServletActionRetVal(IServletResponse result)
Creates a new POJO with the given servlet response.- Parameters:
result
- Servlet response that should be returned to the client.
-
PluginServletActionRetVal
public PluginServletActionRetVal(IServletResponse result, int statusCode)
Creates a new POJO with the given servlet response.- Parameters:
result
- Servlet response that should be returned to the client.statusCode
- Status code to use for the HTTP response.
-
PluginServletActionRetVal
public PluginServletActionRetVal(IServletResponse result, int statusCode, Map<String,Serializable> sessionAttributes, Map<String,Serializable> frqAttributes)
Creates a new POJO with the given servlet response.- Parameters:
result
- Servlet response that should be returned to the client.statusCode
- Status code to use for the HTTP response.sessionAttributes
- Map with session attributes that should be added to the current session.frqAttributes
- Map withFRQSession
attributes that should be added to the current FRQ session.
-
PluginServletActionRetVal
public PluginServletActionRetVal(IServletResponse result, Map<String,Serializable> sessionAttributes, Map<String,Serializable> frqAttributes)
Creates a new POJO with the given servlet response.- Parameters:
result
- Servlet response that should be returned to the client.sessionAttributes
- Map with session attributes that should be added to the current session.frqAttributes
- Map withFRQSession
attributes that should be added to the current FRQ session.
-
-
Method Detail
-
getFrqSessionAttributeMap
public Map<String,Serializable> getFrqSessionAttributeMap()
Description copied from interface:IPluginServletActionRetVal
A map of key-value pairs with FRQ session attributes that are written to theFRQSession
. When the session already contains a value for a parameter, it is overwritten.- Specified by:
getFrqSessionAttributeMap
in interfaceIPluginServletActionRetVal
- Returns:
- A
Map
with FRQ session attributes to set on theFRQSession
.
-
getHttpStatusCode
public int getHttpStatusCode()
- Specified by:
getHttpStatusCode
in interfaceIPluginServletActionRetVal
- Returns:
- The HTTP status code that is to be returned to the client in response to the HTTP request.
-
getResponse
public IServletResponse getResponse()
- Specified by:
getResponse
in interfaceIPluginServletActionRetVal
- Returns:
- The
IServletResponse
that is to be returned to the client in response to the HTTP request.
-
getSessionAttributeMap
public Map<String,Serializable> getSessionAttributeMap()
Description copied from interface:IPluginServletActionRetVal
A map of key-value pairs with session attributes that are written to theHttpSession
. When the session already contains a value for a parameter, it is overwritten.- Specified by:
getSessionAttributeMap
in interfaceIPluginServletActionRetVal
- Returns:
- A
Map
with session attributes to set on theHttpSession
.
-
-