Nitido Inc.

com.nitido.nimx.services.datacontrol.cachedmap
Class DataControlImpl

java.lang.Object
  extended by com.nitido.nim.DataControl
      extended by com.nitido.nimx.services.datacontrol.cachedmap.DataControlImpl
All Implemented Interfaces:
CredentialConstants, java.io.Serializable

public class DataControlImpl
extends DataControl
implements CredentialConstants

This DataControl implementation stores user space entries to the directory server if the class configuration contains a "mapping entry" for the given key. Otherwise, this DataControl stores the user space entries in memory. On the other hand, Credential space entries are always kept in memory.

See Also:
Serialized Form

Field Summary
static java.lang.String CONF_KEY_CHECK_CRED_WHEN_BIND
          Configuration key for the write connection pool name.
static java.lang.String CONF_KEY_CRED_NO_BACKEND
          The configurtion key for the list of credential types that have no backend access at all.
static java.lang.String CONF_KEY_PASSWORD_MAP
          The user password attribute key.
static java.lang.String CONF_KEY_PREFETCH
          The configurtion key for determining whether to prefetch the cache-mapped attributes of a user when the corresponding DataControl is initiated.
static java.lang.String CONF_KEY_PREFIX_ATTRIBUTE_MAP
          The configuration key prefix for the mapping settings from a user space key to a LDAP attribute name.
static java.lang.String CONF_KEY_PREFIX_BIND_AS_DN
          The configurtion key prefix of the settings for the credential token key associated to the specified credential type.
static java.lang.String CONF_KEY_PREFIX_BIND_AS_PWD
          The configurtion key prefix of the settings for the credential token key associated to the specified credential type.
static java.lang.String CONF_KEY_PREFIX_DN_POSTFIX
          The configurtion key prefix of the settings for the LDAP DN postfix associated to the specified credential type.
static java.lang.String CONF_KEY_PREFIX_DN_PREFIX
          The configurtion key prefix of the settings for the LDAP DN prefix associated to the specified credential type.
static java.lang.String CONF_KEY_PREFIX_DN_TOKEN_KEY
          The configurtion key prefix of the settings for the credential token key associated to the specified credential type.
static java.lang.String CONF_KEY_READ_POOL
          Configuration key for the read connection pool name.
static java.lang.String CONF_KEY_RESET_ON_ENTITY
          The configurtion key for determining whether to reset the cache of a user when all of the Entity objects that uses the specific cache has been released by the application.
static java.lang.String CONF_KEY_WRITE_POOL
          Configuration key for the write connection pool name.
static java.lang.String CONF_VALUE_END_OF_MODIFIERS
           
static java.lang.String CONF_VALUE_PREFETCH
          The configuration value for indicated a cache-mapped attribute will be prefetched.
static java.lang.String CONF_VALUE_READ_ONLY_BACKEND
           
static java.lang.String CONF_VALUE_START_OF_MODIFIERS
           
static java.lang.String ERR_MSG_MAP_INVALID_1
           
static java.lang.String ERR_MSG_MAP_INVALID_2
           
static java.lang.String INTERNAL_KEY_CHECK_CRED_WHEN_BIND
          Internal key for passing the configuration for CONF_KEY_CHECK_WHEN_BIND between the DataControlServiceImpl and the DataControlImpl object.
static java.lang.String INTERNAL_KEY_PREFETCH
          Internal key for passing the configuration for CONF_KEY_PREFETCH between the DataControlServiceImpl and the DataControlImpl object.
static java.lang.String INTERNAL_KEY_READ_POOL
          Internal key for passing the configuration for CONF_KEY_READ_POOL between the DataControlServiceImpl and the DataControlImpl object.
static java.lang.String INTERNAL_KEY_WRITE_POOL
          Internal key for passing the configuration for CONF_KEY_WRITE_POOL between the DataControlServiceImpl and the DataControlImpl object.
static int LEN_CONF_KEY_PREFIX_ATTRIBUTE_MAP
          The length of the actual string represented by the constant CONF_KEY_PREFIX_ATTRIBUTEMAP.
static char MAP_FIELD_SEPARATOR
          The separator for each field.
 
Fields inherited from interface com.nitido.nim.CredentialConstants
CRED_ADMIN, CRED_CONTAINER, CRED_HELPDESK, CRED_SYSTEM, CRED_USER, KEY_PASSWORD
 
