Package org.cometd.oort

Class OortList<E>

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.cometd.oort.OortObject<T>

org.cometd.oort.OortContainer<List<E>>

org.cometd.oort.OortList<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

Iterable<OortObject.Info<List<E>>>, EventListener, ConfigurableServerChannel.Initializer, Oort.CometListener, org.eclipse.jetty.util.component.LifeCycle

public class OortList<E>
extends OortContainer<List<E>>

A specialized oort object whose entity is a List.

OortList specializes OortObject and allows optimized replication of elements across the cluster: instead of replicating the whole list, that may be contain a lot of elements, only elements that are added or removed are replicated.

Applications can use addAndShare(Result, Object[]) and removeAndShare(Result, Object[]) to broadcast changes related to elements, as well as OortObject.setAndShare(Object, Result) to change the whole list.

When one or more elements are changed, OortList.ElementListeners are notified. OortList.DeltaListener converts whole list updates triggered by OortObject.setAndShare(Object, Result) into events for OortList.ElementListeners, giving applications a single listener type to implement their business logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OortList.DeltaListener<E>	An implementation of OortObject.Listener that converts whole list events into OortList.ElementListener events.
static interface	OortList.ElementListener<E>	Listener for element events that update the entity list, either locally or remotely.

Nested classes/interfaces inherited from class org.cometd.oort.OortObject

OortObject.Data<T>, OortObject.Factory<T>, OortObject.Info<T>, OortObject.Listener<T>, OortObject.Merger<T,R>, OortObject.Result<R>

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.cometd.bayeux.server.ConfigurableServerChannel.Initializer

ConfigurableServerChannel.Initializer.Persistent

Nested classes/interfaces inherited from interface org.cometd.oort.Oort.CometListener

Oort.CometListener.Adapter, Oort.CometListener.Event

Field Summary

Fields inherited from class org.cometd.oort.OortObject

logger, OORT_OBJECTS_CHANNEL

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
OortList(Oort oort, String name, OortObject.Factory<List<E>> factory)

Method Summary

Modifier and Type	Method	Description
boolean	addAndShare(E... elements)	Deprecated. use addAndShare(Result, Object[]) instead
void	addAndShare(OortObject.Result<Boolean> callback, E... elements)	Adds the given elements to the local entity list, and then broadcasts the addition to all nodes in the cluster.
void	addElementListener(OortList.ElementListener<E> listener)
boolean	contains(E element)	Returns whether the given element is present in the local entity list of this node.
protected boolean	isItemUpdate(Map<String,Object> data)
boolean	isPresent(E element)	Returns whether the given element is present in one of the entity lists of all nodes.
protected void	onItem(OortObject.Info<List<E>> info, Map<String,Object> data)
boolean	removeAndShare(E... elements)	Deprecated. use removeAndShare(Result, Object[]) instead
void	removeAndShare(OortObject.Result<Boolean> callback, E... elements)	Removes the given elements to the local entity list, and then broadcasts the removal to all nodes in the cluster.
void	removeElementListener(OortList.ElementListener<E> listener)
void	removeElementListeners()

Methods inherited from class org.cometd.oort.OortContainer

cometLeft, doStop, onObject

Methods inherited from class org.cometd.oort.OortObject

addListener, cometJoined, configureChannel, deserialize, doStart, getChannelName, getFactory, getInfo, getInfoByObject, getInfos, getLocalSession, getName, getOort, iterator, merge, newInfo, notifyRemoved, notifyUpdated, pullInfo, pushInfo, removeListener, removeListeners, serialize, setAndShare, setAndShare, toString

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

OortList

public OortList(Oort oort, String name, OortObject.Factory<List<E>> factory)

Method Details

addElementListener

public void addElementListener(OortList.ElementListener<E> listener)

removeElementListener

public void removeElementListener(OortList.ElementListener<E> listener)

removeElementListeners

public void removeElementListeners()

contains

public boolean contains(E element)

Returns whether the given element is present in the local entity list of this node. Differently from isPresent(Object), only the local entity list is scanned.

Parameters:

element - the element to test for presence

Returns:

true if the element is contained in the local entity list, false otherwise

isPresent

public boolean isPresent(E element)

Returns whether the given element is present in one of the entity lists of all nodes. Differently from contains(Object) entity lists of all nodes are scanned.

Parameters:

element - the element to test for presence

Returns:

true if the element is contained in one of the entity lists of all nodes, false otherwise

addAndShare

@Deprecated public boolean addAndShare(E... elements)

Deprecated.

use addAndShare(Result, Object[]) instead

Blocking version of addAndShare(Result, Object[]), but deprecated.

This method will be removed in a future release.

Parameters:

elements - the elements to add

Returns:

whether at least one of the elements was added to the local entity list

addAndShare

public void addAndShare(OortObject.Result<Boolean> callback, E... elements)

Adds the given elements to the local entity list, and then broadcasts the addition to all nodes in the cluster.

Calling this method triggers notifications OortList.ElementListeners, both on this node and on remote nodes.

The element is guaranteed to be added not when this method returns, but when the OortObject.Result parameter is notified.

Parameters:

callback - the callback invoked with whether at least one of the elements was added to the local entity list or null if there is no interest in knowing whether elements were added

elements - the elements to add

removeAndShare

@Deprecated public boolean removeAndShare(E... elements)

Deprecated.

use removeAndShare(Result, Object[]) instead

Blocking version of removeAndShare(Result, Object[]), but deprecated.

This method will be removed in a future release.

Parameters:

elements - the elements to remove

Returns:

whether at least one of the elements was removed from the local entity list

removeAndShare

public void removeAndShare(OortObject.Result<Boolean> callback, E... elements)

Removes the given elements to the local entity list, and then broadcasts the removal to all nodes in the cluster.

Calling this method triggers notifications OortList.ElementListeners, both on this node and on remote nodes.

The element is guaranteed to be removed not when this method returns, but when the OortObject.Result parameter is notified.

Parameters:

callback - the callback invoked with whether at least one of the elements was removed to the local entity list or null if there is no interest in knowing whether elements were removed

elements - the elements to remove

isItemUpdate

protected boolean isItemUpdate(Map<String,Object> data)

Specified by:

isItemUpdate in class OortContainer<List<E>>

onItem

protected void onItem(OortObject.Info<List<E>> info, Map<String,Object> data)

Specified by:

onItem in class OortContainer<List<E>>