Nitido Inc.

com.nitido.nimx.services.simbackend
Class BackendStore

java.lang.Object
  extended by com.nitido.nimx.services.simbackend.BackendStore

public class BackendStore
extends java.lang.Object

This simulates the backend BackendStore.

You can access the methods on this store to check if the data has been stored correctly.


Field Summary
static java.lang.String CONF_KEY_ALLOW_ALL
          The configuration key for indicating if the simulator backend will allow all login and binding without being provisioned before.
static java.lang.String CONF_KEY_PREFIX_ATTRIBUTEMAP
          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_NUGGETSETTING
          The key prefix of the nugget settings information.
static java.lang.String CONF_KEY_PREFIX_NUGGETTYPE
          The key prefix of the nugget class information.
static java.lang.String CONF_KEY_PREFIX_TYPEMAP
          The configuration key prefix for the mapping settings from a user space key to a LDAP attribute name.
static int LEN_CONF_KEY_PREFIX_TYPEMAP
          The length of the string CONF_KEY_PREFIX_TYPEMAP.
 
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
 
Method Summary
protected  void authenticate(Credential cred)
           
protected  void bind(Credential cred)
           
protected  void changeCredential(Credential oldCred, Credential newCred)
           
protected  void deprovisionEntity(Credential targetCred)
          Deprovision the entity.
protected static BackendStore getInstance()
          This factory method returns an instance of BackendStore.
protected  java.io.Serializable getValueFromUserProfile(Credential cred, java.lang.String userSpaceKey)
           
protected  java.util.Vector getValuesVectorFromUserProfile(Credential cred, java.lang.String userSpaceKey)
           
protected static BackendStore initStore(ConfigurationService confService)
          Used to initialize this backend store.
protected  boolean isProvisioned(Credential targetCred)
           
protected  void modifyUserProfile(Credential cred, Modifier modifier)
           
protected  void provisionEntity(EntityProvisionDescriptor descriptor)
          This method is used to provision a new entity and stored in memory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONF_KEY_ALLOW_ALL

public static final java.lang.String CONF_KEY_ALLOW_ALL
The configuration key for indicating if the simulator backend will allow all login and binding without being provisioned before.

See Also:
Constant Field Values

CONF_KEY_PREFIX_ATTRIBUTEMAP

public static final java.lang.String CONF_KEY_PREFIX_ATTRIBUTEMAP
The configuration key prefix for the mapping settings from a user space key to a LDAP attribute name.

See Also:
Constant Field Values

CONF_KEY_PREFIX_NUGGETTYPE

public static final java.lang.String CONF_KEY_PREFIX_NUGGETTYPE
The key prefix of the nugget class information.

See Also:
Constant Field Values

CONF_KEY_PREFIX_NUGGETSETTING

public static final java.lang.String CONF_KEY_PREFIX_NUGGETSETTING
The key prefix of the nugget settings information.

See Also:
Constant Field Values

CONF_KEY_PREFIX_TYPEMAP

public static final java.lang.String CONF_KEY_PREFIX_TYPEMAP
The configuration key prefix for the mapping settings from a user space key to a LDAP attribute name.

See Also:
Constant Field Values

LEN_CONF_KEY_PREFIX_TYPEMAP

public static final int LEN_CONF_KEY_PREFIX_TYPEMAP
The length of the string CONF_KEY_PREFIX_TYPEMAP.

Method Detail

initStore

protected static BackendStore initStore(ConfigurationService confService)
Used to initialize this backend store.


getInstance

protected static BackendStore getInstance()
This factory method returns an instance of BackendStore. In every JVM, there will be at most one instance of BackendStore.


provisionEntity

protected void provisionEntity(EntityProvisionDescriptor descriptor)
                        throws java.lang.IllegalArgumentException,
                               EntityProvisionException,
                               PermissionDeniedException,
                               NiMException
This method is used to provision a new entity and stored in memory.

Parameters:
descriptor - The entity descriptor is data container that holds all the information necessary to provision the required Entity
Throws:
java.lang.IllegalArgumentException - If any of the given arguments are null.
EntityProvisionException - If unable to cprovision the entity due to inconsistencies on the data in the EntityProvisionDescriptor and the back-end requirements.
PermissionDeniedException - If given Entity does not have permission to perform the required action.
NiMException - If unable to establish a connection with the back-end provisioning service.

deprovisionEntity

protected void deprovisionEntity(Credential targetCred)
                          throws java.lang.IllegalArgumentException,
                                 PermissionDeniedException,
                                 NiMException
Deprovision the entity.

Throws:
java.lang.IllegalArgumentException
PermissionDeniedException
NiMException

isProvisioned

protected boolean isProvisioned(Credential targetCred)

authenticate

protected void authenticate(Credential cred)
                     throws AuthenticationFailedException,
                            NiMException
Throws:
AuthenticationFailedException
NiMException

bind

protected void bind(Credential cred)
             throws IllegalCredentialException
Throws:
IllegalCredentialException

modifyUserProfile

protected void modifyUserProfile(Credential cred,
                                 Modifier modifier)
                          throws DataControlException
Throws:
DataControlException

getValueFromUserProfile

protected java.io.Serializable getValueFromUserProfile(Credential cred,
                                                       java.lang.String userSpaceKey)

getValuesVectorFromUserProfile

protected java.util.Vector getValuesVectorFromUserProfile(Credential cred,
                                                          java.lang.String userSpaceKey)

changeCredential

protected void changeCredential(Credential oldCred,
                                Credential newCred)
                         throws IllegalCredentialException
Throws:
IllegalCredentialException

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.