com.iplanet.am.sdk.remote

Class CachedRemoteServicesImpl

java.lang.Object

com.iplanet.am.sdk.remote.RemoteServicesImpl

com.iplanet.am.sdk.remote.CachedRemoteServicesImpl

All Implemented Interfaces:

ICachedDirectoryServices, IDirectoryServices

public class CachedRemoteServicesImpl
extends RemoteServicesImpl
implements ICachedDirectoryServices

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NSROLE_ATTR
protected static String	NSROLEDN_ATTR

Fields inherited from class com.iplanet.am.sdk.remote.RemoteServicesImpl

AM_SDK_DEBUG_FILE, AMSR_ATTRS, AMSR_CODE, AMSR_COUNT, AMSR_RESULTS, callBackHelperBase, complianceServicesImpl, dcTreeServicesImpl, debug, IDREPO_SERVICE, SDK_SERVICE

Method Summary

Modifier and Type	Method and Description
void	clearCache() This method is used to clear the entire SDK cache in the event that EventService notifies that all entries have been modified (or should be marked dirty).
String	createAMTemplate(SSOToken token, String entryDN, int objectType, String serviceName, Map attributes, int priority) Create an AMTemplate (COSTemplate)
void	createEntry(SSOToken token, String entryName, int objectType, String parentDN, Map attributes) Create an entry in the Directory
void	dirtyCache(String dn, int eventType, boolean cosType, boolean aciChange, Set attrNames) This method will be called by AMIdRepoListener.
boolean	doesEntryExists(SSOToken token, String entryDN) Checks if the entry exists in the directory.
Map	getAttributes(SSOToken token, String entryDN, boolean ignoreCompliance, boolean byteValues, int profileType) Gets all attributes corresponding to the entryDN.
Map	getAttributes(SSOToken token, String entryDN, int profileType) Returns a Map with attribute-values requested from the directory.
Map	getAttributes(SSOToken token, String entryDN, Set attrNames, boolean ignoreCompliance, boolean byteValues, int profileType) Gets the specific attributes corresponding to the entryDN.
Map	getAttributes(SSOToken token, String entryDN, Set attrNames, int profileType) Returns a Map with attribute-values requested from the directory.
Map	getAttributesByteValues(SSOToken token, String entryDN, int profileType) Returns a map of attribute-values for binary attributes.
Map	getAttributesByteValues(SSOToken token, String entryDN, Set attrNames, int profileType) Returns a map of attribute-values for binary attributes.
Map	getExternalAttributes(SSOToken token, String entryDN, Set attrNames, int profileType) Returns attributes from an external data store.
protected static IDirectoryServices	getInstance()
protected static int	getMaxSize() Method to get the maximum size of the Cache.
int	getObjectType(SSOToken token, String dn) Gets the type of the object given its DN.
String	getOrganizationDN(SSOToken token, String entryDN) Gets the Organization DN for the specified entryDN.
int	getSize() Method to get the current cache size
void	removeEntry(SSOToken token, String entryDN, int objectType, boolean recursive, boolean softDelete) Remove an entry from the directory.
String	renameEntry(SSOToken token, int objectType, String entryDN, String newName, boolean deleteOldName) Renames an entry.
void	setAttributes(SSOToken token, String entryDN, int objectType, Map stringAttributes, Map byteAttributes, boolean isAdd) Method Set the attributes of an entry.
void	setGroupFilter(SSOToken token, String entryDN, String filter) Sets the filter for a dynamic group in the datastore.
String	toString() Prints the contents of the cache.
void	updateUserAttribute(SSOToken token, Set members, String staticGroupDN, boolean toAdd) Adds or remove static group DN to or from member attribute 'iplanet-am-static-group-dn'

Methods inherited from class com.iplanet.am.sdk.remote.RemoteServicesImpl

addListener, changePassword, convertException, getAMTemplateDN, getAttributesForSchema, getAttributesFromDS, getComplianceServicesImpl, getCreationTemplateName, getDCTreeAttributes, getDCTreeServicesImpl, getDebug, getGroupFilterAndScope, getMembers, getNamingAttribute, getObjectClass, getObjectType, getOrgSearchFilter, getRegisteredServiceNames, getSearchFilterFromTemplate, getSOAPClient, getTopLevelContainers, modifyMemberShip, registerService, removeAdminRole, search, search, unRegisterService, verifyAndGetOrgDN

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.iplanet.am.sdk.common.IDirectoryServices

