com.sun.identity.idm.remote

Class IdRemoteCachedServicesImpl

java.lang.Object

com.sun.identity.idm.remote.IdRemoteServicesImpl

com.sun.identity.idm.remote.IdRemoteCachedServicesImpl

All Implemented Interfaces:

IdCachedServices, IdServices

public class IdRemoteCachedServicesImpl
extends IdRemoteServicesImpl
implements IdCachedServices

Class which provides caching on top of available IdRepoLDAPServices.

Field Summary

Fields inherited from class com.sun.identity.idm.remote.IdRemoteServicesImpl

AMSR_ATTRS, AMSR_CODE, AMSR_RESULTS, DEBUG, 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).
void	delete(SSOToken token, IdType type, String name, String orgName, String amsdkDN)
void	dirtyCache(String dn, int eventType, boolean cosType, boolean aciChange, Set attrNames) This method will be called by AMIdRepoListener.
Map	getAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN, boolean isStringValues)
Map	getAttributes(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)
Set	getFullyQualifiedNames(SSOToken token, IdType type, String name, String orgName)
protected static IdServices	getInstance()
int	getSize() Method to get the current cache size
boolean	isExists(SSOToken token, IdType type, String name, String amOrgName)
void	removeAttributes(SSOToken token, IdType type, String name, Set attrNames, String orgName, String amsdkDN)
IdSearchResults	search(SSOToken token, IdType type, IdSearchControl ctrl, String orgName, CrestQuery crestQuery) By passing in a CrestQuery object, we now support searching by id (via _queryId) or by filter (_queryFilter).
void	setActiveStatus(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN, boolean active)
void	setAttributes(SSOToken token, IdType type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN, boolean isString)
String	toString()

Methods inherited from class com.sun.identity.idm.remote.IdRemoteServicesImpl

assignService, authenticate, authenticate, changePassword, clearIdRepoPlugins, clearIdRepoPlugins, create, getAssignedServices, getBinaryServiceAttributes, getMembers, getMemberships, getServiceAttributes, getServiceAttributesAscending, getSpecialIdentities, getSupportedOperations, getSupportedTypes, isActive, modifyMemberShip, modifyService, processException, reinitialize, reloadIdRepoServiceSchema, unassignService

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.idm.IdServices

assignService, authenticate, authenticate, changePassword, clearIdRepoPlugins, clearIdRepoPlugins, create, getAssignedServices, getBinaryServiceAttributes, getMembers, getMemberships, getServiceAttributes, getServiceAttributesAscending, getSpecialIdentities, getSupportedOperations, getSupportedTypes, isActive, modifyMemberShip, modifyService, reinitialize, reloadIdRepoServiceSchema, unassignService

Method Detail

getSize

public int getSize()

Method to get the current cache size

Specified by:

getSize in interface IdCachedServices

Returns:

the size of the SDK LRU cache

getInstance

protected static IdServices getInstance()

toString

public String toString()

Overrides:

toString in class Object

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 IdCachedServices

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 IdCachedServices

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

isExists

public boolean isExists(SSOToken token,
                        IdType type,
                        String name,
                        String amOrgName)
                 throws SSOException,
                        IdRepoException

Specified by:

isExists in interface IdServices

Overrides:

isExists in class IdRemoteServicesImpl

Throws:

SSOException

IdRepoException

getAttributes

public Map getAttributes(SSOToken token,
                         IdType type,
                         String name,
                         Set attrNames,
                         String amOrgName,
                         String amsdkDN,
                         boolean isStringValues)
                  throws IdRepoException,
                         SSOException

Specified by:

getAttributes in interface IdServices

Overrides:

getAttributes in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException

getAttributes

public Map getAttributes(SSOToken token,
                         IdType type,
                         String name,
                         String amOrgName,
                         String amsdkDN)
                  throws IdRepoException,
                         SSOException

Specified by:

getAttributes in interface IdServices

Overrides:

getAttributes in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException

setActiveStatus

public void setActiveStatus(SSOToken token,
                            IdType type,
                            String name,
                            String amOrgName,
                            String amsdkDN,
                            boolean active)
                     throws SSOException,
                            IdRepoException

Specified by:

setActiveStatus in interface IdServices

Overrides:

setActiveStatus in class IdRemoteServicesImpl

Throws:

SSOException

IdRepoException

setAttributes

public void setAttributes(SSOToken token,
                          IdType type,
                          String name,
                          Map attributes,
                          boolean isAdd,
                          String amOrgName,
                          String amsdkDN,
                          boolean isString)
                   throws IdRepoException,
                          SSOException

Specified by:

setAttributes in interface IdServices

Overrides:

setAttributes in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException

delete

public void delete(SSOToken token,
                   IdType type,
                   String name,
                   String orgName,
                   String amsdkDN)
            throws IdRepoException,
                   SSOException

Specified by:

delete in interface IdServices

Overrides:

delete in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException

removeAttributes

public void removeAttributes(SSOToken token,
                             IdType type,
                             String name,
                             Set attrNames,
                             String orgName,
                             String amsdkDN)
                      throws IdRepoException,
                             SSOException

Specified by:

removeAttributes in interface IdServices

Overrides:

removeAttributes in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException

search

public IdSearchResults search(SSOToken token,
                              IdType type,
                              IdSearchControl ctrl,
                              String orgName,
                              CrestQuery crestQuery)
                       throws IdRepoException,
                              SSOException

Description copied from interface: IdServices

By passing in a CrestQuery object, we now support searching by id (via _queryId) or by filter (_queryFilter).

Specified by:

search in interface IdServices

Overrides:

search in class IdRemoteServicesImpl

Parameters:

token - is the sso token of the person performing this operation.

type - is the identity type of the name parameter.

ctrl - the search control

orgName - is the orgname.

crestQuery - encapsulates _queryId or _queryFilter from the CREST endpoint.

Throws:

IdRepoException - if there are repository related error conditions.

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

getFullyQualifiedNames

public Set getFullyQualifiedNames(SSOToken token,
                                  IdType type,
                                  String name,
                                  String orgName)
                           throws IdRepoException,
                                  SSOException

Specified by:

getFullyQualifiedNames in interface IdServices

Overrides:

getFullyQualifiedNames in class IdRemoteServicesImpl

Throws:

IdRepoException

SSOException