|
ICEfaces Core 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.icefaces.application.PushRenderer
public class PushRenderer
The PushRenderer
allows an application to initiate
rendering asynchronously and independently of user interaction for a
group of sessions or views. When a session is rendered, all windows or
views that a particular user has open in their session will be updated via
Ajax Push with the current application state.
Field Summary | |
---|---|
static java.lang.String |
ALL_SESSIONS
|
Constructor Summary | |
---|---|
PushRenderer()
|
Method Summary | |
---|---|
static void |
addCurrentSession(java.lang.String groupName)
All subsequently created views in the current session will be added to the specified group. |
static void |
addCurrentView(java.lang.String groupName)
Add the current view to the specified group. |
static java.util.Set<java.lang.String> |
getCurrentSessionPushIDSet()
Gets the Set of Push IDs associated with the current session. |
static java.lang.String |
getCurrentViewPushID()
Gets the Push ID associated with the current view. |
static PortableRenderer |
getPortableRenderer()
Create a PortableRenderer instance. |
static PortableRenderer |
getPortableRenderer(javax.servlet.ServletContext servletContext)
|
static org.icepush.PushContext |
getPushContext()
Get the push context. |
static void |
removeCurrentSession(java.lang.String groupName)
Remove the current views from the specified group. |
static void |
removeCurrentView(java.lang.String groupName)
Remove the current view from the specified group. |
static void |
render(java.lang.String groupName)
Render the specified group of sessions by performing the JavaServer Faces execute and render lifecycle phases. |
static void |
render(java.lang.String group,
org.icefaces.application.PushOptions options)
Render message to the specified group of sessions but only to the clients that have their blocking connection paused. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ALL_SESSIONS
Constructor Detail |
---|
public PushRenderer()
Method Detail |
---|
public static void addCurrentView(java.lang.String groupName)
groupName
- the name of the group to add the current view topublic static java.lang.String getCurrentViewPushID()
null
if ICEpush is not present.
java.lang.RuntimeException
- if the current thread is not a JSF thread.public static void removeCurrentView(java.lang.String groupName)
groupName
- the name of the group to remove the current view frompublic static void addCurrentSession(java.lang.String groupName)
groupName
- the name of the group to add the current session topublic static java.util.Set<java.lang.String> getCurrentSessionPushIDSet()
null
if ICEpush is not present.
java.lang.RuntimeException
- if the current thread is not a JSF thread.public static void removeCurrentSession(java.lang.String groupName)
groupName
- the name of the group to remove the current view frompublic static org.icepush.PushContext getPushContext()
null
if ICEpush is not present.
java.lang.RuntimeException
- if the current thread is not a JSF thread.public static void render(java.lang.String groupName)
groupName
- the name of the group of sessions to render.public static void render(java.lang.String group, org.icefaces.application.PushOptions options)
group
- the name of the group of sessions to render.options
- options for this push requestpublic static PortableRenderer getPortableRenderer()
public static PortableRenderer getPortableRenderer(javax.servlet.ServletContext servletContext)
|
ICEfaces Core 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |