net.java.sip.communicator.impl.protocol.dict
Class OperationSetPersistentPresenceDictImpl

java.lang.Object
  net.java.sip.communicator.service.protocol.AbstractOperationSetPersistentPresence<ProtocolProviderServiceDictImpl>
      net.java.sip.communicator.impl.protocol.dict.OperationSetPersistentPresenceDictImpl

All Implemented Interfaces:

OperationSet, OperationSetPersistentPresence, OperationSetPresence

public class OperationSetPersistentPresenceDictImpl
extends AbstractOperationSetPersistentPresence<ProtocolProviderServiceDictImpl>

A Dict implementation of a persistent presence operation set. In order to simulate server persistence, this operation set would simply accept all unresolved contacts and resolve them immediately. A real world protocol implementation would save it on a server using methods provided by the protocol stack.

Author:

ROTH Damien, LITZELMANN Cedric

Field Summary

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

parentProvider

Constructor Summary

OperationSetPersistentPresenceDictImpl(ProtocolProviderServiceDictImpl provider)
Creates an instance of this operation set keeping a reference to the specified parent provider.

Method Summary

void	addDictGroup(ContactGroupDictImpl contactGroup) A Dict Provider method to use for fast filling of a contact list.
void	addDictGroupAndFireEvent(ContactGroupDictImpl parent, ContactGroupDictImpl contactGroup) A Dict Provider method to use for fast filling of a contact list.
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 parent) 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.
ContactDictImpl	createVolatileContact(String contactAddress) 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/
ContactGroupDictImpl	findContactParent(ContactDictImpl dictContact) Returns the group that is parent of the specified dictContact or null if no parent was found.
List<Contact>	findContactsPointingToUs() Looks for dict protocol providers that have added us to their contact list and returns list of all contacts representing us in these providers.
ContactGroupDictImpl	findGroupParent(ContactGroupDictImpl dictGroup) Returns the group that is parent of the specified dictGroup or null if no parent was found.
ProtocolProviderServiceDictImpl	findProviderForDictUserID(String dictUserID) Looks for a dict protocol provider registered for a user id matching dictUserID.
String	getCurrentStatusMessage() Returns the status message that was last set through setCurrentStatusMessage.
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.
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	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	setStatusMessage(String statusMessage) Sets the specified status message.
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.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationSetPersistentPresenceDictImpl

public OperationSetPersistentPresenceDictImpl(ProtocolProviderServiceDictImpl provider)

Creates an instance of this operation set keeping a reference to the specified parent provider.

Parameters:

provider - the ProtocolProviderServiceDictImpl instance that created us.

Method Detail

createServerStoredContactGroup

public void createServerStoredContactGroup(ContactGroup parent,
                                           String groupName)

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.

addDictGroup

public void addDictGroup(ContactGroupDictImpl contactGroup)

A Dict Provider method to use for fast filling of a contact list.

Parameters:

contactGroup - the group to add

addDictGroupAndFireEvent

public void addDictGroupAndFireEvent(ContactGroupDictImpl parent,
                                     ContactGroupDictImpl contactGroup)

A Dict Provider method to use for fast filling of a contact list. This method would add both the group and fire an event.

Parameters:

parent - the group where contactGroup should be added.

contactGroup - the group to add

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.

setStatusMessage

public void setStatusMessage(String statusMessage)

Sets the specified status message.

Parameters:

statusMessage - a String containing the new status message.

getCurrentStatusMessage

public String getCurrentStatusMessage()

Returns the status message that was last set through setCurrentStatusMessage.

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

findGroupParent

public ContactGroupDictImpl findGroupParent(ContactGroupDictImpl dictGroup)

Returns the group that is parent of the specified dictGroup or null if no parent was found.

Parameters:

dictGroup - the group whose parent we're looking for.

Returns:

the ContactGroupDictImpl instance that dictGroup belongs to or null if no parent was found.

findContactParent

public ContactGroupDictImpl findContactParent(ContactDictImpl dictContact)

Returns the group that is parent of the specified dictContact or null if no parent was found.

Parameters:

dictContact - the contact whose parent we're looking for.

Returns:

the ContactGroupDictImpl instance that dictContact belongs to or null if no parent was found.

removeServerStoredContactGroup

public void removeServerStoredContactGroup(ContactGroup group)
                                    throws IllegalArgumentException

Removes the specified group from the server stored contact list.

Parameters:

group - the group to remove.

Throws:

IllegalArgumentException - if group was not found in this protocol's contact list.

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

createUnresolvedContact

public Contact createUnresolvedContact(String address,
                                       String persistentData)

Creates and returns a unresolved contact from the specified address and persistentData. The method will not try to establish a network connection and resolve the newly created Contact against the server. The protocol provider may will later try and resolve the contact. When this happens the corresponding event would notify interested subscription listeners.

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

createUnresolvedContact

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

Creates and returns a unresolved contact from the specified address and persistentData. The method will not try to establish a network connection and resolve the newly created Contact against the server. The protocol provider may will later try and resolve the contact. When this happens the corresponding event would notify interested subscription listeners.

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.

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

Returns:

the unresolved Contact created from the specified address and persistentData

findProviderForDictUserID

public ProtocolProviderServiceDictImpl findProviderForDictUserID(String dictUserID)

Looks for a dict protocol provider registered for a user id matching dictUserID.

Parameters:

dictUserID - the ID of the Dict user whose corresponding protocol provider we'd like to find.

Returns:

ProtocolProviderServiceDictImpl a dict protocol provider registered for a user with id dictUserID or null if there is no such protocol provider.

findContactsPointingToUs

public List<Contact> findContactsPointingToUs()

Looks for dict protocol providers that have added us to their contact list and returns list of all contacts representing us in these providers.

Returns:

a list of all contacts in other providers' contact lists that point to us.

createUnresolvedContactGroup

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

Creates and returns a unresolved contact group from the specified address and persistentData. The method will not try to establish a network connection and resolve the newly created ContactGroup against the server or the contact itself. The protocol provider will later resolve the contact group. When this happens the corresponding event would notify interested subscription listeners.

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

createVolatileContact

public ContactDictImpl createVolatileContact(String contactAddress)

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. This method would have no effect on the server stored contact list.

Parameters:

contactAddress - the address of the volatile contact we'd like to create.

Returns:

the newly created volatile contact.