Fields inherited from interface com.nitido.nim.NiMConstants
ACTION_CREATE_NUGGET, ACTION_CREATE_NUGGET_BY_NAME, ACTION_CRED_SPACE_ADD, ACTION_CRED_SPACE_GET_KEYS, ACTION_CRED_SPACE_GET_KEYS_START_WITH, ACTION_CRED_SPACE_GET_VALUE, ACTION_CRED_SPACE_GET_VALUES, ACTION_CRED_SPACE_MODIFY, ACTION_CRED_SPACE_REMOVE_VALUE, ACTION_CRED_SPACE_REMOVE_VALUES, ACTION_CRED_SPACE_REPLACE, ACTION_DEPROVISION_ENTITY, ACTION_ENTITY_CHANGE_CRED, ACTION_LOG_EVENT, ACTION_PROVISION_ENTITY, ACTION_USER_SPACE_ADD, ACTION_USER_SPACE_GET_KEYS, ACTION_USER_SPACE_GET_KEYS_START_WITH, ACTION_USER_SPACE_GET_VALUE, ACTION_USER_SPACE_GET_VALUES, ACTION_USER_SPACE_MODIFY, ACTION_USER_SPACE_REMOVE_VALUE, ACTION_USER_SPACE_REMOVE_VALUES, ACTION_USER_SPACE_REPLACE, CONF_PREFIX_SECURITY_ACCESS, CONF_PREFIX_SECURITY_ALLOW, CONF_PREFIX_SECURITY_ASSIGN, CONF_PREFIX_SECURITY_RESOURCE, PARAM_CHANGE_CRED, PARAM_DEPROVISION_CREDENTIAL, PARAM_EVENT_NAME, PARAM_MODIFIER_CONTAINER, PARAM_NUGGET_CREATE_CRED, PARAM_NUGGET_NAME, PARAM_NUGGET_SETTINGS, PARAM_NUGGET_TYPE, PARAM_PROVISION_DESCRIPTOR, PARAM_SPACE_KEY, PARAM_SPACE_KEYS_START_WITH, PARAM_SPACE_VALUE, PREFIX_ACCESS_CLASS_IN_PACKAGE
 
Constructor Summary
protected DataControlImpl(Credential credential, java.util.HashMap settingMap)
          This constructor returns an instance of the DataControl that is binded to the given credential.
 
Method Summary
protected  void acquire()
          This method is used to establish a connection to the back-end data store.
protected  void activate()
          This method is used to activates the DataControl after the Entity object containing this DataControl is deserialized.
 void bind(Credential cred)
          This method is used to bind the given credential to the DataControl if the credential can be authenticated against the directory server.
protected  void changeDataControlCredential(Credential newCred, boolean modBackend)
          This method change the DataControl credential for user.
protected  void deactivate()
          This method is called to deactivate the DataControl.
protected  void destroy()
          This method is invoked when the Entity has been signalled as "dying".
protected  java.lang.String[] getCredentialSpaceKeysImpl(java.lang.String startsWith)
          This method contains the actual implementation for the getCredentialSpaceKeys( startsWith ) method.
protected  java.util.Vector getFromCredentialSpaceImpl(java.lang.String key)
          This method contains the actual implementation for the getFromCredentialSpace( key ) method.
protected  java.util.Vector getFromInMemoryData(java.lang.String key)
           
protected  java.util.Vector getFromUserSpaceImpl(java.lang.String key)
          This method contains the actual implementation for the getFromUserSpace() method.
protected static java.util.Vector getKeysFromHash(OpenSerializableHash hash, java.lang.String startsWith)
          Utility method to get the keys from the given hash whose name start with the given prefix.
protected  java.util.Vector getKeysFromInMemoryData(java.lang.String startsWith)
           
protected  java.lang.String getUserDN()
          This method returns the user DN associated to this instance of DataControl.
protected  java.lang.String[] getUserSpaceKeysImpl(java.lang.String startsWith)
          This method contains the actual implementation for the getUserSpaceKeys() method.
protected  Credential getValueFromCredentialSpaceImpl(java.lang.String key)
          This method contains the actual implementation for the getValueFromCredentialSpace( key ) method.
