Spring Framework 6.1.4 · org.springframework.web.servlet.support.AbstractFlashMapManager

Modifier and Type	Field and Description
private static final Object	DEFAULT_FLASH_MAPS_MUTEX
private int	flashMapTimeout
protected final Log	logger
private UrlPathHelper	urlPathHelper

Access	Constructor and Description
public	AbstractFlashMapManager()

Method Summary

Modifier and Type	Method and Description
private String	decodeAndNormalizePath(String path, HttpServletRequest request)
private List<FlashMap>	getExpiredFlashMaps(List<FlashMap> allMaps) Return a list of expired FlashMap instances contained in the given list.
protected Object	Returns: the mutex to use (may be `null` if none applicable) getFlashMapsMutex(HttpServletRequest the current request request) Obtain a mutex for modifying the FlashMap List as handled by `retrieveFlashMaps` and `updateFlashMaps`, The default implementation returns a shared static mutex.
public int	getFlashMapTimeout() Return the amount of time in seconds before a FlashMap expires.
private FlashMap	Returns: a matching FlashMap or `null` getMatchingFlashMap(List<FlashMap> allMaps, HttpServletRequest request) Return a FlashMap contained in the given list that matches the request.
private MultiValueMap<String, String>	getOriginatingRequestParams(HttpServletRequest request)
public UrlPathHelper	getUrlPathHelper() Return the UrlPathHelper implementation to use.
protected boolean	isFlashMapForRequest(FlashMap flashMap, HttpServletRequest request) Whether the given FlashMap matches the current request.
public final FlashMap	retrieveAndUpdate(HttpServletRequest the current request request, HttpServletResponse the current response response) Implements org.springframework.web.servlet.FlashMapManager.retrieveAndUpdate. Find a FlashMap saved by a previous request that matches to the current request, remove it from underlying storage, and also remove other expired FlashMap instances.
protected abstract List<FlashMap>	Returns: a List with FlashMap instances, or `null` if none found retrieveFlashMaps(HttpServletRequest the current request request) Retrieve saved FlashMap instances from the underlying storage.
public final void	saveOutputFlashMap(FlashMap the FlashMap to save flashMap, HttpServletRequest the current request request, HttpServletResponse the current response response) Implements org.springframework.web.servlet.FlashMapManager.saveOutputFlashMap. Save the given FlashMap, in some underlying storage and set the start of its expiration period.
public void	setFlashMapTimeout(int flashMapTimeout) Set the amount of time in seconds after a `FlashMap` is saved (at request completion) and before it expires.
public void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use to match FlashMap instances to requests.
protected abstract void	updateFlashMaps(List<FlashMap> a (potentially empty) list of FlashMap instances to save flashMaps, HttpServletRequest the current request request, HttpServletResponse the current response response) Update the FlashMap instances in the underlying storage.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_FLASH_MAPS_MUTEX	back to summary
private static final Object DEFAULT_FLASH_MAPS_MUTEX

flashMapTimeout	back to summary
private int flashMapTimeout

logger	back to summary
protected final Log logger

urlPathHelper	back to summary
private UrlPathHelper urlPathHelper

AbstractFlashMapManager	back to summary
public AbstractFlashMapManager()

Method Detail

decodeAndNormalizePath	back to summary
private String decodeAndNormalizePath(String path, HttpServletRequest request) Annotations @Nullable

getExpiredFlashMaps	back to summary
private List<FlashMap> getExpiredFlashMaps(List<FlashMap> allMaps) Return a list of expired FlashMap instances contained in the given list.

getFlashMapsMutex back to summary

getFlashMapsMutex	back to summary
protected Object getFlashMapsMutex(HttpServletRequest request) Obtain a mutex for modifying the FlashMap List as handled by `retrieveFlashMaps` and `updateFlashMaps`, The default implementation returns a shared static mutex. Subclasses are encouraged to return a more specific mutex, or `null` to indicate that no synchronization is necessary. Parameters request:HttpServletRequest the current request Returns:Object the mutex to use (may be `null` if none applicable) Annotations @Nullable Since 4.0.3

protected Object getFlashMapsMutex(HttpServletRequest request)

Obtain a mutex for modifying the FlashMap List as handled by retrieveFlashMaps and updateFlashMaps,

The default implementation returns a shared static mutex. Subclasses are encouraged to return a more specific mutex, or null to indicate that no synchronization is necessary.

Parameters

request:HttpServletRequest: the current request

Returns:Object

the mutex to use (may be null if none applicable)

Annotations

@Nullable

Since

4.0.3

getFlashMapTimeout	back to summary
public int getFlashMapTimeout() Return the amount of time in seconds before a FlashMap expires.

getMatchingFlashMap back to summary

getMatchingFlashMap	back to summary
private FlashMap getMatchingFlashMap(List<FlashMap> allMaps, HttpServletRequest request) Return a FlashMap contained in the given list that matches the request. Returns:FlashMap a matching FlashMap or `null` Annotations @Nullable

private FlashMap getMatchingFlashMap(List<FlashMap> allMaps, HttpServletRequest request)

Return a FlashMap contained in the given list that matches the request.

Returns:FlashMap

a matching FlashMap or null

Annotations

@Nullable

getOriginatingRequestParams	back to summary
private MultiValueMap<String, String> getOriginatingRequestParams(HttpServletRequest request)

