com.iplanet.services.cdm
Class ClientsManager

java.lang.Object
  |
  +--com.iplanet.services.cdm.ClientsManager

public class ClientsManager
extends java.lang.Object

Provides common access to client data.

Client data is accessed for a particular client type. The underlying client data is stored in the profile service, but this interface should always used for accessing it (not by accessing the profile directly).

Client does not allow clients to modify the Client Data unless they have a valid user sso token. clients trying to modify Client Data should explicitly call store() to save changes into SMS. versions of the getInstance methods that accept a SSO token should be used if the client code wishes to set client data.


Constructor Summary
ClientsManager()
           
 
Method Summary
static java.util.Iterator getAllInstances()
          Returns an iterator of Client objects for all known client types.
static Client getDefaultInstance()
          Get a Client instance for the default client type
static Client getInstance(java.lang.String clientType)
          Get Client instance for a specific client type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientsManager

public ClientsManager()
Method Detail

getInstance

public static Client getInstance(java.lang.String clientType)
                          throws ClientException
Get Client instance for a specific client type.
Parameters:
clientType - Client Type.
Returns:
Requested Client instance.
Throws:
ClientException - if specified client type is null or not defined.

getDefaultInstance

public static Client getDefaultInstance()
Get a Client instance for the default client type
Returns:
The Client instance corresponding to the default client type

getAllInstances

public static java.util.Iterator getAllInstances()
Returns an iterator of Client objects for all known client types.
Returns:
Iterator of Client objects