addListener, changePassword, getAMTemplateDN, getAttributesForSchema, getAttributesFromDS, getComplianceServicesImpl, getCreationTemplateName, getDCTreeAttributes, getDCTreeServicesImpl, getGroupFilterAndScope, getMembers, getNamingAttribute, getObjectClass, getObjectType, getOrgSearchFilter, getRegisteredServiceNames, getSearchFilterFromTemplate, getTopLevelContainers, modifyMemberShip, registerService, removeAdminRole, search, search, unRegisterService, verifyAndGetOrgDN

Field Detail

NSROLEDN_ATTR

protected static String NSROLEDN_ATTR

NSROLE_ATTR

protected static String NSROLE_ATTR

Method Detail

getSize

public int getSize()

Method to get the current cache size

Specified by:

getSize in interface ICachedDirectoryServices

Returns:

the size of the SDK LRU cache

getInstance

protected static IDirectoryServices getInstance()

getMaxSize

protected static int getMaxSize()

Method to get the maximum size of the Cache. To be called by all other LRU Caches that are created in AM SDK

Returns:

the maximum cache size for a LRU cache

toString

public String toString()

Prints the contents of the cache. For getDebug() purpose only

Overrides:

toString in class Object

dirtyCache

public void dirtyCache(String dn,
                       int eventType,
                       boolean cosType,
                       boolean aciChange,
                       Set attrNames)

This method will be called by AMIdRepoListener. This method will update the cache by removing all the entires which are affected as a result of an event notification caused because of changes/deletions/renaming of entries with and without aci's.

NOTE: The event could have been caused either by changes to an aci entry or a costemplate or a cosdefinition or changes to a normal entry

Specified by:

dirtyCache in interface ICachedDirectoryServices

Parameters:

dn - name of entity being modified

eventType - type of modification

cosType - true if it is cos related. false otherwise

aciChange - true if it is aci related. false otherwise

attrNames - Set of attribute Names which should be removed from the CacheEntry in the case of COS change

clearCache

public void clearCache()

This method is used to clear the entire SDK cache in the event that EventService notifies that all entries have been modified (or should be marked dirty).

Specified by:

clearCache in interface ICachedDirectoryServices

createEntry

public void createEntry(SSOToken token,
                        String entryName,
                        int objectType,
                        String parentDN,
                        Map attributes)
                 throws AMEntryExistsException,
                        AMException,
                        SSOException

Description copied from class: RemoteServicesImpl

Create an entry in the Directory

Specified by:

createEntry in interface IDirectoryServices

Overrides:

createEntry in class RemoteServicesImpl

Parameters:

token - SSOToken

entryName - name of the entry (naming value), e.g. "sun.com", "manager"

objectType - Profile Type, ORGANIZATION, AMObject.ROLE, AMObject.USER, etc.

parentDN - the parent DN

attributes - the initial attribute set for creation

Throws:

AMEntryExistsException

AMException

SSOException

doesEntryExists

public boolean doesEntryExists(SSOToken token,
                               String entryDN)

Description copied from class: RemoteServicesImpl

Checks if the entry exists in the directory.

Specified by:

doesEntryExists in interface IDirectoryServices

Overrides:

doesEntryExists in class RemoteServicesImpl

Parameters:

token - a valid SSOToken

entryDN - The DN of the entry that needs to be checked

Returns:

true if the entryDN exists in the directory, false otherwise

updateUserAttribute

public void updateUserAttribute(SSOToken token,
                                Set members,
                                String staticGroupDN,
                                boolean toAdd)
                         throws AMException

Description copied from class: RemoteServicesImpl

Adds or remove static group DN to or from member attribute 'iplanet-am-static-group-dn'

Specified by:

updateUserAttribute in interface IDirectoryServices

Overrides:

updateUserAttribute in class RemoteServicesImpl

Parameters:

token - SSOToken

members - set of user DN's

staticGroupDN - DN of the static group

toAdd - true to add, false to remove

Throws:

AMException - if there is an internal problem with AM Store.

getOrganizationDN

public String getOrganizationDN(SSOToken token,
                                String entryDN)
                         throws AMException

Gets the Organization DN for the specified entryDN. If the entry itself is an org, then same DN is returned.

NOTE: This method will involve serveral directory searches, hence be cautious of Performance hit.

This method does not call its base classes method unlike the rest of the overriden methods to obtain the organization DN, as it requires special processing requirements.

Specified by:

getOrganizationDN in interface IDirectoryServices

Overrides:

getOrganizationDN in class RemoteServicesImpl

Parameters:

token - a valid SSOToken

entryDN - the entry whose parent Organization is to be obtained

Returns:

the DN String of the parent Organization

