org.sakaiproject.chat2.tool

Class PresenceObserverHelper

java.lang.Object

org.sakaiproject.chat2.tool.PresenceObserverHelper

All Implemented Interfaces:

Observer

public class PresenceObserverHelper
extends Object
implements Observer

PresenceObservingCourier is an EventObservingCourier which watches for only presence service events at a particular location, and delivers a direct refresh delivery.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.event.api.EventTrackingService	m_eventTrackingService Constructor discovered injected EventTrackingService.

Constructor Summary

Constructors

Constructor and Description
PresenceObserverHelper(org.sakaiproject.chat2.model.PresenceObserver presenceObserver, String location) This variant, watches presense changes at the specified location, and sends the notifications to that same location.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	check(Object arg) Check to see if we want to process or ignore this update.
void	endObservation()
protected void	finalize()
String	getLocation()
List<org.sakaiproject.user.api.User>	getPresentUsers()
void	removePresence()
void	update(Observable o, Object arg) This method is called whenever the observed object is changed.
void	updatePresence()

Methods inherited from class java.lang.Object

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

Field Detail

m_eventTrackingService

protected org.sakaiproject.event.api.EventTrackingService m_eventTrackingService

Constructor discovered injected EventTrackingService.

Constructor Detail

PresenceObserverHelper

public PresenceObserverHelper(org.sakaiproject.chat2.model.PresenceObserver presenceObserver,
                      String location)

This variant, watches presense changes at the specified location, and sends the notifications to that same location. The elementID is null so the main window is refreshed when the notification is received.

Parameters:

location - The location under observation *and* the location for the delivery of the events.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

endObservation

public void endObservation()

updatePresence

public void updatePresence()

removePresence

public void removePresence()

getPresentUsers

public List<org.sakaiproject.user.api.User> getPresentUsers()

getLocation

public String getLocation()

check

public boolean check(Object arg)

Check to see if we want to process or ignore this update.

Parameters:

arg - The arg from the update.

Returns:

true to continue, false to quit.

update

public void update(Observable o,
          Object arg)

This method is called whenever the observed object is changed. An application calls an Observable object's notifyObservers method to have all the object's observers notified of the change. default implementation is to cause the courier service to deliver to the interface controlled by my controller. Extensions can override.

Specified by:

update in interface Observer

Parameters:

o - the observable object.

arg - an argument passed to the notifyObservers method.