org.wicketstuff.push.cometd

Class CometdPushService

java.lang.Object

org.wicketstuff.push.AbstractPushService

org.wicketstuff.push.cometd.CometdPushService

All Implemented Interfaces:

IPushService

public class CometdPushService
extends AbstractPushService

Cometd based implementation of IPushService.

This implementation relies on cometd for updating the page, but actually uses regular cometd events, that will trigger a Wicket AJAX call to get the page actually refreshed using regular Wicket AJAX mechanisms.

This mean that each time an event is published, a new connection is made to the server to get the actual page update performed by the IPushEventHandler.

Author:

Xavier Hanin, Rodolfo Hansen, Sebastian Thomschke

Field Summary

Fields inherited from class org.wicketstuff.push.AbstractPushService

disconnectListeners, nodesByChannels

Method Summary

Methods

Modifier and Type	Method and Description
static CometdPushService	get()
static CometdPushService	get(org.apache.wicket.protocol.http.WebApplication application)
static IPushServiceRef<CometdPushService>	getRef()
<EventType> CometdPushNode<EventType>	installNode(org.apache.wicket.Component component, IPushEventHandler<EventType> handler)
boolean	isConnected(IPushNode<?> node) Determines if the node (client) is still connected, otherwise clears all queued events.
<EventType> void	publish(IPushChannel<EventType> channel, EventType event)
<EventType> void	publish(IPushNode<EventType> node, EventType event) Queues the given event for later processing by the associated IPushEventHandler.
<EventType> void	publishJavascript(CometdPushNode<EventType> node, String javascript) Directly sends JavaScript code to the node via a cometd channel without an additional Wicket AJAX request roundtrip.
<EventType> void	publishJavascript(PushChannel<EventType> channel, String javascript) Directly sends JavaScript code to all nodes listeing to the given push channel via a cometd channel without an additional Wicket AJAX request roundtrip.
void	uninstallNode(org.apache.wicket.Component component, IPushNode<?> node)

Methods inherited from class org.wicketstuff.push.AbstractPushService

addNodeDisconnectedListener, connectToChannel, createChannel, disconnectFromAllChannels, disconnectFromChannel, removeChannel, removeNodeDisconnectedListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static CometdPushService get()

get

public static CometdPushService get(org.apache.wicket.protocol.http.WebApplication application)

getRef

public static IPushServiceRef<CometdPushService> getRef()

Returns:

a serializable service reference

installNode

public <EventType> CometdPushNode<EventType> installNode(org.apache.wicket.Component component,
                                                IPushEventHandler<EventType> handler)

isConnected

public boolean isConnected(IPushNode<?> node)

Determines if the node (client) is still connected, otherwise clears all queued events.

publish

public <EventType> void publish(IPushChannel<EventType> channel,
                       EventType event)

publish

public <EventType> void publish(IPushNode<EventType> node,
                       EventType event)

Queues the given event for later processing by the associated IPushEventHandler. The method does nothing in case the node is no longer connected.

publishJavascript

public <EventType> void publishJavascript(CometdPushNode<EventType> node,
                                 String javascript)

Directly sends JavaScript code to the node via a cometd channel without an additional Wicket AJAX request roundtrip.

publishJavascript

public <EventType> void publishJavascript(PushChannel<EventType> channel,
                                 String javascript)

Directly sends JavaScript code to all nodes listeing to the given push channel via a cometd channel without an additional Wicket AJAX request roundtrip.

uninstallNode

public void uninstallNode(org.apache.wicket.Component component,
                 IPushNode<?> node)