Throws:

AMException - if an error occured while obtaining the parent Organization

getObjectType

public int getObjectType(SSOToken token,
                         String dn)
                  throws AMException,
                         SSOException

Gets the type of the object given its DN.

Specified by:

getObjectType in interface IDirectoryServices

Overrides:

getObjectType in class RemoteServicesImpl

Parameters:

token - token a valid SSOToken

dn - DN of the object whose type is to be known.

Returns:

Integer type of the entry.

Throws:

AMException - if the data store is unavailable or if the objecttype is unknown

SSOException - if ssoToken is invalid or expired.

getExternalAttributes

public Map getExternalAttributes(SSOToken token,
                                 String entryDN,
                                 Set attrNames,
                                 int profileType)
                          throws AMException

Returns attributes from an external data store.

Specified by:

getExternalAttributes in interface IDirectoryServices

Overrides:

getExternalAttributes in class RemoteServicesImpl

Parameters:

token - Single sign on token of user

entryDN - DN of the entry user is trying to read

attrNames - Set of attributes to be read

profileType - Integer determining the type of profile being read

Returns:

A Map of attribute-value pairs

Throws:

AMException - if an error occurs when trying to read external datastore

getAttributes

public Map getAttributes(SSOToken token,
                         String entryDN,
                         int profileType)
                  throws AMException,
                         SSOException

Description copied from interface: IDirectoryServices

Returns a Map with attribute-values requested from the directory.

Specified by:

getAttributes in interface IDirectoryServices

Overrides:

getAttributes in class RemoteServicesImpl

Parameters:

token - User's single sign on token

entryDN - DN of the entry.

profileType - Integer representing type of the object.

Returns:

Map of attribute-values.

Throws:

AMException - If unable to access datastore

SSOException - If user's single sign on token is invalid.

getAttributes

public Map getAttributes(SSOToken token,
                         String entryDN,
                         Set attrNames,
                         int profileType)
                  throws AMException,
                         SSOException

Description copied from interface: IDirectoryServices

Returns a Map with attribute-values requested from the directory.

Specified by:

getAttributes in interface IDirectoryServices

Overrides:

getAttributes in class RemoteServicesImpl

Parameters:

token - User's single sign on token

entryDN - DN of the entry.

attrNames - Set of attributes to be read.

profileType - Integer representing type of the object.

Returns:

Map of attribute-values.

Throws:

AMException - If unable to access datastore

SSOException - If user's single sign on token is invalid.

getAttributesByteValues

public Map getAttributesByteValues(SSOToken token,
                                   String entryDN,
                                   int profileType)
                            throws AMException,
                                   SSOException

Description copied from interface: IDirectoryServices

Returns a map of attribute-values for binary attributes.

Specified by:

getAttributesByteValues in interface IDirectoryServices

Overrides:

getAttributesByteValues in class RemoteServicesImpl

Parameters:

token - User's single sign on token

entryDN - DN of the entry.

profileType - Integer representing type of the object.

Returns:

Map of attribute-values.

Throws:

AMException - If unable to access datastore

SSOException - If user's single sign on token is invalid.

getAttributesByteValues

public Map getAttributesByteValues(SSOToken token,
                                   String entryDN,
                                   Set attrNames,
                                   int profileType)
                            throws AMException,
                                   SSOException

Description copied from interface: IDirectoryServices

Returns a map of attribute-values for binary attributes.

Specified by:

getAttributesByteValues in interface IDirectoryServices

Overrides:

getAttributesByteValues in class RemoteServicesImpl

Parameters:

token - User's single sign on token

entryDN - DN of the entry.

attrNames - Names of the attributes to be read.

profileType - Integer representing type of the object.

Returns:

Map of attribute-values.

Throws:

AMException - If unable to access datastore

SSOException - If user's single sign on token is invalid.

getAttributes

public Map getAttributes(SSOToken token,
                         String entryDN,
                         boolean ignoreCompliance,
                         boolean byteValues,
                         int profileType)
                  throws AMException,
                         SSOException

Gets all attributes corresponding to the entryDN. This method obtains the DC Tree node attributes and also performs compliance related verification checks in compliance mode. Note: In compliance mode you can skip the compliance checks by setting ignoreCompliance to "false".

Specified by:

getAttributes in interface IDirectoryServices

Overrides:

getAttributes in class RemoteServicesImpl

Parameters:

token - a valid SSOToken

entryDN - the DN of the entry whose attributes need to retrieved

ignoreCompliance - a boolean value specificying if compliance related entries need to ignored or not. Ignored if true.

