org.eclipse.ecf.presence.roster
Class AbstractRosterManager

java.lang.Object
  org.eclipse.ecf.presence.roster.AbstractRosterManager

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IRosterManager

public abstract class AbstractRosterManager
extends java.lang.Object
implements IRosterManager

Field Summary

protected IRoster

roster

Constructor Summary

AbstractRosterManager()

AbstractRosterManager(IRoster roster)

Method Summary

void	addRosterListener(IRosterListener listener) Add roster listener to receive roster add/update/remove events for this roster manager
void	addRosterSubscriptionListener(IRosterSubscriptionListener listener) Setup listener for handling roster subscription requests.
void	disconnect()
protected void	fireRosterAdd(IRosterEntry entry)
protected void	fireRosterRemove(IRosterEntry entry)
protected void	fireRosterUpdate(IRosterItem changedItem)
protected void	fireSubscriptionListener(ID fromID, IPresence.Type presencetype)
java.lang.Object	getAdapter(java.lang.Class adapter)
abstract IPresenceSender	getPresenceSender() Retrieve interface for sending presence updates.
IRoster	getRoster() Get roster for this account.
abstract IRosterSubscriptionSender	getRosterSubscriptionSender() Get roster subscription sender.
void	removeRosterListener(IRosterListener listener) Remove roster listener
void	removeRosterSubscriptionListener(IRosterSubscriptionListener listener) Remove listener for roster subscription requests.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ecf.presence.roster.IRosterManager

addPresenceListener, removePresenceListener

Field Detail

roster

protected IRoster roster

Constructor Detail

AbstractRosterManager

public AbstractRosterManager()

AbstractRosterManager

public AbstractRosterManager(IRoster roster)

Method Detail

addRosterSubscriptionListener

public void addRosterSubscriptionListener(IRosterSubscriptionListener listener)

Description copied from interface: IRosterManager

Setup listener for handling roster subscription requests. The given listener will asynchronously be called when a subscription request is received by this connected account.

Specified by:

addRosterSubscriptionListener in interface IRosterManager

Parameters:

listener - for receiving subscription requests. Must not be null.

addRosterListener

public void addRosterListener(IRosterListener listener)

Description copied from interface: IRosterManager

Add roster listener to receive roster add/update/remove events for this roster manager

Specified by:

addRosterListener in interface IRosterManager

Parameters:

listener - the listener to add. Must not be null.

fireRosterUpdate

protected void fireRosterUpdate(IRosterItem changedItem)

fireRosterAdd

protected void fireRosterAdd(IRosterEntry entry)

fireRosterRemove

protected void fireRosterRemove(IRosterEntry entry)

fireSubscriptionListener

protected void fireSubscriptionListener(ID fromID,
                                        IPresence.Type presencetype)

getPresenceSender

public abstract IPresenceSender getPresenceSender()

Description copied from interface: IRosterManager

Retrieve interface for sending presence updates. The returned IPresenceSender (if not null) can be used to send presence change messages to remote users that have access to the presence information for the connected account.

Specified by:

getPresenceSender in interface IRosterManager

Returns:

IPresenceSender. null if no presence sender available for this provider.

getRoster

public IRoster getRoster()

Description copied from interface: IRosterManager

Get roster for this account.

Specified by:

getRoster in interface IRosterManager

Returns:

IRoster for this roster manager. Will not be null.

getRosterSubscriptionSender

public abstract IRosterSubscriptionSender getRosterSubscriptionSender()

Description copied from interface: IRosterManager

Get roster subscription sender. The roster subscription sender returned by this method, if not null, may be used to send roster subscribe and unsubscribe requests

Specified by:

getRosterSubscriptionSender in interface IRosterManager

Returns:

IRosterSubscriptionSender the sender to use. If null, sending requests for roster updates are not supported.

removeRosterSubscriptionListener

public void removeRosterSubscriptionListener(IRosterSubscriptionListener listener)

Description copied from interface: IRosterManager

Remove listener for roster subscription requests.

Specified by:

removeRosterSubscriptionListener in interface IRosterManager

Parameters:

listener - the listener to remove. Will not be null.

removeRosterListener

public void removeRosterListener(IRosterListener listener)

Description copied from interface: IRosterManager

Remove roster listener

Specified by:

removeRosterListener in interface IRosterManager

Parameters:

listener - the listener to remove. Must not be null.

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

disconnect

public void disconnect()