com.sun.im.service
Interface PersonalGateway

All Superinterfaces:
PersonalStoreEntry

public interface PersonalGateway
extends PersonalStoreEntry


Field Summary
 
Fields inherited from interface com.sun.im.service.PersonalStoreEntry
BOOKMARK, BOOKMARK_FOLDER, CONFERENCE, CONTACT, CONTACT_FOLDER, FOLDER, GATEWAY, GROUP, PROFILE, PROFILE_FOLDER, WATCHER
 
Method Summary
 java.lang.String getHostName()
          returns the JID of the gateway
 java.lang.String getName()
          returns the name of the gateway
 java.lang.String getService()
           
 java.util.Set getSupportedFeatures()
          returns the set of features supported by the gateway Each element in the Set is a String object
 boolean isRegistered()
           
 boolean isSupportedFeature(java.lang.String feature)
           
 void register(RegistrationListener listener)
          registers the user with the gateway
 void unregister(RegistrationListener listener)
          unregister the user with the gateway
 
Methods inherited from interface com.sun.im.service.PersonalStoreEntry
addToFolder, getDisplayName, getEntryId, getFolders, getType, remove, removeFromFolder, save, setDisplayName
 

Method Detail

getHostName

public java.lang.String getHostName()
                             throws CollaborationException
returns the JID of the gateway

Returns:
- the jid of the gateway
Throws:
CollaborationException

getName

public java.lang.String getName()
                         throws CollaborationException
returns the name of the gateway

Returns:
- the name of the gateway e.g AIM Gateway
Throws:
CollaborationException

getService

public java.lang.String getService()
                            throws CollaborationException
Throws:
CollaborationException

register

public void register(RegistrationListener listener)
              throws CollaborationException
registers the user with the gateway

Parameters:
listener - - the callback for the registration events
Throws:
CollaborationException

unregister

public void unregister(RegistrationListener listener)
                throws CollaborationException
unregister the user with the gateway

Parameters:
listener - - callback object for the unregistration events
Throws:
CollaborationException

getSupportedFeatures

public java.util.Set getSupportedFeatures()
                                   throws CollaborationException
returns the set of features supported by the gateway Each element in the Set is a String object

Returns:
Set of features supported by the gateway
Throws:
CollaborationException

isSupportedFeature

public boolean isSupportedFeature(java.lang.String feature)
                           throws CollaborationException
Parameters:
feature - - feature to check if supported or not supported
Returns:
true if the feature is supported by the gateway, otherwise false
Throws:
CollaborationException

isRegistered

public boolean isRegistered()
                     throws CollaborationException
Throws:
CollaborationException