Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.myfaces.orchestra.frameworkAdapter.jsf
Class JsfFrameworkAdapter

    java.lang.Object
      org.apache.myfaces.orchestra.frameworkAdapter.FrameworkAdapter
          org.apache.myfaces.orchestra.frameworkAdapter.jsf.JsfFrameworkAdapter

    public class JsfFrameworkAdapter

extends FrameworkAdapter

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

### JsfFrameworkAdapter

    public JsfFrameworkAdapter(String conversationMessagerClass)

Method Detail

### beginRequest

    public void beginRequest()

  This method should be invoked at the start of each JSF request cycle, before any Orchestra functionality is invoked.

  Since:
    1.1

### endRequest

    public void endRequest()

  This method should be invoked at the end of each JSF request cycle, after the last Orchestra functionality is invoked.

  Since:
    1.1

### createDefaultConversationMessager

    protected ConversationMessager createDefaultConversationMessager()

### getFacesContext

    protected javax.faces.context.FacesContext getFacesContext()

### getInitParameter

    public String getInitParameter(String key)

  Description copied from class: `FrameworkAdapter`
  Return the global init parameter with the specified name. In most cases this is expected to return data from the ServletContext.

  Specified by:
    `getInitParameter` in class `FrameworkAdapter`

### getRequestParameterAttribute

    public Object getRequestParameterAttribute(String key)

  Description copied from class: `FrameworkAdapter`
  Get a value from the set of input parameters sent by the user as part of the request.

  Specified by:
    `getRequestParameterAttribute` in class `FrameworkAdapter`

### containsRequestParameterAttribute

    public boolean containsRequestParameterAttribute(String key)

  Specified by:
    `containsRequestParameterAttribute` in class `FrameworkAdapter`

### getRequestAttribute

    public Object getRequestAttribute(String key)

  Description copied from class: `FrameworkAdapter`
  Get a request-scope variable.

  Specified by:
    `getRequestAttribute` in class `FrameworkAdapter`

### setRequestAttribute

    public void setRequestAttribute(String key,
                                    Object value)

  Specified by:
    `setRequestAttribute` in class `FrameworkAdapter`

### containsRequestAttribute

    public boolean containsRequestAttribute(String key)

  Specified by:
    `containsRequestAttribute` in class `FrameworkAdapter`

### getSessionAttribute

    public Object getSessionAttribute(String key)

  Description copied from class: `FrameworkAdapter`
  Get a variable from the session-scope of the current user.

  Specified by:
    `getSessionAttribute` in class `FrameworkAdapter`

### setSessionAttribute

    public void setSessionAttribute(String key,
                                    Object value)

  Specified by:
    `setSessionAttribute` in class `FrameworkAdapter`

### containsSessionAttribute

    public boolean containsSessionAttribute(String key)

  Specified by:
    `containsSessionAttribute` in class `FrameworkAdapter`

### getRequestContextPath

    protected String getRequestContextPath()

### redirect

    public void redirect(String url)
                  throws IOException

  Description copied from class: `FrameworkAdapter`
  Instruct the remote browser to fetch the specified URL.

  Specified by:
    `redirect` in class `FrameworkAdapter`
  Throws:
    `IOException`

### getBean

    public Object getBean(String name)

  Description copied from class: `FrameworkAdapter`
  Return the variable with the specified name, or null if no such bean exists.

  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'.

  Specified by:
    `getBean` in class `FrameworkAdapter`

### invokeNavigation

    public void invokeNavigation(String navigationName)

  Description copied from class: `FrameworkAdapter`
  Navigate to the specified logical destination.

  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.

  Specified by:
    `invokeNavigation` in class `FrameworkAdapter`

### getCurrentViewId

    public String getCurrentViewId()

  Return the current JSF viewId.

  Null is returned if there is not yet a UIViewRoot set up for the current request.

  Overrides:
    `getCurrentViewId` in class `FrameworkAdapter`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2012 The Apache Software Foundation. All Rights Reserved.