getUrlPathHelper	back to summary
public UrlPathHelper getUrlPathHelper() Return the UrlPathHelper implementation to use.

isFlashMapForRequest	back to summary
protected boolean isFlashMapForRequest(FlashMap flashMap, HttpServletRequest request) Whether the given FlashMap matches the current request. Uses the expected request path and query parameters saved in the FlashMap.

retrieveAndUpdate back to summary

retrieveAndUpdate	back to summary
public final FlashMap retrieveAndUpdate(HttpServletRequest request, HttpServletResponse response) Implements org.springframework.web.servlet.FlashMapManager.retrieveAndUpdate. Doc from org.springframework.web.servlet.FlashMapManager.retrieveAndUpdate. Find a FlashMap saved by a previous request that matches to the current request, remove it from underlying storage, and also remove other expired FlashMap instances. This method is invoked in the beginning of every request in contrast to `saveOutputFlashMap`, which is invoked only when there are flash attributes to be saved - i.e. before a redirect. Parameters request:HttpServletRequest the current request response:HttpServletResponse the current response Returns:FlashMap a FlashMap matching the current request or `null` Annotations @Override @Nullable

public final FlashMap retrieveAndUpdate(HttpServletRequest request, HttpServletResponse response)

Implements org.springframework.web.servlet.FlashMapManager.retrieveAndUpdate.

Doc from org.springframework.web.servlet.FlashMapManager.retrieveAndUpdate.

Find a FlashMap saved by a previous request that matches to the current request, remove it from underlying storage, and also remove other expired FlashMap instances.

This method is invoked in the beginning of every request in contrast to saveOutputFlashMap, which is invoked only when there are flash attributes to be saved - i.e. before a redirect.

Parameters

request:HttpServletRequest: the current request
response:HttpServletResponse: the current response

Returns:FlashMap

a FlashMap matching the current request or null

Annotations

@Override
@Nullable

retrieveFlashMaps back to summary

retrieveFlashMaps	back to summary
protected abstract List<FlashMap> retrieveFlashMaps(HttpServletRequest request) Retrieve saved FlashMap instances from the underlying storage. Parameters request:HttpServletRequest the current request Returns:List<FlashMap> a List with FlashMap instances, or `null` if none found Annotations @Nullable

protected abstract List<FlashMap> retrieveFlashMaps(HttpServletRequest request)

Retrieve saved FlashMap instances from the underlying storage.

Parameters

request:HttpServletRequest: the current request

Returns:List<FlashMap>

a List with FlashMap instances, or null if none found

Annotations

@Nullable

saveOutputFlashMap	back to summary
public final void saveOutputFlashMap(FlashMap flashMap, HttpServletRequest request, HttpServletResponse response) Implements org.springframework.web.servlet.FlashMapManager.saveOutputFlashMap. Doc from org.springframework.web.servlet.FlashMapManager.saveOutputFlashMap. Save the given FlashMap, in some underlying storage and set the start of its expiration period. Note Invoke this method prior to a redirect in order to allow saving the FlashMap in the HTTP session or in a response cookie before the response is committed. Parameters flashMap:FlashMap the FlashMap to save request:HttpServletRequest the current request response:HttpServletResponse the current response Annotations @Override

saveOutputFlashMap

back to summary

public final void saveOutputFlashMap(FlashMap flashMap, HttpServletRequest request, HttpServletResponse response)

Implements org.springframework.web.servlet.FlashMapManager.saveOutputFlashMap.

Doc from org.springframework.web.servlet.FlashMapManager.saveOutputFlashMap.

Save the given FlashMap, in some underlying storage and set the start of its expiration period.

Note

Invoke this method prior to a redirect in order to allow saving the FlashMap in the HTTP session or in a response cookie before the response is committed.

Parameters

flashMap:FlashMap: the FlashMap to save
request:HttpServletRequest: the current request
response:HttpServletResponse: the current response

Annotations

@Override

setFlashMapTimeout back to summary

setFlashMapTimeout	back to summary
public void setFlashMapTimeout(int flashMapTimeout) Set the amount of time in seconds after a `FlashMap` is saved (at request completion) and before it expires. The default value is 180 seconds.

public void setFlashMapTimeout(int flashMapTimeout)

Set the amount of time in seconds after a FlashMap is saved (at request completion) and before it expires.

The default value is 180 seconds.

setUrlPathHelper	back to summary
public void setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use to match FlashMap instances to requests.

updateFlashMaps	back to summary
protected abstract void updateFlashMaps(List<FlashMap> flashMaps, HttpServletRequest request, HttpServletResponse response) Update the FlashMap instances in the underlying storage. Parameters flashMaps:List<FlashMap> a (potentially empty) list of FlashMap instances to save request:HttpServletRequest the current request response:HttpServletResponse the current response

updateFlashMaps

back to summary

protected abstract void updateFlashMaps(List<FlashMap> flashMaps, HttpServletRequest request, HttpServletResponse response)

Update the FlashMap instances in the underlying storage.

Parameters

flashMaps:List<FlashMap>: a (potentially empty) list of FlashMap instances to save
request:HttpServletRequest: the current request
response:HttpServletResponse: the current response

public abstract Class AbstractFlashMapManager

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail