net.java.sip.communicator.impl.protocol.yahoo
Class OperationSetPersistentPresenceYahooImpl

java.lang.Object
  net.java.sip.communicator.service.protocol.AbstractOperationSetPersistentPresence<ProtocolProviderServiceYahooImpl>
      net.java.sip.communicator.impl.protocol.yahoo.OperationSetPersistentPresenceYahooImpl

All Implemented Interfaces:

OperationSet, OperationSetPersistentPresence, OperationSetPresence

public class OperationSetPersistentPresenceYahooImpl
extends AbstractOperationSetPersistentPresence<ProtocolProviderServiceYahooImpl>

The Yahoo implementation of a Persistent Presence Operation set. This class manages our own presence status as well as subscriptions for the presence status of our buddies. It also offers methods for retrieving and modifying the buddy contact list and adding listeners for changes in its layout.

Author:

Damian Minkov

Field Summary

Fields inherited from class net.java.sip.communicator.service.protocol.AbstractOperationSetPersistentPresence

parentProvider

Constructor Summary

OperationSetPersistentPresenceYahooImpl(ProtocolProviderServiceYahooImpl provider)

Method Summary

void	addServerStoredGroupChangeListener(ServerStoredGroupListener listener) Registers a listener that would receive events upong changes in server stored groups.
void	createServerStoredContactGroup(ContactGroup parent, String groupName) Creates a group with the specified name and parent in the server stored contact list.
Contact	createUnresolvedContact(String address, String persistentData) Creates and returns a unresolved contact from the specified address and persistentData.
Contact	createUnresolvedContact(String address, String persistentData, ContactGroup parentGroup) Creates and returns a unresolved contact from the specified address and persistentData.
ContactGroup	createUnresolvedContactGroup(String groupUID, String persistentData, ContactGroup parentGroup) Creates and returns a unresolved contact group from the specified address and persistentData.
ContactYahooImpl	createVolatileContact(String id) Creates a non persistent contact for the specified address.
Contact	findContactByID(String contactID) Returns a reference to the contact with the specified ID in case we have a subscription for it and null otherwise/
protected void	fireProviderStatusChangeEvent(PresenceStatus oldStatus, PresenceStatus newStatus) Notify all provider presence listeners of the corresponding event change
String	getCurrentStatusMessage() Returns the status message that was confirmed by the serfver
Contact	getLocalContact() Returns the protocol specific contact instance representing the local user.
PresenceStatus	getPresenceStatus() Returns a PresenceStatus instance representing the state this provider is currently in.
ContactGroup	getServerStoredContactListRoot() Returns the root group of the server stored contact list.
Iterator<PresenceStatus>	getSupportedStatusSet() Returns the set of PresenceStatus objects that a user of this service may request the provider to enter.
(package private) void	handleContactStatusChange(ContactYahooImpl sourceContact, ymsg.network.YahooUser yFriend)
void	moveContactToGroup(Contact contactToMove, ContactGroup newParent) Removes the specified contact from its current parent and places it under newParent.
void	publishPresenceStatus(PresenceStatus status, String statusMessage) Requests the provider to enter into a status corresponding to the specified paramters.
PresenceStatus	queryContactStatus(String contactIdentifier) Get the PresenceStatus for a particular contact.
void	removeServerStoredContactGroup(ContactGroup group) Removes the specified group from the server stored contact list.
void	removeServerStoredGroupChangeListener(ServerStoredGroupListener listener) Removes the specified group change listener so that it won't receive any further events.
void	renameServerStoredContactGroup(ContactGroup group, String newName) Renames the specified group from the server stored contact list.
void	setAuthorizationHandler(AuthorizationHandler handler) Handler for incoming authorization requests.
void	subscribe(ContactGroup parent, String contactIdentifier) Persistently adds a subscription for the presence status of the contact corresponding to the specified contactIdentifier and indicates that it should be added to the specified group of the server stored contact list.
void	subscribe(String contactIdentifier) Adds a subscription for the presence status of the contact corresponding to the specified contactIdentifier.
void	unsubscribe(Contact contact) Removes a subscription for the presence status of the specified contact.
(package private) YahooStatusEnum	yahooStatusToPresenceStatus(long status) Converts the specified yahoo status to one of the status fields of the YahooStatusEnum class.

Methods inherited from class net.java.sip.communicator.service.protocol.AbstractOperationSetPersistentPresence

addContactPresenceStatusListener, addProviderPresenceStatusListener, addSubscriptionListener, fireContactPresenceStatusChangeEvent, fireContactPresenceStatusChangeEvent, fireContactPropertyChangeEvent, fireProviderStatusChangeEvent, fireProviderStatusMessageChangeEvent, fireServerStoredGroupEvent, fireSubscriptionEvent, fireSubscriptionEvent, fireSubscriptionMovedEvent, removeContactPresenceStatusListener, removeProviderPresenceStatusListener, removeSubscriptionListener, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationSetPersistentPresenceYahooImpl

