|
Spring Framework | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.web.servlet.support.DefaultFlashMapManager
public class DefaultFlashMapManager
A default FlashMapManager
implementation that stores FlashMap
instances in the HTTP session.
Field Summary |
---|
Fields inherited from interface org.springframework.web.servlet.FlashMapManager |
---|
INPUT_FLASH_MAP_ATTRIBUTE, OUTPUT_FLASH_MAP_ATTRIBUTE |
Constructor Summary | |
---|---|
DefaultFlashMapManager()
|
Method Summary | |
---|---|
int |
getFlashMapTimeout()
Return the amount of time in seconds before a FlashMap expires. |
UrlPathHelper |
getUrlPathHelper()
Return the UrlPathHelper implementation for the request URI. |
protected boolean |
isFlashMapForRequest(FlashMap flashMap,
javax.servlet.http.HttpServletRequest request)
Whether the given FlashMap matches the current request. |
protected void |
onSaveFlashMap(FlashMap flashMap,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Update a FlashMap before it is stored in the underlying storage. |
protected void |
removeExpiredFlashMaps(javax.servlet.http.HttpServletRequest request)
Check and remove expired FlashMaps instances. |
void |
requestCompleted(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Start the expiration period of the "output" FlashMap save it in the underlying storage. |
void |
requestStarted(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Perform the following tasks unless the FlashMapManager.OUTPUT_FLASH_MAP_ATTRIBUTE
request attribute exists:
Find the "input" FlashMap, expose it under the request attribute
FlashMapManager.INPUT_FLASH_MAP_ATTRIBUTE , and remove it from underlying storage. |
protected java.util.List<FlashMap> |
retrieveFlashMaps(javax.servlet.http.HttpServletRequest request,
boolean allowCreate)
Retrieve all FlashMap instances from the current HTTP session. |
protected void |
saveFlashMap(FlashMap flashMap,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Save the FlashMap in the underlying storage. |
void |
setFlashMapTimeout(int flashMapTimeout)
Set the amount of time in seconds after a FlashMap is saved
(at request completion) and before it expires. |
void |
setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to use to obtain the request URI. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultFlashMapManager()
Method Detail |
---|
public void setFlashMapTimeout(int flashMapTimeout)
FlashMap
is saved
(at request completion) and before it expires.
The default value is 180 seconds.
public int getFlashMapTimeout()
public void setUrlPathHelper(UrlPathHelper urlPathHelper)
public UrlPathHelper getUrlPathHelper()
public final void requestStarted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
FlashMapManager.OUTPUT_FLASH_MAP_ATTRIBUTE
request attribute exists:
FlashMapManager.INPUT_FLASH_MAP_ATTRIBUTE
, and remove it from underlying storage.
FlashMapManager.OUTPUT_FLASH_MAP_ATTRIBUTE
.
An HTTP session is never created by this method.
requestStarted
in interface FlashMapManager
request
- the current requestresponse
- the current responseprotected boolean isFlashMapForRequest(FlashMap flashMap, javax.servlet.http.HttpServletRequest request)
protected java.util.List<FlashMap> retrieveFlashMaps(javax.servlet.http.HttpServletRequest request, boolean allowCreate)
allowCreate
is "true" and no flash maps exist yet, a new list
is created and stored as a session attribute.
request
- the current requestallowCreate
- whether to create the session if necessary
null
assuming allowCreate
is "false".protected void removeExpiredFlashMaps(javax.servlet.http.HttpServletRequest request)
public void requestCompleted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
The "output" FlashMap should not be saved if it is empty or if it was not created by the current FlashMapManager instance.
An HTTP session is never created if the "output" FlashMap is empty.
requestCompleted
in interface FlashMapManager
request
- the current requestresponse
- the current responseprotected void onSaveFlashMap(FlashMap flashMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
The default implementation starts the expiration period and ensures the target request path is decoded and normalized if it is relative.
flashMap
- the flash map to be savedrequest
- the current requestresponse
- the current responseprotected void saveFlashMap(FlashMap flashMap, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
flashMap
- the FlashMap to saverequest
- the current requestresponse
- the current response
|
Spring Framework | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |