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

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nim.DataControlService
          com.nitido.nimx.services.datacontrol.cachedmap.DataControlServiceImpl

All Implemented Interfaces:

CredentialConstants, NiMConstants

public class DataControlServiceImpl
extends DataControlService
implements CredentialConstants

This implementation of DataControlService is a factory for cached-mapping DataControls that connected to a backend LDAP server through connection pool.

Main Features

• Utilized the DirPoolService to connect to the backend LDAP service.
• Optimized the access with the separation of READ-only access from time consuming write access.
• Attributes that have been modified/accessed by the application can be cached in memory.
• Each attribute can be configured to have different time to be cached in memory.
• Support attribute prefetching and batch fetching of expired cache.

Detail Description

When the application attempts to get a NiM Entity object for a specific object, NiM Kernel will invoke the DataControlService to generate an instance of the DataControl object to provide the data access logic for the specified Entity.

Depending on the configuration, this implementation generates the LDAP login DN in the following steps:

1. Assuming the Entity is logging in with a credential of the type "MyCredType". If the configuration "com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.MyCredType" existis, the login DN will be fetched from the credential token key specified by this configuration.
2. If the previous configuration is not specified, this implementation will uses the credential's identifying entity ID and the configuration "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnprefix.MyCredType" and the configuration "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnpostfix.MyCredType" to generate the login DN for the backend LDAP.
3. If the previous step failed because one of the configurations is missing, an IllegalCredentialException will be thrown.

This DataControl also supports prefetching and batch fetching if the configuration "com.nitido.nimx.services.datacontrol.cachedmap.prefetch" is set to "true". Configuration Settings

This service requires the following configurations:

• com.nitido.nimx.services.datacontrol.cachedmap.readpool
  • The constant is CONF_KEY_READ_POOL
  • The name of the directory connection pool to be used for read only access.
  • This is a required configuration. The valid value is a directory pool name that has been configured for the DirPoolService.
• com.nitido.nimx.services.datacontrol.cachedmap.writepool
  • The constant is CONF_KEY_WRITE_POOL
  • The name of the directory connection pool to be used for write access.
  • This is a required configuration. The valid value is a directory pool name that has been configured for the DirPoolService.
• com.nitido.nimx.services.datacontrol.cachedmap.resetonentity
  • The constant is CONF_KEY_RESET_ON_ENTITY
  • Boolean flag that determines 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.
  • This is an optional configuration. The valid value is "true" or "false". A "true" value indicates the cache will be reset when the user's Entity object is released. The default value is "true".
• com.nitido.nimx.services.datacontrol.cachedmap.checkcredwhenbind
  • The constant is CONF_KEY_CHECK_CRED_WHEN_BIND.
  • The boolean flag that specifies whether the DataControl object will recheck the validity of the credential for every bind.
  • This option is recommended to be set to false, as it will generate additional network traffic and LDAP binding operation. It was designed mainly for systems where the authentication service and the data control service are connecting to different backend LDAP server and the user credential is altered frequently.
  • This is an optional configuration. If the value is "true", the data control will check the validity of the credential for every access. Otherwise, the default value "false" will be used.
• com.nitido.nimx.services.datacontrol.cachedmap.prefetch
  • The constant for the key prefix is CONF_KEY_PREFETCH
  • It is a boolean flag that indicates whether prefetching and batch fetching is used.
  • Prefetching means the data control will prefetch a set of attributes when the DataControl object is initialized. Batch fetching means the data control will fetch a set of attributes in the same LDAP command if their corresponding cache has expired (and one of these attributes are being requested).
  • If this option is enabled, all the attributes with the attributemap configuration starting with [prefetch] will be "prefetched" and "batch fetched"
  • During development, this option should be set to "false". So that a developer can modify the backend server and see the effect on the application immediately. However, you will likely to use the prefetching feature on the production system.
  • This is an optional configuration. If the value is "true", the data control will check the validity of the credential for every access. Otherwise, the default value "false" will be used.
• com.nitido.nimx.services.datacontrol.cachedmap.passwordmap
  • The constant is CONF_KEY_PASSWORD_MAP.
  • This value is mapping between the credential token key to the LDAP attribute name.
  • A valid value should be in the format of "ldapAttributeName", where "ldapAttributeName" is the actual LDAP attribute name that stores the password. If the application uses standard LDAP schema, the "ldapAttributeName" is usually "userPassword".
  • For example, if the underlying LDAP attribute is "userPassword", this configuration should have the value "userPassword".
  • This is a required configuration. The valid value is a directory pool name that has been configured for the DirPoolService.
  • No user space keys can mapped to the attribute key specified by this configuration. This forces the application cannot modify the password through the User Space. (NOTE: all credential changes should be done through Entity.changeIdentifyingCredential(), which is eventually handled by AuthenticationService.changeAuthenticationCredential(). )
