de.hybris.platform.cockpit.components

Class PushComponent<T extends PushController>

java.lang.Object

Span

de.hybris.platform.cockpit.components.PushComponent<T>

All Implemented Interfaces:

DesktopRemovalAwareComponent

public class PushComponent<T extends PushController>
extends Span
implements DesktopRemovalAwareComponent

A push component is a component which allows ZK components to be updated asynchronously using reverse Ajax.

Together with a PushController it enables server push in a Cockpit application. A push component is responsible for handling the execution of its PushController and sending CockpitEvents in an asynchronous fashion. It does not allow any child components to be added and should not be used for visually displaying content.

Each push component typically has (or creates) its own PushController instance, typically implemented as a Java thread. The PushController (thread) is started as soon as the push component has been rendered by the browser using ZK's timer events.

Note: Each thread is gently stopped (within the duration of the specified update interval) once the desktop to which this push component belongs has been removed. However, in order to avoid excessive creation of threads a push component should typically be added to a relatively "long-lived" component e.g. the ZK application's root component.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_DELAY

Constructor Summary

Constructors

Constructor and Description
PushComponent(Class<T> controllerClass) Creates a new push component instance with the default update interval and a PushController of the class specified by controllerClass.
PushComponent(Class<T> controllerClass, int updateInterval) Creates a new push component instance with the specified update interval and a PushController of the class specified by controllerClass.
PushComponent(T controller) Creates a new push component instance with the specified PushController controller with an update interval set to the value of controller's update interval.
PushComponent(T controller, int updateInterval) Creates a new push component instance with the specified PushController controller and an update interval of updateInterval milliseconds.

Method Summary

Modifier and Type	Method and Description
void	addEvent(CockpitEvent event) Adds an event to this push components internal event queue.
protected void	appendChildInternal(Component child)
void	clearEvents() Clears the event queue i.e.
void	desktopRemoved(Desktop desktop)
void	detach()
void	dispatchEvents() Dispatches the queued events.
List<CockpitEvent>	getEvents() Returns the events in the internal event queue.
boolean	insertBefore(Component newChild, Component refChild)
void	setParent(Component parent)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DELAY

protected static final int DEFAULT_DELAY

See Also:

Constant Field Values

Constructor Detail

PushComponent

public PushComponent(Class<T> controllerClass)
              throws IllegalArgumentException,
                     InstantiationException,
                     IllegalAccessException

Creates a new push component instance with the default update interval and a PushController of the class specified by controllerClass.

Parameters:

controllerClass - the class of the push controller to be used

Throws:

IllegalArgumentException - if the push controller could not be created

InstantiationException - if the push controller could not be created

IllegalAccessException - if the push controller could not be created

See Also:

PushComponent(Class, int), PushComponent(PushController), PushComponent(PushController, int)

PushComponent

public PushComponent(Class<T> controllerClass,
                     int updateInterval)
              throws IllegalArgumentException,
                     InstantiationException,
                     IllegalAccessException

Creates a new push component instance with the specified update interval and a PushController of the class specified by controllerClass.

Parameters:

controllerClass - the class of the push controller to be used

updateInterval - the update interval in milliseconds

Throws:

IllegalArgumentException - if the push controller could not be created

InstantiationException - if the push controller could not be created

IllegalAccessException - if the push controller could not be created

See Also:

PushComponent(Class), PushComponent(PushController), PushComponent(PushController, int)

PushComponent

public PushComponent(T controller)

Creates a new push component instance with the specified PushController controller with an update interval set to the value of controller's update interval.

Parameters:

controller - the push controller

See Also:

PushComponent(PushController, int), PushComponent(Class), PushComponent(Class, int)

PushComponent

public PushComponent(T controller,
                     int updateInterval)

Creates a new push component instance with the specified PushController controller and an update interval of updateInterval milliseconds.

Parameters:

controller - the push controller

updateInterval - the update interval in milliseconds

Method Detail

insertBefore

public boolean insertBefore(Component newChild,
                            Component refChild)

appendChildInternal

protected void appendChildInternal(Component child)

clearEvents

public void clearEvents()

Clears the event queue i.e. removes all the previously queued events.

addEvent

public void addEvent(CockpitEvent event)

Adds an event to this push components internal event queue.

The events are typically dispatched as soon as control is returned from the push controller thread.

Parameters:

event - the event to be dispatched

getEvents

public List<CockpitEvent> getEvents()

Returns the events in the internal event queue.

Returns:

the queued events

dispatchEvents

public void dispatchEvents()

Dispatches the queued events.

desktopRemoved

public void desktopRemoved(Desktop desktop)

Specified by:

desktopRemoved in interface DesktopRemovalAwareComponent

detach

public void detach()

setParent

public void setParent(Component parent)