protected  java.io.Serializable getValueFromUserSpaceImpl(java.lang.String key)
          This method contains the actual implementation for the getValueFromUserSpace() method.
protected  void initialize(java.util.HashMap settingMap)
          This method is used to initialize the DataControl with the given settings.
protected  void modifyCredentialSpaceImpl(ModifierContainer container)
          This method provides the actual implementation to the modifyCredentialSpace() method.
protected static void modifyHash(OpenSerializableHash hash, Modifier modifier)
          This method is used to modify given hash according to the operation described in the given Modifier object..
protected  void modifyInMemoryData(java.util.ArrayList inMemoryModifiers)
           
protected  void modifyUserSpaceImpl(ModifierContainer container)
          This method contains the actual implementation for the modifyUserSpace( container ) method.
protected  void release()
          This method is used to release a connection to the back-end data store.
 
Methods inherited from class com.nitido.nim.DataControl
addToCredentialSpace, addToUserSpace, getCredentialSpaceKeys, getCredentialSpaceKeys, getFromCredentialSpace, getFromUserSpace, getUserSpaceKeys, getUserSpaceKeys, getValueFromCredentialSpace, getValueFromUserSpace, modifyCredentialSpace, modifyUserSpace, removeFromCredentialSpace, removeFromCredentialSpace, removeFromUserSpace, removeFromUserSpace, replaceInCredentialSpace, replaceInUserSpace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONF_KEY_READ_POOL

public static final java.lang.String CONF_KEY_READ_POOL
Configuration key for the read connection pool name. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.readpoolname".

See Also:
Constant Field Values

CONF_KEY_WRITE_POOL

public static final java.lang.String CONF_KEY_WRITE_POOL
Configuration key for the write connection pool name. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.writepoolname".

See Also:
Constant Field Values

CONF_KEY_CHECK_CRED_WHEN_BIND

public static final java.lang.String CONF_KEY_CHECK_CRED_WHEN_BIND
Configuration key for the write connection pool name. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.checkcredwhenbind".

See Also:
Constant Field Values

CONF_KEY_PREFIX_DN_PREFIX

public static final java.lang.String CONF_KEY_PREFIX_DN_PREFIX
The configurtion key prefix of the settings for the LDAP DN prefix associated to the specified credential type. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnprefix.".

See Also:
Constant Field Values

CONF_KEY_PREFIX_DN_POSTFIX

public static final java.lang.String CONF_KEY_PREFIX_DN_POSTFIX
The configurtion key prefix of the settings for the LDAP DN postfix associated to the specified credential type. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnpostfix.".

See Also:
Constant Field Values

CONF_KEY_PREFIX_DN_TOKEN_KEY

public static final java.lang.String CONF_KEY_PREFIX_DN_TOKEN_KEY
The configurtion key prefix of the settings for the credential token key associated to the specified credential type. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.".

See Also:
Constant Field Values

CONF_KEY_PREFIX_BIND_AS_DN

public static final java.lang.String CONF_KEY_PREFIX_BIND_AS_DN
The configurtion key prefix of the settings for the credential token key associated to the specified credential type. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.bindas.dn.".

See Also:
Constant Field Values

CONF_KEY_PREFIX_BIND_AS_PWD

public static final java.lang.String CONF_KEY_PREFIX_BIND_AS_PWD
The configurtion key prefix of the settings for the credential token key associated to the specified credential type. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.bindas.pwd.".

See Also:
Constant Field Values

CONF_KEY_RESET_ON_ENTITY

public static final java.lang.String CONF_KEY_RESET_ON_ENTITY
The configurtion key for determining whether to reset the cache of a user when all of the Entity objects that uses the specific cache has been released by the application. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.resetonentity".

See Also:
Constant Field Values

CONF_KEY_PREFETCH

public static final java.lang.String CONF_KEY_PREFETCH
The configurtion key for determining whether to prefetch the cache-mapped attributes of a user when the corresponding DataControl is initiated. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.prefetch".

See Also:
Constant Field Values

CONF_KEY_CRED_NO_BACKEND

public static final java.lang.String CONF_KEY_CRED_NO_BACKEND
The configurtion key for the list of credential types that have no backend access at all. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.cred.nobackend".

See Also:
Constant Field Values