• com.nitido.nimx.services.datacontrol.cachedmap.cred.nobackend
  • The constant for the key prefix is CONF_KEY_CRED_NO_BACKEND.
  • The value is a comma separated list of credential type that should have no backend access. i.e. the backend accessable DataControl will be initialized for an Entity only if its login credential's type does not appear in this list.
  • This configuraton is optional. It can be left unspecified (which means all credential type will have backend access).
• com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.<CredType>
  • The constant for the key prefix is CONF_KEY_PREFIX_DN_TOKEN_KEY.
  • The string value is the token key in the specified type of credentials that provide the user's LDAP login DN.
  • In the configuration key, the <CredType> is the credential type used by the application to obtain the Entity object. For example, for a credential type "User", the DN prefix configuration key will be "com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.User".
  • If this configuration is specified, the configurations "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnprefix.<CredType>" and "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnpostfix.<CredType>" will be ignored.
• com.nitido.nimx.services.datacontrol.cachedmap.cred.dnprefix.<CredType>
  • The constant for the key prefix is CONF_KEY_PREFIX_DN_PREFIX.
  • This configuration will be ignored if the configuration "com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.<CredType>" has been specified.
  • The string value is used as the prefix for constructing the login DN.
  • In the configuration key, the <CredType> is the credential type used by the application to obtain the Entity object. For example, for a credential type "User", the DN prefix configuration key will be "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnprefix.User".
• com.nitido.nimx.services.datacontrol.cachedmap.cred.dnpostfix.<CredType>
  • The constant for the key prefix is CONF_KEY_PREFIX_DN_POSTFIX
  • This configuration will be ignored if the configuration "com.nitido.nimx.services.datacontrol.cachedmap.cred.dntokenkey.<CredType>" has been specified.
  • The string value is used as the postfix for constructing the login DN.
  • In the configuration key, the <CredType> is the credential type used by the application to obtain the Entity object. For example, for a credential type "User", the DN postfix configuration key will be "com.nitido.nimx.services.datacontrol.cachedmap.cred.dnpostfix.User".
