oracle.sdp.presence.integration
Class BuddyListManagerFactory

java.lang.Object
  oracle.sdp.presence.integration.BuddyListManagerFactory

public abstract class BuddyListManagerFactory
extends java.lang.Object

Factory for creating BuddyListManagers to use for manipulating contact lists and presence authorization rules.

Method Summary

abstract BuddyListManager	createBuddyListManager(java.net.URI user, Map<java.lang.String,java.lang.Object> parameters) Factory method for creating new Buddy List Managers.
BuddyListManager	createBuddyListManager(java.net.URI user, Properties props) Deprecated.
static BuddyListManagerFactory	getInstance(java.net.URI xcapRoot, Map<java.lang.String,java.lang.Object> parameters) Obtain an instance of this factory.
static BuddyListManagerFactory	getInstance(java.net.URI xcapRoot, Properties props) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

createBuddyListManager

public abstract BuddyListManager createBuddyListManager(java.net.URI user,
                                                        Map<java.lang.String,java.lang.Object> parameters)
                                                 throws java.lang.IllegalArgumentException

Factory method for creating new Buddy List Managers.

The URI of the user is e.g. "sip:alice@example.com" and the BuddyListManager that is created is buddy list manager for Alice. Hence, all operation invoked on that BuddyListManager will be in the context of Alice. Hence, each user will have to create their own BuddyListManager in order to manipulate their buddy lists. See example in getInstance().

Parameters:

user - the user who this BuddyListManager will "belong" to. This URI must either be sip or a tel-uri.

parameters - way of specifying optional settings.

• XDMClientFactory.PROP_ASSERTED_IDENTITY if different from XUI

Throws:

java.lang.IllegalArgumentException - in case the user is null or not a SIP uri or a tel uri.

createBuddyListManager

@Deprecated
public BuddyListManager createBuddyListManager(java.net.URI user,
                                                          Properties props)
                                        throws java.lang.IllegalArgumentException

Deprecated.

Should use the createBuddyListManager(URI, Map) version instead. This will be removed in future version of the API.

Parameters:

user -

props -

Throws:

java.lang.IllegalArgumentException

getInstance

public static BuddyListManagerFactory getInstance(java.net.URI xcapRoot,
                                                  Map<java.lang.String,java.lang.Object> parameters)
                                           throws java.lang.IllegalArgumentException

Obtain an instance of this factory. For different combination of XCAP roots and web service endpoint there will be different factories. Hence, you can create two different instances of this factory by supplying different XCAP roots. Of course, this means that you will get back the same instance of this factory for the same XCAP root. Same XCAP root with a different webservice endpoints will get you different factory. To use these API in direct HTTP mode (no security), do NOT supply any Binding Provider info. If one is supplied, it will use the web service implementation of the XDM Client, thus security can be achieved via WS-Security.
Example

   Map params = new HashMap();
   params.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, mWsUrl);
   params.put(BindingProvider.USERNAME_PROPERTY, mUsername);
   params.put(BindingProvider.PASSWORD_PROPERTY, mPassword);
   params.put(XDMClientFactory.PROP_ASSERTED_IDENTITY, assertedId);
   BuddyListManagerFactory factory = BuddyListManagerFactory.getInstance(new URI(mXdmsUrl), params);
   BuddyListManager manager = factory.createBuddyListManager(user, params);
 

Parameters:

xcapRoot - The URI pointing to the XCAP root. For an XDMC implemented in a UE this will be pointing to the Aggregation Proxy. For an XDMC implemented in a server on the trusted network this xcap root could point to the actual enabler specific XDMS.

parameters - way of specifying optional settings. Current properties see XDMClientFactory.createXDMClient() for details

• XDMClientFactory.PROP_ASSERTED_IDENTITY_TYPE
• XDMClientFactory.PROP_CLIENT_IMPL_NAME

Throws:

java.lang.IllegalArgumentException - in case the XCAP root is null or not an HTTP/S url

getInstance

@Deprecated
public static BuddyListManagerFactory getInstance(java.net.URI xcapRoot,
                                                             Properties props)
                                           throws java.lang.IllegalArgumentException

Deprecated.

Should use getInstance(URI,Map) instead. This will be removed from future version of the API.

Parameters:

xcapRoot -

props -

Throws:

java.lang.IllegalArgumentException