|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.orchestra.frameworkAdapter.FrameworkAdapter
org.apache.myfaces.orchestra.frameworkAdapter.jsf.JsfFrameworkAdapter
public class JsfFrameworkAdapter
An implementation of the FrameworkAdapter for JSF environments.
This class defaults to using a JsfConversationMessager instance.
Constructor Summary | |
---|---|
JsfFrameworkAdapter(java.lang.String conversationMessagerClass)
|
Method Summary | |
---|---|
void |
beginRequest()
This method should be invoked at the start of each JSF request cycle, before any Orchestra functionality is invoked. |
boolean |
containsRequestAttribute(java.lang.String key)
|
boolean |
containsRequestParameterAttribute(java.lang.String key)
|
boolean |
containsSessionAttribute(java.lang.String key)
|
protected ConversationMessager |
createDefaultConversationMessager()
|
void |
endRequest()
This method should be invoked at the end of each JSF request cycle, after the last Orchestra functionality is invoked. |
java.lang.Object |
getBean(java.lang.String name)
Return the variable with the specified name, or null if no such bean exists. |
java.lang.String |
getCurrentViewId()
Return the current JSF viewId. |
protected javax.faces.context.FacesContext |
getFacesContext()
|
java.lang.String |
getInitParameter(java.lang.String key)
Return the global init parameter with the specified name. |
java.lang.Object |
getRequestAttribute(java.lang.String key)
Get a request-scope variable. |
protected java.lang.String |
getRequestContextPath()
|
java.lang.Object |
getRequestParameterAttribute(java.lang.String key)
Get a value from the set of input parameters sent by the user as part of the request. |
java.lang.Object |
getSessionAttribute(java.lang.String key)
Get a variable from the session-scope of the current user. |
void |
invokeNavigation(java.lang.String navigationName)
Navigate to the specified logical destination. |
void |
redirect(java.lang.String url)
Instruct the remote browser to fetch the specified URL. |
void |
setRequestAttribute(java.lang.String key,
java.lang.Object value)
|
void |
setSessionAttribute(java.lang.String key,
java.lang.Object value)
|
Methods inherited from class org.apache.myfaces.orchestra.frameworkAdapter.FrameworkAdapter |
---|
createConversationMessager, getConversationMessager, getCurrentInstance, prepare, setConversationMessager, setCurrentInstance |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JsfFrameworkAdapter(java.lang.String conversationMessagerClass)
Method Detail |
---|
public void beginRequest()
public void endRequest()
protected ConversationMessager createDefaultConversationMessager()
protected javax.faces.context.FacesContext getFacesContext()
public java.lang.String getInitParameter(java.lang.String key)
FrameworkAdapter
getInitParameter
in class FrameworkAdapter
public java.lang.Object getRequestParameterAttribute(java.lang.String key)
FrameworkAdapter
getRequestParameterAttribute
in class FrameworkAdapter
public boolean containsRequestParameterAttribute(java.lang.String key)
containsRequestParameterAttribute
in class FrameworkAdapter
public java.lang.Object getRequestAttribute(java.lang.String key)
FrameworkAdapter
getRequestAttribute
in class FrameworkAdapter
public void setRequestAttribute(java.lang.String key, java.lang.Object value)
setRequestAttribute
in class FrameworkAdapter
public boolean containsRequestAttribute(java.lang.String key)
containsRequestAttribute
in class FrameworkAdapter
public java.lang.Object getSessionAttribute(java.lang.String key)
FrameworkAdapter
getSessionAttribute
in class FrameworkAdapter
public void setSessionAttribute(java.lang.String key, java.lang.Object value)
setSessionAttribute
in class FrameworkAdapter
public boolean containsSessionAttribute(java.lang.String key)
containsSessionAttribute
in class FrameworkAdapter
protected java.lang.String getRequestContextPath()
public void redirect(java.lang.String url) throws java.io.IOException
FrameworkAdapter
redirect
in class FrameworkAdapter
java.io.IOException
public java.lang.Object getBean(java.lang.String name)
FrameworkAdapter
In frameworks that support "managed beans", ie creation of objects on demand then this may trigger the creation of the specified object. In frameworks that do not support this, then the lookup may just return null if no object with the specified name currently exists.
Note that no "property traversal" is required or expected; a name of "a.b.c" is NOT evaluated as "property c of property b of bean a", but as the bean with name 'a.b.c'.
getBean
in class FrameworkAdapter
public void invokeNavigation(java.lang.String navigationName)
FrameworkAdapter
For frameworks that have a built-in navigation system, that system should be invoked.
For frameworks with no logical navigation system, the navigationName is treated as a plain URL. Whether a FORWARD or a REDIRECT to this URL is perfomed is determined by the subclass.
invokeNavigation
in class FrameworkAdapter
public java.lang.String getCurrentViewId()
Null is returned if there is not yet a UIViewRoot set up for the current request.
getCurrentViewId
in class FrameworkAdapter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |