tigase.jaxmpp.core.client.xmpp.modules.roster

Class RosterModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<T>

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

tigase.jaxmpp.core.client.xmpp.modules.roster.RosterModule

All Implemented Interfaces:

tigase.jaxmpp.core.client.eventbus.EventHandler, tigase.jaxmpp.core.client.xmpp.modules.ContextAware, tigase.jaxmpp.core.client.xmpp.modules.extensions.ExtendableModule, tigase.jaxmpp.core.client.xmpp.modules.InitializingModule, tigase.jaxmpp.core.client.XmppModule, tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler

public class RosterModule
extends tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule
implements tigase.jaxmpp.core.client.xmpp.modules.ContextAware, tigase.jaxmpp.core.client.xmpp.modules.InitializingModule, tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler

Module for roster manipulation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RosterModule.Action
static interface	RosterModule.ItemAddedHandler
static interface	RosterModule.ItemRemovedHandler
static interface	RosterModule.ItemUpdatedHandler

Nested classes/interfaces inherited from interface tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler

tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler.XmppSessionEstablishedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static tigase.jaxmpp.core.client.criteria.Criteria	CRIT
static String	ROSTER_STORE_KEY

Fields inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

context, log

Constructor Summary

Constructors

Constructor and Description
RosterModule()
RosterModule(RosterCacheProvider versionProvider)

Method Summary

Modifier and Type	Method and Description
protected void	add(tigase.jaxmpp.core.client.BareJID jid, String name, Collection<String> groups, tigase.jaxmpp.core.client.AsyncCallback asyncCallback)
void	afterRegister()
void	beforeRegister()
void	beforeUnregister()
tigase.jaxmpp.core.client.criteria.Criteria	getCriteria()
String[]	getFeatures()
RosterStore	getRosterStore()
static RosterStore	getRosterStore(tigase.jaxmpp.core.client.SessionObject sessionObject)
RosterCacheProvider	getVersionProvider()
protected void	onRosterCleared()
void	onXmppSessionEstablished(tigase.jaxmpp.core.client.SessionObject sessionObject)
protected void	processGet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
protected void	processSet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ stanza)
protected void	remove(tigase.jaxmpp.core.client.BareJID jid)
void	rosterRequest() Requests for roster.
void	setContext(tigase.jaxmpp.core.client.Context context)
static void	setRosterStore(tigase.jaxmpp.core.client.SessionObject sessionObject, RosterStore rosterStore)
protected void	update(RosterItem item)

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

process

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaExtendableModule

addExtension, getExtensionChain, getFeaturesWithExtensions, removeExtension, write, write, write

Methods inherited from class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule

fireEvent, getFirstChild, process

Methods inherited from class java.lang.Object

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

Field Detail

CRIT

public static final tigase.jaxmpp.core.client.criteria.Criteria CRIT

ROSTER_STORE_KEY

public static final String ROSTER_STORE_KEY

See Also:

Constant Field Values

Constructor Detail

RosterModule

public RosterModule()

RosterModule

public RosterModule(RosterCacheProvider versionProvider)

Method Detail

getRosterStore

public static RosterStore getRosterStore(tigase.jaxmpp.core.client.SessionObject sessionObject)

setRosterStore

public static void setRosterStore(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                  RosterStore rosterStore)

add

protected void add(tigase.jaxmpp.core.client.BareJID jid,
                   String name,
                   Collection<String> groups,
                   tigase.jaxmpp.core.client.AsyncCallback asyncCallback)
            throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

afterRegister

public void afterRegister()

Specified by:

afterRegister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

afterRegister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

beforeRegister

public void beforeRegister()

Specified by:

beforeRegister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

beforeRegister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

beforeUnregister

public void beforeUnregister()

Specified by:

beforeUnregister in interface tigase.jaxmpp.core.client.xmpp.modules.InitializingModule

Overrides:

beforeUnregister in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

getCriteria

public tigase.jaxmpp.core.client.criteria.Criteria getCriteria()

Specified by:

getCriteria in interface tigase.jaxmpp.core.client.XmppModule

getFeatures

public String[] getFeatures()

Specified by:

getFeatures in interface tigase.jaxmpp.core.client.XmppModule

getRosterStore

public RosterStore getRosterStore()

getVersionProvider

public RosterCacheProvider getVersionProvider()

onRosterCleared

protected void onRosterCleared()

onXmppSessionEstablished

public void onXmppSessionEstablished(tigase.jaxmpp.core.client.SessionObject sessionObject)
                              throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

onXmppSessionEstablished in interface tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

processGet

protected void processGet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ element)
                   throws tigase.jaxmpp.core.client.XMPPException,
                          tigase.jaxmpp.core.client.xml.XMLException

Specified by:

processGet in class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

Throws:

tigase.jaxmpp.core.client.XMPPException

tigase.jaxmpp.core.client.xml.XMLException

processSet

protected void processSet(tigase.jaxmpp.core.client.xmpp.stanzas.IQ stanza)
                   throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

processSet in class tigase.jaxmpp.core.client.xmpp.modules.AbstractIQModule

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

remove

protected void remove(tigase.jaxmpp.core.client.BareJID jid)
               throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

rosterRequest

public void rosterRequest()
                   throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Requests for roster. Roster will be send by server asynchronously.

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

setContext

public void setContext(tigase.jaxmpp.core.client.Context context)

Specified by:

setContext in interface tigase.jaxmpp.core.client.xmpp.modules.ContextAware

Overrides:

setContext in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.IQ>

update

protected void update(RosterItem item)
               throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException