|
||||||||||
| 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(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(String key)
|
boolean |
containsRequestParameterAttribute(String key)
|
boolean |
containsSessionAttribute(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. |
Object |
getBean(String name)
Return the variable with the specified name, or null if no such bean exists. |
String |
getCurrentViewId()
Return the current JSF viewId. |
protected javax.faces.context.FacesContext |
getFacesContext()
|
String |
getInitParameter(String key)
Return the global init parameter with the specified name. |
Object |
getRequestAttribute(String key)
Get a request-scope variable. |
protected String |
getRequestContextPath()
|
Object |
getRequestParameterAttribute(String key)
Get a value from the set of input parameters sent by the user as part of the request. |
Object |
getSessionAttribute(String key)
Get a variable from the session-scope of the current user. |
void |
invokeNavigation(String navigationName)
Navigate to the specified logical destination. |
void |
redirect(String url)
Instruct the remote browser to fetch the specified URL. |
void |
setRequestAttribute(String key,
Object value)
|
void |
setSessionAttribute(String key,
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(String conversationMessagerClass)
| Method Detail |
|---|
public void beginRequest()
public void endRequest()
protected ConversationMessager createDefaultConversationMessager()
protected javax.faces.context.FacesContext getFacesContext()
public String getInitParameter(String key)
FrameworkAdapter
getInitParameter in class FrameworkAdapterpublic Object getRequestParameterAttribute(String key)
FrameworkAdapter
getRequestParameterAttribute in class FrameworkAdapterpublic boolean containsRequestParameterAttribute(String key)
containsRequestParameterAttribute in class FrameworkAdapterpublic Object getRequestAttribute(String key)
FrameworkAdapter
getRequestAttribute in class FrameworkAdapter
public void setRequestAttribute(String key,
Object value)
setRequestAttribute in class FrameworkAdapterpublic boolean containsRequestAttribute(String key)
containsRequestAttribute in class FrameworkAdapterpublic Object getSessionAttribute(String key)
FrameworkAdapter
getSessionAttribute in class FrameworkAdapter
public void setSessionAttribute(String key,
Object value)
setSessionAttribute in class FrameworkAdapterpublic boolean containsSessionAttribute(String key)
containsSessionAttribute in class FrameworkAdapterprotected String getRequestContextPath()
public void redirect(String url)
throws IOException
FrameworkAdapter
redirect in class FrameworkAdapterIOExceptionpublic Object getBean(String name)
FrameworkAdapterIn 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 FrameworkAdapterpublic void invokeNavigation(String navigationName)
FrameworkAdapterFor 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 FrameworkAdapterpublic 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 | |||||||||