• com.nitido.nimx.services.datacontrol.cachedmap.attributemap.<AttrKey>
  • The constant for the key prefix is CONF_KEY_PREFIX_ATTRIBUTEMAP
  • The string value is in the format of "[prefetch,readOnlyBackend]readLimit:writeLimit:mappedKey".
    • The [] symbol encapsulate the cache policy modifier of the specified attribute. It contains a comma separated string. This is an optional string. If you don't need any policy modifier, you can simply omit the [] symbols.
      It support the following policy modifiers:
      • prefetch is an optional policy modifier. If this string exists and the configuration "com.nitido.nimx.services.datacontrol.cachedmap.prefetch" is set to "true", then, this attribute will be "prefetched" and "batch fetched". By default, it is set to false.
      • readOnlyBackend is also an optional policy. If this string exists, the DataControl will NOT write any changes to the backend. (i.e. it will only read the data from the backend and/or cache the value, but not modifying it.) It is usually used for systems that requires the write operation to go through other provisioning systems. By default, it is set to false.
    • The readLimit field is an integer of milliseconds that represents the caching time of a data that has just been read. "-1" means no cache. "0" means no cache expiry (i.e. cache forever). Any other positive integer will be regarded as the life time of the cache.
    • The writeLimit field is an integer of milliseconds that represents the caching time of a data that has been written. "-1" means no cache. "0" means no cache expiry (i.e. cache forever). Any other positive integer will be regarded as the life time of the cache.
    • The mappedKey is the actual LDAP attribute name to be stored.
  • In the configuration key, the <AttrKey> field is the user space key to be configured.
  • Example 1, the setting "com.nitido.nimx.services.datacontrol.cachedmap.attributemap.myfield=200:500:mobile" will map the user space key "myfield" to be stored as "mobile" attribute in the LDAP entry. The system will cache a recently read value for 200 milliseconds and will cache a newly updated value for 500 milliseconds.
  • Example 2, the setting "com.nitido.nimx.services.datacontrol.cachedmap.attributemap.testField=[prefetch]500:300:testField" will map the user space key "testField" to be stored as "testField" attribute in the LDAP entry. This attribute will be prefetched and batch fetched. The system will cache a recently read value for 500 milliseconds and will cache a newly updated value for 300 milliseconds.

  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.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

  Fields inherited from interface com.nitido.nim.CredentialConstants

  CRED_ADMIN, CRED_CONTAINER, CRED_HELPDESK, CRED_SYSTEM, CRED_USER, KEY_PASSWORD

  Constructor Summary

  DataControlServiceImpl(NiMKernelServiceVisa visa)
  This class constructor is used by NiMKernel to instantiate a new DataControlService.

  Method Summary

  protected Directory	connectRead(java.lang.String dn, java.lang.String pwd)
  protected Directory	connectWrite(java.lang.String dn, java.lang.String pwd)
  protected com.nitido.nimx.services.datacontrol.cachedmap.BindData	credentialToBindData(Credential cred) This method is invoked by the DataControl object to obtain the DN for the specified credential.
  protected java.lang.String	credentialToUserDN(Credential cred) This method is invoked by the DataControl object to obtain the DN for the specified credential.
  protected void	disconnectRead(Directory dir)
  protected void	disconnectWrite(Directory dir)
  protected java.util.Vector	getCacheDataValues(java.lang.String bindDN, java.lang.String bindPwd, java.lang.String userDN, java.lang.String key)
  protected com.nitido.nimx.services.datacontrol.cachedmap.CacheSetting	getCacheSetting(java.lang.String key)
  protected java.util.List	getCacheSettingsForPrefetch()
  DataControl	getDataControl(Credential credential) This method is a factory method for DataControl objects.
  protected static DataControlServiceImpl	getInstance()
  protected java.util.Vector	getMappedUserSpaceKeys()
  protected void	init(NiMKernel kernel, ConfigurationService confService) This method is used by the kernel to initialize the DataControlService.
  protected void	modifyBackend(java.lang.String bindDN, java.lang.String bindPwd, java.lang.String userDN, java.util.HashMap backendModifiers, java.util.HashMap cacheOnlyModifiers)
  protected void	prefetchAttributes(java.lang.String bindDN, java.lang.String bindPwd, java.lang.String userDN)
  protected void	releaseMasterRecord(java.lang.String dn)

  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

  DataControlServiceImpl

  public DataControlServiceImpl(NiMKernelServiceVisa visa)

  This class constructor is used by NiMKernel to instantiate a new DataControlService.

  Parameters:

  visa - Reference to the NiMKernelServiceVisa object required to instantiate the service. This parameter is required to ensure that only the NiMkernel can instantiate a reference to this service.

  Method Detail

  getInstance

  protected static DataControlServiceImpl getInstance()

  init

  protected void init(NiMKernel kernel,
                      ConfigurationService confService)
               throws InitializationFailedException,
                      NiMException

  This method is used by the kernel to initialize the DataControlService.

  Specified by:

  init in class DataControlService

  Parameters:

  kernel - Reference to the kernel that instantiated this service.

  confService - A reference to the ConfigurationService.

  Throws:

  InitializationFailedException - If unable to initialize the DataControlService. This exception is thrown by this service implementation if any of the expected settings are not available.

  NiMException - This exception is never thrown by this service implementation

  getDataControl

  public DataControl getDataControl(Credential credential)
                             throws IllegalCredentialException,
                                    DataControlException

  Description copied from class: DataControlService

  This method is a factory method for DataControl objects.

  Specified by:

  getDataControl in class DataControlService

  Parameters:

  credential - The credential used by the DataControl to access the back-end data.

  Throws:

  IllegalCredentialException - If the given credential is not valid.

  DataControlException - If the DataControl service is unable to establish a connection with the back-end data services.

  credentialToUserDN

  protected java.lang.String credentialToUserDN(Credential cred)
                                         throws IllegalCredentialException

  This method is invoked by the DataControl object to obtain the DN for the specified credential.

  Throws:

  IllegalCredentialException

  credentialToBindData

  protected com.nitido.nimx.services.datacontrol.cachedmap.BindData credentialToBindData(Credential cred)
                                                                                  throws IllegalCredentialException

  This method is invoked by the DataControl object to obtain the DN for the specified credential.

  Throws:

  IllegalCredentialException

  getCacheDataValues

  protected java.util.Vector getCacheDataValues(java.lang.String bindDN,
                                                java.lang.String bindPwd,
                                                java.lang.String userDN,
                                                java.lang.String key)
                                         throws DataControlException

  Throws:

  DataControlException

  prefetchAttributes

  protected void prefetchAttributes(java.lang.String bindDN,
                                    java.lang.String bindPwd,
                                    java.lang.String userDN)
                             throws DataControlException

  Throws:

  DataControlException

  modifyBackend

  protected void modifyBackend(java.lang.String bindDN,
                               java.lang.String bindPwd,
                               java.lang.String userDN,
                               java.util.HashMap backendModifiers,
                               java.util.HashMap cacheOnlyModifiers)
                        throws DataControlException

  Throws:

  DataControlException

  getMappedUserSpaceKeys

  protected java.util.Vector getMappedUserSpaceKeys()

  getCacheSettingsForPrefetch

  protected java.util.List getCacheSettingsForPrefetch()

  getCacheSetting

  protected com.nitido.nimx.services.datacontrol.cachedmap.CacheSetting getCacheSetting(java.lang.String key)

  releaseMasterRecord

  protected void releaseMasterRecord(java.lang.String dn)

  connectRead

  protected Directory connectRead(java.lang.String dn,
                                  java.lang.String pwd)
                           throws DataControlException

  Throws:

  DataControlException

  connectWrite

  protected Directory connectWrite(java.lang.String dn,
                                   java.lang.String pwd)
                            throws DataControlException

  Throws:

  DataControlException

  disconnectRead

  protected void disconnectRead(Directory dir)
                         throws DataControlException

  Throws:

  DataControlException

  disconnectWrite

  protected void disconnectWrite(Directory dir)
                          throws DataControlException

  Throws:

  DataControlException