public OperationSetPersistentPresenceYahooImpl(ProtocolProviderServiceYahooImpl provider)

Method Detail

addServerStoredGroupChangeListener

public void addServerStoredGroupChangeListener(ServerStoredGroupListener listener)

Registers a listener that would receive events upong changes in server stored groups.

Specified by:

addServerStoredGroupChangeListener in interface OperationSetPersistentPresence

Overrides:

addServerStoredGroupChangeListener in class AbstractOperationSetPersistentPresence<ProtocolProviderServiceYahooImpl>

Parameters:

listener - a ServerStoredGroupChangeListener impl that would receive events upong group changes.

createServerStoredContactGroup

public void createServerStoredContactGroup(ContactGroup parent,
                                           String groupName)
                                    throws OperationFailedException

Creates a group with the specified name and parent in the server stored contact list.

Parameters:

parent - the group where the new group should be created

groupName - the name of the new group to create.

Throws:

OperationFailedException - if such group already exists

createVolatileContact

public ContactYahooImpl createVolatileContact(String id)

Creates a non persistent contact for the specified address. This would also create (if necessary) a group for volatile contacts that would not be added to the server stored contact list. The volatile contact would remain in the list until it is really added to the contact list or until the application is terminated.

Parameters:

id - the address of the contact to create.

Returns:

the newly created volatile ContactImpl

createUnresolvedContact

public Contact createUnresolvedContact(String address,
                                       String persistentData,
                                       ContactGroup parentGroup)

Creates and returns a unresolved contact from the specified address and persistentData.

Parameters:

address - an identifier of the contact that we'll be creating.

persistentData - a String returned Contact's getPersistentData() method during a previous run and that has been persistently stored locally.

parentGroup - the group where the unresolved contact is supposed to belong to.

Returns:

the unresolved Contact created from the specified address and persistentData

createUnresolvedContact

public Contact createUnresolvedContact(String address,
                                       String persistentData)

Creates and returns a unresolved contact from the specified address and persistentData.

Parameters:

address - an identifier of the contact that we'll be creating.

persistentData - a String returned Contact's getPersistentData() method during a previous run and that has been persistently stored locally.

Returns:

the unresolved Contact created from the specified address and persistentData

createUnresolvedContactGroup

public ContactGroup createUnresolvedContactGroup(String groupUID,
                                                 String persistentData,
                                                 ContactGroup parentGroup)

Creates and returns a unresolved contact group from the specified address and persistentData.

Parameters:

groupUID - an identifier, returned by ContactGroup's getGroupUID, that the protocol provider may use in order to create the group.

persistentData - a String returned ContactGroups's getPersistentData() method during a previous run and that has been persistently stored locally.

parentGroup - the group under which the new group is to be created or null if this is group directly underneath the root.

Returns:

the unresolved ContactGroup created from the specified uid and persistentData

findContactByID

public Contact findContactByID(String contactID)

Returns a reference to the contact with the specified ID in case we have a subscription for it and null otherwise/

Parameters:

contactID - a String identifier of the contact which we're seeking a reference of.

Returns:

a reference to the Contact with the specified contactID or null if we don't have a subscription for the that identifier.

getCurrentStatusMessage

public String getCurrentStatusMessage()

Returns the status message that was confirmed by the serfver

Returns:

the last status message that we have requested and the aim server has confirmed.

getLocalContact

public Contact getLocalContact()

Returns the protocol specific contact instance representing the local user.

Returns:

the Contact (address, phone number, or uin) that the Provider implementation is communicating on behalf of.

getPresenceStatus

public PresenceStatus getPresenceStatus()

Returns a PresenceStatus instance representing the state this provider is currently in.

Returns:

the PresenceStatus last published by this provider.

getServerStoredContactListRoot

public ContactGroup getServerStoredContactListRoot()

Returns the root group of the server stored contact list.

Returns:

the root ContactGroup for the ContactList stored by this service.

getSupportedStatusSet

public Iterator<PresenceStatus> getSupportedStatusSet()

Returns the set of PresenceStatus objects that a user of this service may request the provider to enter.

Returns:

Iterator a PresenceStatus array containing "enterable" status instances.

moveContactToGroup

public void moveContactToGroup(Contact contactToMove,
                               ContactGroup newParent)

Removes the specified contact from its current parent and places it under newParent.

Parameters:

contactToMove - the Contact to move

newParent - the ContactGroup where Contact would be placed.

publishPresenceStatus

public void publishPresenceStatus(PresenceStatus status,
                                  String statusMessage)
                           throws IllegalArgumentException,
                                  IllegalStateException,
                                  OperationFailedException

Requests the provider to enter into a status corresponding to the specified paramters.

Parameters:

status - the PresenceStatus as returned by getRequestableStatusSet