byteValues - if false StringValues are fetched, if true byte values are fetched.

profileType - the oject type of entryDN

Returns:

a Map containing attribute names as keys and Set of values corresponding to each key.

Throws:

AMException - if an error is encountered in fetching the attributes

SSOException - If user's single sign on token is invalid.

getAttributes

public Map getAttributes(SSOToken token,
                         String entryDN,
                         Set attrNames,
                         boolean ignoreCompliance,
                         boolean byteValues,
                         int profileType)
                  throws AMException,
                         SSOException

Gets the specific attributes corresponding to the entryDN. This method obtains the DC Tree node attributes and also performs compliance related verification checks in compliance mode. Note: In compliance mode you can skip the compliance checks by setting ignoreCompliance to "false".

Specified by:

getAttributes in interface IDirectoryServices

Overrides:

getAttributes in class RemoteServicesImpl

Parameters:

token - a valid SSOToken

entryDN - the DN of the entry whose attributes need to retrieved

attrNames - a Set of names of the attributes that need to be retrieved. The attrNames should not be null

ignoreCompliance - a boolean value specificying if compliance related entries need to ignored or not. Ignored if true.

byteValues - Return binary attributes, if true.

profileType - Integer representing type of the object.

Returns:

a Map containing attribute names as keys and Set of values corresponding to each key.

Throws:

AMException - if an error is encountered in fetching the attributes

SSOException - If user's single sign on token is invalid.

renameEntry

public String renameEntry(SSOToken token,
                          int objectType,
                          String entryDN,
                          String newName,
                          boolean deleteOldName)
                   throws AMException

Renames an entry. Currently used for only user renaming.

Specified by:

renameEntry in interface IDirectoryServices

Overrides:

renameEntry in class RemoteServicesImpl

Parameters:

token - the sso token

objectType - the type of entry

entryDN - the entry DN

newName - the new name (i.e., if RDN is cn=John, the value passed should be "John"

deleteOldName - if true the old name is deleted otherwise it is retained.

Returns:

new DN of the renamed entry

Throws:

AMException - if the operation was not successful

setAttributes

public void setAttributes(SSOToken token,
                          String entryDN,
                          int objectType,
                          Map stringAttributes,
                          Map byteAttributes,
                          boolean isAdd)
                   throws AMException,
                          SSOException

Method Set the attributes of an entry.

Specified by:

setAttributes in interface IDirectoryServices

Overrides:

setAttributes in class RemoteServicesImpl

Parameters:

token - SSOToken

entryDN - DN of the profile whose template is to be set

objectType - profile type

stringAttributes - a AMHashMap of attributes to be set

byteAttributes - a AMHashMap of attributes to be set

isAdd - true add to existing value; otherwise replace the existing value

Throws:

AMException

SSOException

removeEntry

public void removeEntry(SSOToken token,
                        String entryDN,
                        int objectType,
                        boolean recursive,
                        boolean softDelete)
                 throws AMException,
                        SSOException

Remove an entry from the directory.

Specified by:

removeEntry in interface IDirectoryServices

Overrides:

removeEntry in class RemoteServicesImpl

Parameters:

token - SSOToken

entryDN - dn of the profile to be removed

objectType - profile type

recursive - if true, remove all sub entries & the object

softDelete - Used to let pre/post callback plugins know that this delete is either a soft delete (marked for deletion) or a purge/hard delete itself, otherwise, remove the object only

Throws:

AMException

SSOException

createAMTemplate

public String createAMTemplate(SSOToken token,
                               String entryDN,
                               int objectType,
                               String serviceName,
                               Map attributes,
                               int priority)
                        throws AMException

Create an AMTemplate (COSTemplate)

Specified by:

createAMTemplate in interface IDirectoryServices

Overrides:

createAMTemplate in class RemoteServicesImpl

Parameters:

token - token

entryDN - DN of the profile whose template is to be set

objectType - the object type

serviceName - Service Name

attributes - attributes to be set

priority - template priority

Returns:

String DN of the newly created template

Throws:

AMException

setGroupFilter

public void setGroupFilter(SSOToken token,
                           String entryDN,
                           String filter)
                    throws AMException,
                           SSOException

Description copied from class: RemoteServicesImpl

Sets the filter for a dynamic group in the datastore.

Specified by:

setGroupFilter in interface IDirectoryServices

Overrides:

setGroupFilter in class RemoteServicesImpl

Parameters:

token - Single sign on token

entryDN - DN of group entry

filter - Search filter

Throws:

AMException - If there is a datastore exception.

SSOException - If user's single sign on token is invalid.