|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidad.context.PageFlowScopeProvider
public abstract class PageFlowScopeProvider
Abstract implementation for code that provides page flow scopes; this may be overridden.
To override this, provide a file on the classpath at
/META-INF/services/org.apache.myfaces.trinidad.context.PageFlowScopeProvider
with the name of the alternative implementation. (There's no current
support for decoration, and this general approach may be revisited
in the future.)
Constructor Summary | |
---|---|
protected |
PageFlowScopeProvider()
|
Method Summary | |
---|---|
abstract String |
encodeCurrentPageFlowScopeURL(javax.faces.context.FacesContext context,
String url)
Encode the page flow scope into the current URL for processing in later requests. |
abstract Map<String,Object> |
getPageFlowScope(javax.faces.context.FacesContext context)
Returns the current PageFlowScope, including any calls to pushPageFlowScope() or popPageFlowScope() . |
abstract Map<String,Object> |
popPageFlowScope(javax.faces.context.FacesContext context,
boolean discardScope)
Pushes a new process scope onto the stack. |
abstract Map<String,Object> |
pushPageFlowScope(javax.faces.context.FacesContext context,
boolean copyParent)
Pushes a new process scope onto the stack. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected PageFlowScopeProvider()
Method Detail |
---|
public abstract Map<String,Object> getPageFlowScope(javax.faces.context.FacesContext context)
pushPageFlowScope()
or popPageFlowScope()
.
context
- the current FacesContextpublic abstract Map<String,Object> pushPageFlowScope(javax.faces.context.FacesContext context, boolean copyParent)
context
- the current FacesContextcopyParent
- if true, all values from the parent process
scope will be copied into the new process scope.
public abstract Map<String,Object> popPageFlowScope(javax.faces.context.FacesContext context, boolean discardScope)
context
- the current FacesContextdiscardScope
- if true, the scope will be immediately destroyed.
if false, the scope may be available (for back button use, for
example), but this is at the discretion of the implementation,
which may aggressively destroy page flow scopes in some circumstances.public abstract String encodeCurrentPageFlowScopeURL(javax.faces.context.FacesContext context, String url)
context
- the current FacesContexturl
- an URL (which may already contain query parameters)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |