com.nitido.nimx.services.uniqueid.ipdomain
Class UniqueIdServiceImpl

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nim.UniqueIdService
          com.nitido.nimx.services.uniqueid.ipdomain.UniqueIdServiceImpl

All Implemented Interfaces:

NiMConstants

public class UniqueIdServiceImpl
extends UniqueIdService

This class implements the UniqueIdService interface. This implementation generates unique ids that are based on the IP address of the local machine.

The generated ID is unique as long as there is only one instance of NiM is running on each machine and the involving machines do not have the same IP address.

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

UniqueIdServiceImpl(NiMKernelServiceVisa visa)
This class constructor is used by NiMKernel to instantiate a new UniqueIdService

Method Summary

java.lang.String	generateUniqueId() This method generates an identifier that is unique accross method invocations and accross an IP domain.
protected void	init(NiMKernel kernel, ConfigurationService confService) This method is used to initialize the kernel service.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniqueIdServiceImpl

public UniqueIdServiceImpl(NiMKernelServiceVisa visa)

This class constructor is used by NiMKernel to instantiate a new UniqueIdService

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

init

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

Description copied from class: NiMKernelService

This method is used to initialize the kernel service. Extenders of this class must implement this method.

Specified by:

init in class UniqueIdService

Parameters:

kernel - Reference to the NiMKernel object that instantiated the service.

confService - A reference to the configuration service. All the service implementations (except ConfigurationService) should retrieve the setting information from it.

Throws:

InitializationFailedException - If unable to initialize the kernel service.

NiMException - If service initialization can not be done due to failure in establish a connection to the back-end service. Not all service implementation will throw this exception.

generateUniqueId

public java.lang.String generateUniqueId()

This method generates an identifier that is unique accross method invocations and accross an IP domain.

The identifier is guranteed to be unique on the machine that the call is being run on. An attempt is made to make the identifier unique across machines within the IP domain by including the host IP information in the identifier. However, this operation is not gauranteed and no exception will be thrown even if the operation fails. Thus, the generated identifier will not be unique if the call to InetAddress.getLocalHost() fails or if the response to this opreation can generate a machine id that is not unique (for example in the use of IP masquerading).

Specified by:

generateUniqueId in class UniqueIdService

Returns:

A string containing a unique identifier.