com.nitido.nimx.services.dirpool.mozilla
Class DirPoolService

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nimx.services.dirpool.mozilla.DirPoolService

All Implemented Interfaces:

NiMConstants

public abstract class DirPoolService
extends NiMKernelService

The Directory Pool Service is a factory of com.nitido.directory.Directory object that utilizes connect pool mechanism. The implementation of this service returns a Directory object that can obtain/release directory from a connection pool. The application code does not need to call this service again when releasing the Directory connection.

Field Summary

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

DirPoolService(NiMKernelServiceVisa visa)
This constructor is used by NiMKernel to instantiate a new DirPoolService.

Method Summary

abstract java.util.List<DirPoolStatus>	getAllDirPoolStatus() This method returns an ArrayList of DirPoolStatus object.
abstract Directory	getDirectory(java.lang.String poolName) This method returns a com.nitido.directory.Directory object that utilizes a Directory Pool.
abstract DirPoolStatus	getDirPoolStatus(java.lang.String poolName) This method returns a DirPoolStatus object of the specified pool.
abstract void	resetAllDirPools() This method is a global "hard-reset" of all the directory pool that has been used.
abstract void	resetDirPool(java.lang.String poolName) This method is a "hard-reset" of the directory pool.

Methods inherited from class com.nitido.nim.NiMKernelService

init

Methods inherited from class java.lang.Object

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

Constructor Detail

DirPoolService

public DirPoolService(NiMKernelServiceVisa visa)

This constructor is used by NiMKernel to instantiate a new DirPoolService. It is part of the standard NiMKernelService API.

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

getDirectory

public abstract Directory getDirectory(java.lang.String poolName)
                                throws DirectoryException

This method returns a com.nitido.directory.Directory object that utilizes a Directory Pool. The application does not need to worry about managing the Directory Pool. It can simply invoke on the connect() and disconnect() methods on the Directory object returned by this method.

Parameters:

poolName - The directory pool name to generate the Directory object for.

Returns:

A Directory object that utilizes the backend Directory Pool.

Throws:

DirectoryException

resetDirPool

public abstract void resetDirPool(java.lang.String poolName)
                           throws DirectoryException

This method is a "hard-reset" of the directory pool. This method is invoked by the application when the backend data server's architecture has been changed due to server failure/recovery AND the corresponding load balancer fails to handle it. It may also been invoked if the configuration has been chagned. In most cases, an application should never need to invoke this method.

Parameters:

poolName - The name of the directory pool to be reset.

Throws:

DirectoryException

resetAllDirPools

public abstract void resetAllDirPools()
                               throws DirectoryException

This method is a global "hard-reset" of all the directory pool that has been used. This method is invoked by the application when the backend data server's architecture has been changed due to server failure/recovery AND the corresponding load balancer fails to handle it. It may also been invoked if the configuration has been chagned. In most cases, an application should never need to invoke this method.

Throws:

DirectoryException

getAllDirPoolStatus

public abstract java.util.List<DirPoolStatus> getAllDirPoolStatus()

This method returns an ArrayList of DirPoolStatus object. Each DirPoolStatus object represent the curent status of a configured pool. In othre words, the size of the returning ArrayList is always equals to the number of pools that has been configured.

Returns:

An ArrayList of DirPoolStatus objects. If no pool has been configured, this method will return an empty ArrayList.

getDirPoolStatus

public abstract DirPoolStatus getDirPoolStatus(java.lang.String poolName)

This method returns a DirPoolStatus object of the specified pool.

Parameters:

poolName - The name of the directory pool for obtaining the status.

Returns:

A DirPoolStatus object that represents the specified pool. If the pool is not configured, this method will return null.