tigase.jaxmpp.core.client.xmpp.modules.presence

Class PresenceModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Presence>

tigase.jaxmpp.core.client.xmpp.modules.presence.PresenceModule

All Implemented Interfaces:

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

public class PresenceModule
extends tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Presence>
implements tigase.jaxmpp.core.client.xmpp.modules.InitializingModule, tigase.jaxmpp.core.client.xmpp.modules.ContextAware, tigase.jaxmpp.core.client.XmppSessionLogic.XmppSessionEstablishedHandler

Module for handling presence information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PresenceModule.BeforePresenceSendHandler Event fired before each presence sent by client.
static interface	PresenceModule.ContactAvailableHandler Event fired when contact (understood as bare JID) becomes available.
static interface	PresenceModule.ContactChangedPresenceHandler Event fired when contact changed his presence.
static interface	PresenceModule.ContactUnavailableHandler Event fired when contact (understood as bare JID) goes offline.
static interface	PresenceModule.ContactUnsubscribedHandler Event fired when contact is unsubscribed.
static interface	PresenceModule.SubscribeRequestHandler Event fired when subscription request is received.

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	INITIAL_PRESENCE_ENABLED_KEY
static String	PRESENCE_STORE_KEY

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

context, log

Constructor Summary

Constructors

Constructor and Description
PresenceModule()

Method Summary

Modifier and Type	Method and Description
void	addBeforePresenceSendHandler(PresenceModule.BeforePresenceSendHandler handler)
void	addContactAvailableHandler(PresenceModule.ContactAvailableHandler handler)
void	addContactChangedPresenceHandler(PresenceModule.ContactChangedPresenceHandler handler)
void	addContactUnavailableHandler(PresenceModule.ContactUnavailableHandler handler)
void	addContactUnsubscribedHandler(PresenceModule.ContactUnsubscribedHandler handler)
void	addSubscribeRequestHandler(PresenceModule.SubscribeRequestHandler handler)
void	afterRegister()
void	beforeRegister()
void	beforeUnregister()
protected void	contactOffline(tigase.jaxmpp.core.client.xmpp.stanzas.Presence i, tigase.jaxmpp.core.client.JID jid)
tigase.jaxmpp.core.client.criteria.Criteria	getCriteria()
String[]	getFeatures()
PresenceStore	getPresenceStore()
static PresenceStore	getPresenceStore(tigase.jaxmpp.core.client.SessionObject sessionObject)
void	onXmppSessionEstablished(tigase.jaxmpp.core.client.SessionObject sessionObject)
void	process(tigase.jaxmpp.core.client.xmpp.stanzas.Presence presence)
void	removeBeforePresenceSendHandler(PresenceModule.BeforePresenceSendHandler handler)
void	removeContactAvailableHandler(PresenceModule.ContactAvailableHandler handler)
void	removeContactChangedPresenceHandler(PresenceModule.ContactChangedPresenceHandler handler)
void	removeContactUnavailableHandler(PresenceModule.ContactUnavailableHandler handler)
void	removeContactUnsubscribedHandler(PresenceModule.ContactUnsubscribedHandler handler)
void	removeSubscribeRequestHandler(PresenceModule.SubscribeRequestHandler handler)
void	sendInitialPresence()
void	setContext(tigase.jaxmpp.core.client.Context context)
void	setInitialPresence(boolean enabled)
void	setPresence(tigase.jaxmpp.core.client.xmpp.stanzas.Presence.Show show, String status, Integer priority) Sends own presence.
static void	setPresenceStore(tigase.jaxmpp.core.client.SessionObject sessionObject, PresenceStore presenceStore)
void	subscribe(tigase.jaxmpp.core.client.JID jid) Subscribe for presence.
void	subscribed(tigase.jaxmpp.core.client.JID jid)
void	unsubscribe(tigase.jaxmpp.core.client.JID jid)
void	unsubscribed(tigase.jaxmpp.core.client.JID jid)

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

fireEvent, getFirstChild, process, write, write, write

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

PRESENCE_STORE_KEY

public static final String PRESENCE_STORE_KEY

See Also:

Constant Field Values

INITIAL_PRESENCE_ENABLED_KEY

public static final String INITIAL_PRESENCE_ENABLED_KEY

See Also:

Constant Field Values

Constructor Detail

PresenceModule

public PresenceModule()

Method Detail

getPresenceStore

public static PresenceStore getPresenceStore(tigase.jaxmpp.core.client.SessionObject sessionObject)

setPresenceStore