CONF_KEY_PREFIX_ATTRIBUTE_MAP

public static final java.lang.String CONF_KEY_PREFIX_ATTRIBUTE_MAP
The configuration key prefix for the mapping settings from a user space key to a LDAP attribute name. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.attributemap.".

See Also:
Constant Field Values

LEN_CONF_KEY_PREFIX_ATTRIBUTE_MAP

public static final int LEN_CONF_KEY_PREFIX_ATTRIBUTE_MAP
The length of the actual string represented by the constant CONF_KEY_PREFIX_ATTRIBUTEMAP.


CONF_KEY_PASSWORD_MAP

public static final java.lang.String CONF_KEY_PASSWORD_MAP
The user password attribute key. The actual value is "com.nitido.nimx.services.datacontrol.cachedmap.passwordmap.";

See Also:
Constant Field Values

CONF_VALUE_PREFETCH

public static final java.lang.String CONF_VALUE_PREFETCH
The configuration value for indicated a cache-mapped attribute will be prefetched. The actual value is "prefetch".

See Also:
Constant Field Values

CONF_VALUE_READ_ONLY_BACKEND

public static final java.lang.String CONF_VALUE_READ_ONLY_BACKEND
See Also:
Constant Field Values

CONF_VALUE_START_OF_MODIFIERS

public static final java.lang.String CONF_VALUE_START_OF_MODIFIERS
See Also:
Constant Field Values

CONF_VALUE_END_OF_MODIFIERS

public static final java.lang.String CONF_VALUE_END_OF_MODIFIERS
See Also:
Constant Field Values

INTERNAL_KEY_READ_POOL

public static final java.lang.String INTERNAL_KEY_READ_POOL
Internal key for passing the configuration for CONF_KEY_READ_POOL between the DataControlServiceImpl and the DataControlImpl object.

See Also:
Constant Field Values

INTERNAL_KEY_WRITE_POOL

public static final java.lang.String INTERNAL_KEY_WRITE_POOL
Internal key for passing the configuration for CONF_KEY_WRITE_POOL between the DataControlServiceImpl and the DataControlImpl object.

See Also:
Constant Field Values

INTERNAL_KEY_CHECK_CRED_WHEN_BIND

public static final java.lang.String INTERNAL_KEY_CHECK_CRED_WHEN_BIND
Internal key for passing the configuration for CONF_KEY_CHECK_WHEN_BIND between the DataControlServiceImpl and the DataControlImpl object.

See Also:
Constant Field Values

INTERNAL_KEY_PREFETCH

public static final java.lang.String INTERNAL_KEY_PREFETCH
Internal key for passing the configuration for CONF_KEY_PREFETCH between the DataControlServiceImpl and the DataControlImpl object.

See Also:
Constant Field Values

MAP_FIELD_SEPARATOR

public static final char MAP_FIELD_SEPARATOR
The separator for each field.

See Also:
Constant Field Values

ERR_MSG_MAP_INVALID_1

public static final java.lang.String ERR_MSG_MAP_INVALID_1
See Also:
Constant Field Values

ERR_MSG_MAP_INVALID_2

public static final java.lang.String ERR_MSG_MAP_INVALID_2
See Also:
Constant Field Values
Constructor Detail

DataControlImpl

protected DataControlImpl(Credential credential,
                          java.util.HashMap settingMap)
                   throws IllegalCredentialException,
                          DataControlException
This constructor returns an instance of the DataControl that is binded to the given credential. This implementation of the constructor simply calls the constructor of the parent class.

This method is declared protected to ensure that only the corresponding DataControlService can be used to get an instance of a DataControl.

Parameters:
credential - A reference to the Credential object used to authenticate against the back-end data store.
settingMap - A reference to the HashMap object that contains parameters to initialize the DataControl. This DataControl implementation requires the following initialization parameters:
  • Directory host name.
  • Directory port number.
  • DN for the Directory Manager.
  • Password for the Directory Manager.
  • The prefix used for mapping the property name for the user space keys to the corresponding directory attribute name.
Throws:
IllegalCredentialException - If the given credentials are not supported by the concrete DataControl implementation.
DataControlException - If unable to instantiate the DataControl object
Method Detail

initialize

protected void initialize(java.util.HashMap settingMap)
                   throws DataControlException
This method is used to initialize the DataControl with the given settings. The contents of the settings container are specific to the concrete implementation of the class.

Specified by:
initialize in class DataControl
Parameters:
settingMap - Reference to the HashMap object that contains the parameters used to initialize the DataControl. This DataControl implementation requires the following initialization parameters:
  • Directory host name.
  • Directory port number.
  • DN for the Directory Manager.
  • Password for the Directory Manager.
  • The prefix used for mapping the property name for the user space keys to the corresponding directory attribute name.
Throws:
DataControlException - If unable to initialize the DataControl

destroy

protected void destroy()
This method is invoked when the Entity has been signalled as "dying". It is responsible for cleaning up the master record.

Specified by:
destroy in class DataControl

bind

public void bind(Credential cred)
          throws IllegalCredentialException,
                 DataControlException
This method is used to bind the given credential to the DataControl if the credential can be authenticated against the directory server.

Specified by:
bind in class DataControl
Parameters:
cred - Reference to the credential object used to authenticate the entity to the back-end data store.
Throws:
IllegalCredentialException - If the given credentials is not supported by the DataControl.
DataControlException - If unable to bind the credential to the DataControl.

acquire

protected void acquire()
                throws DataControlException
Description copied from class: DataControl
This method is used to establish a connection to the back-end data store. The method is called by each of the methods that access the data store.

Specified by:
acquire in class DataControl
Throws:
DataControlException - If unable to establish connection to the back-end data store.

release

protected void release()
                throws DataControlException
Description copied from class: DataControl
This method is used to release a connection to the back-end data store. The method is called by each of the methods that access the data store.

Specified by:
release in class DataControl
Throws:
DataControlException - If unable to close the connection to the back-end data store.

activate

protected void activate()
                 throws ActivationException
Description copied from class: DataControl
This method is used to activates the DataControl after the Entity object containing this DataControl is deserialized.

Specified by:
activate in class DataControl
Throws:
ActivationException - If unable to activate the DataControl

deactivate

protected void deactivate()
                   throws ActivationException
Description copied from class: DataControl
This method is called to deactivate the DataControl. This method is called by the Entity object that contains this DataControl when the Entity is being serialized.

Specified by:
deactivate in class DataControl
Throws:
ActivationException - If unable to de-activate the DataControl.

modifyCredentialSpaceImpl

protected void modifyCredentialSpaceImpl(ModifierContainer container)
                                  throws DataControlException
Description copied from class: DataControl
This method provides the actual implementation to the modifyCredentialSpace() method.

Since the modifyCredentialSpace() method has already called the acquire() and release() methods, implementations of this method only need to handle the core modification logic. It does not need to worry about connection and other low level system resource management.

Specified by:
modifyCredentialSpaceImpl in class DataControl
Parameters:
container - Encapsulates the list of modifications to be executed on the Credential space.
Throws:
DataControlException - This exception is thrown if unable to perform the requested modifications.

getValueFromCredentialSpaceImpl

protected Credential getValueFromCredentialSpaceImpl(java.lang.String key)
                                              throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getValueFromCredentialSpace( key ) method. This method is used to separate the logic for opening/closing connections from the actual operation logic.

Specified by:
getValueFromCredentialSpaceImpl in class DataControl
Parameters:
key - The key that uniquely identifies a set of credentials.
Returns:
The reference to the first credential instance that was previously associated to the given key. If the given key is not found, the method returns null.
Throws:
DataControlException - If unable to retrieve a credential from the credential store.

getFromCredentialSpaceImpl

protected java.util.Vector getFromCredentialSpaceImpl(java.lang.String key)
                                               throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getFromCredentialSpace( key ) method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation

Specified by:
getFromCredentialSpaceImpl in class DataControl
Parameters:
key - The key used to identify the requested credentials.
Returns:
A Vector with all the credentials associated with the given key. If no credential is found with the given key then this method returns an empty vector.
Throws:
DataControlException - If unable to retrieve the credentials from the credential store.

getCredentialSpaceKeysImpl

protected java.lang.String[] getCredentialSpaceKeysImpl(java.lang.String startsWith)
                                                 throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getCredentialSpaceKeys( startsWith ) method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation

Specified by:
getCredentialSpaceKeysImpl in class DataControl
Parameters:
startsWith - The prefix of the requested credential keys.
Returns:
A String array with the keys that start with the given prefix. If the given prefix is null, this method returns all the available keys. Finally if no keys are found with the given key, this method returns an empty array.
Throws:
DataControlException - If unable to fetch the credential space.

modifyUserSpaceImpl

protected void modifyUserSpaceImpl(ModifierContainer container)
                            throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the modifyUserSpace( container ) method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation.

Specified by:
modifyUserSpaceImpl in class DataControl
Parameters:
container - Encapsulates the list of modifications to be executed on the user space of the entity.
Throws:
DataControlException - If unable to perform any of the requested modifications.

getValueFromUserSpaceImpl

protected java.io.Serializable getValueFromUserSpaceImpl(java.lang.String key)
                                                  throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getValueFromUserSpace() method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation.

Specified by:
getValueFromUserSpaceImpl in class DataControl
Parameters:
key - The key that uniquely idenfifies a set of objects in the user space.
Returns:
The first object reference that matches the given key.
Throws:
DataControlException - If unable to retrieve the requested object from the user space.

getFromUserSpaceImpl

protected java.util.Vector getFromUserSpaceImpl(java.lang.String key)
                                         throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getFromUserSpace() method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation.

Specified by:
getFromUserSpaceImpl in class DataControl
Parameters:
key - The key used to identify the set of objects in the user space.
Returns:
A Vector with all the objects associated with the given key. If the given key is not found, this method returns an empty vector.
Throws:
DataControlException - If Unable to retrieve requested information from the user space.

getUserSpaceKeysImpl

protected java.lang.String[] getUserSpaceKeysImpl(java.lang.String startsWith)
                                           throws DataControlException
Description copied from class: DataControl
This method contains the actual implementation for the getUserSpaceKeys() method. This method is used to separate the logic for opening/closing connections from the actual logic to perform the operation.

Specified by:
getUserSpaceKeysImpl in class DataControl
Parameters:
startsWith - The prefix string used to search for the currently available user space keys. If no key matches the given prefix, this method returns an empty array
Returns:
A String array with the user space keys that matches the given prefix. If no match is found, the method returns an empty array.
Throws:
DataControlException - If unable to retrieve the requested information from the user space

changeDataControlCredential

protected void changeDataControlCredential(Credential newCred,
                                           boolean modBackend)
                                    throws IllegalCredentialException,
                                           DataControlException
This method change the DataControl credential for user. If you want to call this method, you must define the configuration key com.nitido.nimx.services.datacontrol.attributemap.password.

Specified by:
changeDataControlCredential in class DataControl
Parameters:
newCred - The new credential to be changed for the currently binded user.
modBackend - If this flag is set to true, this method should change the login credential in the backend server as specified. Otherwise, this method only need to change how this DataControl establish the connection to the backend.
Throws:
IllegalCredentialException - If the given credentials is not supported by the DataControl.
DataControlException - If unable to bind the credential to the DataControl.

modifyHash

protected static void modifyHash(OpenSerializableHash hash,
                                 Modifier modifier)
This method is used to modify given hash according to the operation described in the given Modifier object..

Parameters:
hash - The open hash being modified
modifier - The operation being performed to the open hash

getKeysFromHash

protected static java.util.Vector getKeysFromHash(OpenSerializableHash hash,
                                                  java.lang.String startsWith)
Utility method to get the keys from the given hash whose name start with the given prefix.

Parameters:
hash - Reference to the memory hash
startsWith - The prefix of the requested keys from the hash.

getUserDN

protected java.lang.String getUserDN()
This method returns the user DN associated to this instance of DataControl. It is a convenience method for the DataControlServiceImpl to determine the userDN as the key for the CacheDataMasterRecord.


modifyInMemoryData

protected void modifyInMemoryData(java.util.ArrayList inMemoryModifiers)

getFromInMemoryData

protected java.util.Vector getFromInMemoryData(java.lang.String key)

getKeysFromInMemoryData

protected java.util.Vector getKeysFromInMemoryData(java.lang.String startsWith)

Nitido NiM 2.5 Java API

These JavaDoc pages are generated for release/nim_2_5-2.5.44

Copyright © 1999-2009 Nitido Inc.    Proprietary and Confidential.    All Rights Reserved.