statusMessage - the message that should be set as the reason to enter that status

Throws:

IllegalArgumentException - if the status requested is not a valid PresenceStatus supported by this provider.

IllegalStateException - if the provider is not currently registered.

OperationFailedException - with code NETWORK_FAILURE if publishing the status fails due to a network error.

queryContactStatus

public PresenceStatus queryContactStatus(String contactIdentifier)
                                  throws IllegalArgumentException,
                                         IllegalStateException,
                                         OperationFailedException

Get the PresenceStatus for a particular contact.

Parameters:

contactIdentifier - the identifier of the contact whose status we're interested in.

Returns:

PresenceStatus the PresenceStatus of the specified contact

Throws:

IllegalArgumentException - if contact is not a contact known to the underlying protocol provider

IllegalStateException - if the underlying protocol provider is not registered/signed on a public service.

OperationFailedException - with code NETWORK_FAILURE if retrieving the status fails due to errors experienced during network communication

removeServerStoredContactGroup

public void removeServerStoredContactGroup(ContactGroup group)

Removes the specified group from the server stored contact list.

Parameters:

group - the group to remove.

removeServerStoredGroupChangeListener

public void removeServerStoredGroupChangeListener(ServerStoredGroupListener listener)

Removes the specified group change listener so that it won't receive any further events.

Specified by:

removeServerStoredGroupChangeListener in interface OperationSetPersistentPresence

Overrides:

removeServerStoredGroupChangeListener in class AbstractOperationSetPersistentPresence<ProtocolProviderServiceYahooImpl>

Parameters:

listener - the ServerStoredGroupChangeListener to remove

renameServerStoredContactGroup

public void renameServerStoredContactGroup(ContactGroup group,
                                           String newName)

Renames the specified group from the server stored contact list.

Parameters:

group - the group to rename.

newName - the new name of the group.

setAuthorizationHandler

public void setAuthorizationHandler(AuthorizationHandler handler)

Handler for incoming authorization requests.

Parameters:

handler - an instance of an AuthorizationHandler for authorization requests coming from other users requesting permission add us to their contact list.

subscribe

public void subscribe(ContactGroup parent,
                      String contactIdentifier)
               throws IllegalArgumentException,
                      IllegalStateException,
                      OperationFailedException

Persistently adds a subscription for the presence status of the contact corresponding to the specified contactIdentifier and indicates that it should be added to the specified group of the server stored contact list.

Parameters:

parent - the parent group of the server stored contact list where the contact should be added.

contactIdentifier - the contact whose status updates we are subscribing for.

Throws:

IllegalArgumentException - if contact or parent are not a contact known to the underlying protocol provider.

IllegalStateException - if the underlying protocol provider is not registered/signed on a public service.

OperationFailedException - with code NETWORK_FAILURE if subscribing fails due to errors experienced during network communication

subscribe

public void subscribe(String contactIdentifier)
               throws IllegalArgumentException,
                      IllegalStateException,
                      OperationFailedException

Adds a subscription for the presence status of the contact corresponding to the specified contactIdentifier.

Parameters:

contactIdentifier - the identifier of the contact whose status updates we are subscribing for.

Throws:

IllegalArgumentException - if contact is not a contact known to the underlying protocol provider

IllegalStateException - if the underlying protocol provider is not registered/signed on a public service.

OperationFailedException - with code NETWORK_FAILURE if subscribing fails due to errors experienced during network communication

unsubscribe

public void unsubscribe(Contact contact)
                 throws IllegalArgumentException,
                        IllegalStateException,
                        OperationFailedException

Removes a subscription for the presence status of the specified contact.

Parameters:

contact - the contact whose status updates we are unsubscribing from.

Throws:

IllegalArgumentException - if contact is not a contact known to the underlying protocol provider

IllegalStateException - if the underlying protocol provider is not registered/signed on a public service.

OperationFailedException - with code NETWORK_FAILURE if unsubscribing fails due to errors experienced during network communication

yahooStatusToPresenceStatus

YahooStatusEnum yahooStatusToPresenceStatus(long status)

Converts the specified yahoo status to one of the status fields of the YahooStatusEnum class.

Parameters:

status - the yahoo Status

Returns:

a PresenceStatus instance representation of the yahoo Status parameter. The returned result is one of the YahooStatusEnum fields.

fireProviderStatusChangeEvent

protected void fireProviderStatusChangeEvent(PresenceStatus oldStatus,
                                             PresenceStatus newStatus)

Notify all provider presence listeners of the corresponding event change

Overrides:

fireProviderStatusChangeEvent in class AbstractOperationSetPersistentPresence<ProtocolProviderServiceYahooImpl>

Parameters:

oldStatus - the status our stack had so far

newStatus - the status we have from now on

handleContactStatusChange

void handleContactStatusChange(ContactYahooImpl sourceContact,
                               ymsg.network.YahooUser yFriend)