com.iplanet.services.cdm
Class Client

java.lang.Object
  |
  +--java.util.Observable
        |
        +--com.iplanet.services.cdm.Client

All Implemented Interfaces:

ServiceListener

public class Client

extends java.util.Observable

implements ServiceListener

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.

Fields inherited from interface com.sun.identity.sm.ServiceListener

ADDED, MODIFIED, REMOVED

Constructor Summary

Client()

Method Summary

static java.util.Iterator	getAllInstances() Returns an iterator of Client objects for all known client types.
java.lang.String	getClientType() Gets the name of the client type for the data in this client instance.
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 clientType
java.lang.String	getProperty(java.lang.String name) Gets the client property for the specified key.
java.util.Set	getPropertyNames() Returns a set of property names for this client data instance.

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.sm.ServiceListener

globalConfigChanged, organizationConfigChanged, schemaChanged

Constructor Detail

Client

public Client()

Method Detail

getInstance

public static Client getInstance(java.lang.String clientType)
                          throws ClientException

Get Client instance for a specific clientType

Parameters:

clientType - Client Type

Returns:

Requested Client instance

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

getClientType

public java.lang.String getClientType()

Gets the name of the client type for the data in this client instance.

Returns:

Name of the client type

getProperty

public java.lang.String getProperty(java.lang.String name)

Gets the client property for the specified key.

Parameters:

name - The key for the client property to be returned.

Returns:

The client property.

getPropertyNames

public java.util.Set getPropertyNames()

Returns a set of property names for this client data instance.

Returns:

The set of property names for this client data instance.