public static void setPresenceStore(tigase.jaxmpp.core.client.SessionObject sessionObject,
                                    PresenceStore presenceStore)

addBeforePresenceSendHandler

public void addBeforePresenceSendHandler(PresenceModule.BeforePresenceSendHandler handler)

addContactAvailableHandler

public void addContactAvailableHandler(PresenceModule.ContactAvailableHandler handler)

addContactChangedPresenceHandler

public void addContactChangedPresenceHandler(PresenceModule.ContactChangedPresenceHandler handler)

addContactUnavailableHandler

public void addContactUnavailableHandler(PresenceModule.ContactUnavailableHandler handler)

addContactUnsubscribedHandler

public void addContactUnsubscribedHandler(PresenceModule.ContactUnsubscribedHandler handler)

addSubscribeRequestHandler

public void addSubscribeRequestHandler(PresenceModule.SubscribeRequestHandler handler)

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.Presence>

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.Presence>

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.Presence>

contactOffline

protected void contactOffline(tigase.jaxmpp.core.client.xmpp.stanzas.Presence i,
                              tigase.jaxmpp.core.client.JID jid)
                       throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

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

getPresenceStore

public PresenceStore getPresenceStore()

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

process

public void process(tigase.jaxmpp.core.client.xmpp.stanzas.Presence presence)
             throws tigase.jaxmpp.core.client.exceptions.JaxmppException

Specified by:

process in class tigase.jaxmpp.core.client.xmpp.modules.AbstractStanzaModule<tigase.jaxmpp.core.client.xmpp.stanzas.Presence>

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

removeBeforePresenceSendHandler

public void removeBeforePresenceSendHandler(PresenceModule.BeforePresenceSendHandler handler)

removeContactAvailableHandler

public void removeContactAvailableHandler(PresenceModule.ContactAvailableHandler handler)

removeContactChangedPresenceHandler

public void removeContactChangedPresenceHandler(PresenceModule.ContactChangedPresenceHandler handler)

removeContactUnavailableHandler

public void removeContactUnavailableHandler(PresenceModule.ContactUnavailableHandler handler)

removeContactUnsubscribedHandler

public void removeContactUnsubscribedHandler(PresenceModule.ContactUnsubscribedHandler handler)

removeSubscribeRequestHandler

public void removeSubscribeRequestHandler(PresenceModule.SubscribeRequestHandler handler)

sendInitialPresence

public void sendInitialPresence()
                         throws tigase.jaxmpp.core.client.xml.XMLException,
                                tigase.jaxmpp.core.client.exceptions.JaxmppException

Throws:

tigase.jaxmpp.core.client.xml.XMLException

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.Presence>

setInitialPresence

public void setInitialPresence(boolean enabled)

setPresence

public void setPresence(tigase.jaxmpp.core.client.xmpp.stanzas.Presence.Show show,
                        String status,
                        Integer priority)
                 throws tigase.jaxmpp.core.client.xml.XMLException,
                        tigase.jaxmpp.core.client.exceptions.JaxmppException

Sends own presence.

Parameters:

show - presence substate.

status - human readable description of status.

priority - priority.

Throws:

tigase.jaxmpp.core.client.xml.XMLException

tigase.jaxmpp.core.client.exceptions.JaxmppException

subscribe

public void subscribe(tigase.jaxmpp.core.client.JID jid)
               throws tigase.jaxmpp.core.client.exceptions.JaxmppException,
                      tigase.jaxmpp.core.client.xml.XMLException

Subscribe for presence.

Parameters:

jid - JID

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

tigase.jaxmpp.core.client.xml.XMLException

subscribed

public void subscribed(tigase.jaxmpp.core.client.JID jid)
                throws tigase.jaxmpp.core.client.exceptions.JaxmppException,
                       tigase.jaxmpp.core.client.xml.XMLException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

tigase.jaxmpp.core.client.xml.XMLException

unsubscribe

public void unsubscribe(tigase.jaxmpp.core.client.JID jid)
                 throws tigase.jaxmpp.core.client.exceptions.JaxmppException,
                        tigase.jaxmpp.core.client.xml.XMLException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

tigase.jaxmpp.core.client.xml.XMLException

unsubscribed

public void unsubscribed(tigase.jaxmpp.core.client.JID jid)
                  throws tigase.jaxmpp.core.client.exceptions.JaxmppException,
                         tigase.jaxmpp.core.client.xml.XMLException

Throws:

tigase.jaxmpp.core.client.exceptions.JaxmppException

tigase.jaxmpp.core.client.xml.XMLException