rocks.xmpp.extensions.rosterx

Class ContactExchangeManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.rosterx.ContactExchangeManager

public final class ContactExchangeManager
extends ExtensionManager

Manages contact exchange between entities.

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	addContactExchangeListener(ContactExchangeListener contactExchangeListener) Adds a contact exchange listener.
ContactExchange.Item.Action	approve(ContactExchange.Item item) Approves a roster exchange item by modifying the roster accordingly.
Collection<rocks.xmpp.core.Jid>	getTrustedEntities() Gets a collection of trusted entities for which roster item exchange suggestions are approved automatically (no listeners will be called).
void	removeContactExchangeListener(ContactExchangeListener contactExchangeListener) Removes a previously added contact exchange listener.
void	suggestContactAddition(rocks.xmpp.core.Jid jid, rocks.xmpp.core.roster.model.Contact... contacts) Suggests the addition of one or more contacts to another user.

Methods inherited from class rocks.xmpp.core.session.ExtensionManager

setEnabled

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

getTrustedEntities

public Collection<rocks.xmpp.core.Jid> getTrustedEntities()

Gets a collection of trusted entities for which roster item exchange suggestions are approved automatically (no listeners will be called). The JIDs contained in this collection must be bare JIDs.

Returns:

The trusted entities.

See Also:

8.1 Trusted Entities

suggestContactAddition

public void suggestContactAddition(rocks.xmpp.core.Jid jid,
                                   rocks.xmpp.core.roster.model.Contact... contacts)
                            throws rocks.xmpp.core.XmppException

Suggests the addition of one or more contacts to another user.

Parameters:

jid - The recipient.

contacts - The contacts

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

approve

public ContactExchange.Item.Action approve(ContactExchange.Item item)
                                    throws rocks.xmpp.core.XmppException

Approves a roster exchange item by modifying the roster accordingly.

If the item is to be added and does not yet exist, it will be added to your roster and you are subscribed to its presence.
If it already exists in your roster but in a different group than suggested, it will additionally be added to the suggested group.

If the item is to be deleted, it will be deleted from your roster, if the suggested group(s) matches the same group(s) in your roster.
Otherwise it will be edited, so that it no longer belongs to the suggested groups.

If the item is to be modified, it will be modified accordingly, if it exists.

Parameters:

item - The roster exchange item.

Returns:

The action, which was actually performed. This may vary from the specified action, e.g. if you add a contact that already exists, only its groups are updated. If no action was performed, e.g. if you want to delete a contact, that does not exist, null is returned.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

addContactExchangeListener

public void addContactExchangeListener(ContactExchangeListener contactExchangeListener)

Adds a contact exchange listener.

Parameters:

contactExchangeListener - The listener.

See Also:

removeContactExchangeListener(ContactExchangeListener)

removeContactExchangeListener

public void removeContactExchangeListener(ContactExchangeListener contactExchangeListener)

Removes a previously added contact exchange listener.

Parameters:

contactExchangeListener - The listener.

See Also:

addContactExchangeListener(ContactExchangeListener)