net.java.sip.communicator.service.protocol.event
Interface SubscriptionListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

OperationSetMultiUserChatJabberImpl, SubscriptionAdapter

public interface SubscriptionListener
extends EventListener

Instances of this interface would listen for events generated as a result of creating or removing a presence subscription through the subscribe and unsubscribe methods of the OperationSetPresence and OperationSetPersistentPresence operation sets.

Note that these are events that are most often triggered by remote/server side messages. This means that users of the protocol provider service (such as the User Interface for example) should wait for one of them before announcing a subscription as created or deleted (i.e. before showing or removing a user in/from a displayed contact list).

Author:

Emil Ivov

Method Summary

void	contactModified(ContactPropertyChangeEvent evt) Indicates that the source contact has had one of its properties changed.
void	subscriptionCreated(SubscriptionEvent evt) Indicates that a subscription has been successfully created and accepted by the remote party.
void	subscriptionFailed(SubscriptionEvent evt) Indicates that a subscription has failed and/or was not accepted by the remote party.
void	subscriptionMoved(SubscriptionMovedEvent evt) Indicates that a contact/subscription has been moved from one server stored group to another.
void	subscriptionRemoved(SubscriptionEvent evt) Indicates that a subscription has been successfully removed and that the remote party has acknowledged its removal.
void	subscriptionResolved(SubscriptionEvent evt) Indicates that a subscription has been successfully resolved and that the server has acknowledged taking it into account.

Method Detail

subscriptionCreated

void subscriptionCreated(SubscriptionEvent evt)

Indicates that a subscription has been successfully created and accepted by the remote party.

Parameters:

evt - the SubscriptionEvent containing the corresponding contact

subscriptionFailed

void subscriptionFailed(SubscriptionEvent evt)

Indicates that a subscription has failed and/or was not accepted by the remote party.

Parameters:

evt - the SubscriptionEvent containing the corresponding contact

subscriptionRemoved

void subscriptionRemoved(SubscriptionEvent evt)

Indicates that a subscription has been successfully removed and that the remote party has acknowledged its removal.

Parameters:

evt - the SubscriptionEvent containing the corresponding contact

subscriptionMoved

void subscriptionMoved(SubscriptionMovedEvent evt)

Indicates that a contact/subscription has been moved from one server stored group to another. The method would only be called by implementations of OperationSetPersistentPresence as non persistent presence operation sets do not support the notion of server stored groups.

Parameters:

evt - a reference to the SubscriptionMovedEvent containing previous and new parents as well as a ref to the source contact.

subscriptionResolved

void subscriptionResolved(SubscriptionEvent evt)

Indicates that a subscription has been successfully resolved and that the server has acknowledged taking it into account.

Parameters:

evt - the SubscriptionEvent containing the source contact

contactModified

void contactModified(ContactPropertyChangeEvent evt)

Indicates that the source contact has had one of its properties changed.

Parameters:

evt - the ContactPropertyChangeEvent containing the source contact and the old and new values of the changed property.