Package com.iplanet.services.cdm

Interface ClientTypesManager

All Known Implementing Classes:

BasicClientTypesManager, DefaultClientTypesManager

public interface ClientTypesManager

Interface that needs to be implemented by external applications inorder to do some special processing for client management. The implementation module is pluggable and is configurable via AMConfig.properties. The property to set is com.iplanet.ClientTypesManagerImpl.

Method Summary

Modifier and Type	Method	Description
Map	getAllClientInstances()	Gets all client instance as Map.
Set	getAllClientTypes()	Get names of all client types
Client	getClientInstance(String clientType)	Gets client object for specified client type.
Client	getClientInstance(String clientType, SSOToken token)	Gets client object for specified client type with specified token
Map	getClientTypeData(String clientType)	Returns properties of the requested client type
String	getDefaultClientType()	Gets default client type name
void	initManager()	Initializes the ClientTypesManager.
void	setDirty(String clientType, Map data)	Updates client data.
void	store(SSOToken token)	Save changed to persistent store.
void	updateClientData()	Reload all Client data.

Method Detail

initManager

void initManager()

Initializes the ClientTypesManager.

getAllClientInstances

Map getAllClientInstances()

Gets all client instance as Map.

Returns:

Map of clients. Key is the client type, value is the Client object

getClientInstance

Client getClientInstance(String clientType)

Gets client object for specified client type.

Parameters:

clientType - requested client type.

Returns:

The requested Client object

getClientInstance

Client getClientInstance(String clientType,
                         SSOToken token)

Gets client object for specified client type with specified token

Parameters:

clientType - requested client type

token - SSO Token

Returns:

The requested Client object

getClientTypeData

Map getClientTypeData(String clientType)

Returns properties of the requested client type

Parameters:

clientType - requested client type

Returns:

All properties of the request client type as Map

getDefaultClientType

String getDefaultClientType()

Gets default client type name

Returns:

The default client type name

getAllClientTypes

Set getAllClientTypes()

Get names of all client types

Returns:

Set of client types as String

updateClientData

void updateClientData()
               throws ClientException

Reload all Client data.

Throws:

ClientException - if having problem update client data

store

void store(SSOToken token)
    throws SMSException,
           SSOException

Save changed to persistent store.

Parameters:

token - single sign on Token of the caller.

Throws:

SSOException - if the token is not valid.

SMSException - if having problem saving changes.

setDirty

void setDirty(String clientType,
              Map data)

Updates client data. Need to call store() after this method.

Parameters:

clientType - client type

data - client data. Key is the property name and value is the property value as String.