com.nitido.nim
Class EntitlementService

java.lang.Object
  com.nitido.nim.NiMKernelService
      com.nitido.nim.EntitlementService

All Implemented Interfaces:

NiMConstants

Direct Known Subclasses:

EntitlementServiceImpl, EntitlementServiceImpl

public abstract class EntitlementService
extends NiMKernelService

The EntitlementService is the NiMKernel module responsible for checking the entitlements associated to a given credential

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

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

Method Summary

abstract void	changeEntitlementCredential(Credential oldCred, Credential newCred) This method is used to change the user credentials to the entitlement service.
protected abstract void	init(NiMKernel kernel, ConfigurationService confService) This method is used to initialize the kernel service.
protected abstract boolean	isAllowed(java.lang.String action, java.util.Map params, Credential credential) This method checks whether the given credential is entitled to perform the given action.
boolean	isAllowedForwarder(java.lang.String action, java.util.Map params, Credential credential) This method is used to check whether the given credential is entitled to perform the given action.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntitlementService

public EntitlementService(NiMKernelServiceVisa visa)

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

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 abstract 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 NiMKernelService

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.

isAllowedForwarder

public final boolean isAllowedForwarder(java.lang.String action,
                                        java.util.Map params,
                                        Credential credential)
                                 throws java.lang.IllegalArgumentException

This method is used to check whether the given credential is entitled to perform the given action. This method is a forwarder to the isAllowed() method.

Parameters:

action - The string representation of the action being done.

params - Reference to the parameters used to launch the given action.

credential - The credential entitled to make the given action.

Returns:

true if the credential is entitled to make the action otherwise false.

Throws:

java.lang.IllegalArgumentException - If any of the given arguments are invalid

isAllowed

protected abstract boolean isAllowed(java.lang.String action,
                                     java.util.Map params,
                                     Credential credential)
                              throws java.lang.IllegalArgumentException

This method checks whether the given credential is entitled to perform the given action.

Parameters:

action - The string representation of the action being done.

params - Reference to the parameters used to launch the given action.

credential - The credential entitled to make the given action.

Returns:

true if the credential is entitled to make the action otherwise false.

Throws:

java.lang.IllegalArgumentException - If any of the given arguments are invalid

changeEntitlementCredential

public abstract void changeEntitlementCredential(Credential oldCred,
                                                 Credential newCred)
                                          throws IllegalCredentialException,
                                                 NiMException

This method is used to change the user credentials to the entitlement service. This method is called by the EntityService implementation if it is configured to change the entitlement credential when the application calls the method Entity.changeIdentifyingCredential().

Parameters:

oldCred - The original credential.

newCred - The new credential.

Throws:

IllegalCredentialException - If the given credentials are incorrect.

NiMException - If unable to contact the back-end service.