Package org.apache.myfaces.context.flash
Class FlashImpl
- java.lang.Object
- 
- jakarta.faces.context.Flash
- 
- org.apache.myfaces.context.flash.FlashImpl
 
 
- 
- All Implemented Interfaces:
- Map<String,Object>,- ReleasableFlash
 
 public class FlashImpl extends Flash implements ReleasableFlash Implementation of Flash object
- 
- 
Field SummaryFields Modifier and Type Field Description static StringFLASH_PREVIOUS_REQUEST_REDIRECTKey to store the value of the redirect cookie- 
Fields inherited from class jakarta.faces.context.FlashNULL_VALUE
 
- 
 - 
Constructor SummaryConstructors Constructor Description FlashImpl(ExternalContext externalContext)
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()voidclearFlashMap(FacesContext facesContext, String clientWindowId, String token)booleancontainsKey(Object key)booleancontainsValue(Object value)voiddoPostPhaseActions(FacesContext facesContext)Used to destroy the executeMap and to save all FacesMessages for the next request, but only if this is the last invocation of this method in the current lifecycle (if redirect phase 5, otherwise phase 6).voiddoPrePhaseActions(FacesContext facesContext)Used to restore the redirect value and the FacesMessages of the previous request and to manage the flashMap tokens for this request before phase restore view starts.Set<Map.Entry<String,Object>>entrySet()Objectget(Object key)static FlashgetCurrentInstance(ExternalContext context)Return a Flash instance from the application mapstatic FlashgetCurrentInstance(ExternalContext context, boolean create)protected org.apache.myfaces.context.flash.FlashClientWindowTokenCollectiongetFlashClientWindowTokenCollection(ExternalContext externalContext, boolean create)booleanisEmpty()booleanisKeepMessages()Returns the value of a previous call to setKeepMessages() from this request.booleanisRedirect()Return the value of this property for the flash for this session.voidkeep(String key)Take a value from the requestMap, or if it does not exist from the execute FlashMap, and put it on the render FlashMap, so it is visible on the next request.Set<String>keySet()Objectput(String key, Object value)voidputAll(Map<? extends String,? extends Object> m)voidputNow(String key, Object value)This is just an alias for the request scope map.Objectremove(Object key)voidsetKeepMessages(boolean keepMessages)If this property is true, the messages should be kept for the next request, no matter if it is a normal postback case or a POST- REDIRECT-GET case.voidsetRedirect(boolean redirect)intsize()Collection<Object>values()- 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.util.Mapcompute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
 
- 
 
- 
- 
- 
Field Detail- 
FLASH_PREVIOUS_REQUEST_REDIRECTpublic static final String FLASH_PREVIOUS_REQUEST_REDIRECT Key to store the value of the redirect cookie- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
FlashImplpublic FlashImpl(ExternalContext externalContext) 
 
- 
 - 
Method Detail- 
getCurrentInstancepublic static Flash getCurrentInstance(ExternalContext context) Return a Flash instance from the application map- Parameters:
- context-
- Returns:
 
 - 
getCurrentInstancepublic static Flash getCurrentInstance(ExternalContext context, boolean create) 
 - 
doPrePhaseActionspublic void doPrePhaseActions(FacesContext facesContext) Used to restore the redirect value and the FacesMessages of the previous request and to manage the flashMap tokens for this request before phase restore view starts.- Specified by:
- doPrePhaseActionsin class- Flash
 
 - 
doPostPhaseActionspublic void doPostPhaseActions(FacesContext facesContext) Used to destroy the executeMap and to save all FacesMessages for the next request, but only if this is the last invocation of this method in the current lifecycle (if redirect phase 5, otherwise phase 6).- Specified by:
- doPostPhaseActionsin class- Flash
 
 - 
isRedirectpublic boolean isRedirect() Return the value of this property for the flash for this session. This must be false unless: - setRedirect(boolean) was called for the current lifecycle traversal with true as the argument. - The current lifecycle traversal for this session is in the "execute" phase and the previous traversal had setRedirect(boolean) called with true as the argument.- Specified by:
- isRedirectin class- Flash
 
 - 
setRedirectpublic void setRedirect(boolean redirect) - Specified by:
- setRedirectin class- Flash
 
 - 
keeppublic void keep(String key) Take a value from the requestMap, or if it does not exist from the execute FlashMap, and put it on the render FlashMap, so it is visible on the next request.
 - 
putNowpublic void putNow(String key, Object value) This is just an alias for the request scope map.
 - 
isKeepMessagespublic boolean isKeepMessages() Returns the value of a previous call to setKeepMessages() from this request. If there was no call yet, false is returned.- Specified by:
- isKeepMessagesin class- Flash
 
 - 
setKeepMessagespublic void setKeepMessages(boolean keepMessages) If this property is true, the messages should be kept for the next request, no matter if it is a normal postback case or a POST- REDIRECT-GET case. Note that we don't have to store this value for the next request (like setRedirect()), because we will know if it was true on the next request, if we can find any stored messages in the FlashMap. (also see _saveMessages() and _restoreMessages()).- Specified by:
- setKeepMessagesin class- Flash
 
 - 
containsKeypublic boolean containsKey(Object key) - Specified by:
- containsKeyin interface- Map<String,Object>
 
 - 
containsValuepublic boolean containsValue(Object value) - Specified by:
- containsValuein interface- Map<String,Object>
 
 - 
getFlashClientWindowTokenCollectionprotected org.apache.myfaces.context.flash.FlashClientWindowTokenCollection getFlashClientWindowTokenCollection(ExternalContext externalContext, boolean create) 
 - 
clearFlashMappublic void clearFlashMap(FacesContext facesContext, String clientWindowId, String token) - Specified by:
- clearFlashMapin interface- ReleasableFlash
 
 
- 
 
-