Package com.sun.identity.idm.server

Class IdCachedServicesImpl

java.lang.Object

com.sun.identity.idm.server.IdServicesImpl

com.sun.identity.idm.server.IdCachedServicesImpl

All Implemented Interfaces:

ConfigurationListener, IdCachedServices, IdServices

public class IdCachedServicesImpl
extends IdServicesImpl
implements IdCachedServices, ConfigurationListener

Field Summary

Fields inherited from class com.sun.identity.idm.server.IdServicesImpl

DEBUG, emptyUserIdentities, shutdownCalled, specialIdentities, specialIdentityNames

Method Summary

Modifier and Type	Method	Description
void	assignService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)
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).
AMIdentity	create(SSOToken token, IdType type, String name, Map attrMap, String amOrgName)
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.
Set<String>	getAssignedServices(SSOToken token, IdType type, String name, Map mapOfServiceNamesAndOCs, String amOrgName, String amsdkDN)
Map	getAttributes(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)
Map	getAttributes(SSOToken token, IdType type, String name, Set attrNames, String amOrgName, String amsdkDN, boolean isStringValues)
Set	getFullyQualifiedNames(SSOToken token, IdType type, String name, String orgName)	Returns the set of fully qualified names for the identity.
protected static IdServices	getInstance()
protected static int	getMaxSize()	Method to get the maximum size of the Cache.
Set	getMembers(SSOToken token, IdType type, String name, String amOrgName, IdType membersType, String amsdkDN)
Set	getMemberships(SSOToken token, IdType type, String name, IdType membershipType, String amOrgName, String amsdkDN)
Map	getServiceAttributes(SSOToken token, IdType type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN, boolean isString)
int	getSize()	Method to get the current cache size
boolean	isActive(SSOToken token, IdType type, String name, String amOrgName, String amsdkDN)
boolean	isExists(SSOToken token, IdType type, String name, String amOrgName)
void	modifyMemberShip(SSOToken token, IdType type, String name, Set members, IdType membersType, int operation, String amOrgName)
void	modifyService(SSOToken token, IdType type, String name, String serviceName, SchemaType stype, Map attrMap, String amOrgName, String amsdkDN)
void	notifyChanges()	This method will be call if configuration changed.
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.server.IdServicesImpl

authenticate, authenticate, changePassword, clearIdRepoPlugins, clearIdRepoPlugins, clearSpecialIdentityCache, getBinaryServiceAttributes, getServiceAttributes, getServiceAttributesAscending, getSpecialIdentities, getSupportedOperations, getSupportedTypes, isShutdownCalled, isSpecialIdentity, 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

authenticate, authenticate, changePassword, clearIdRepoPlugins, clearIdRepoPlugins, getBinaryServiceAttributes, getServiceAttributes, getServiceAttributesAscending, getSpecialIdentities, getSupportedOperations, getSupportedTypes, 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()

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()

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

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 IdServicesImpl

Throws:

IdRepoException

SSOException

getMembers

public Set getMembers(SSOToken token,
                      IdType type,
                      String name,
                      String amOrgName,
                      IdType membersType,
                      String amsdkDN)
               throws IdRepoException,
                      SSOException

Specified by:

getMembers in interface IdServices

Overrides:

getMembers in class IdServicesImpl

Throws:

IdRepoException

SSOException

getMemberships

public Set getMemberships(SSOToken token,
                          IdType type,
                          String name,
                          IdType membershipType,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

getMemberships in interface IdServices

Overrides:

getMemberships in class IdServicesImpl

Throws:

IdRepoException

SSOException

getServiceAttributes

public Map getServiceAttributes(SSOToken token,
                                IdType type,
                                String name,
                                String serviceName,
                                Set attrNames,
                                String amOrgName,
                                String amsdkDN,
                                boolean isString)
                         throws IdRepoException,
                                SSOException

Overrides:

getServiceAttributes in class IdServicesImpl

Throws:

IdRepoException

SSOException

modifyService

public void modifyService(SSOToken token,
                          IdType type,
                          String name,
                          String serviceName,
                          SchemaType stype,
                          Map attrMap,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

modifyService in interface IdServices

Overrides:

modifyService in class IdServicesImpl

Throws:

IdRepoException

SSOException

getAssignedServices

public Set<String> getAssignedServices(SSOToken token,
                                       IdType type,
                                       String name,
                                       Map mapOfServiceNamesAndOCs,
                                       String amOrgName,
                                       String amsdkDN)
                                throws IdRepoException,
                                       SSOException

Specified by:

getAssignedServices in interface IdServices

Overrides:

getAssignedServices in class IdServicesImpl

Throws:

IdRepoException

SSOException

assignService

public void assignService(SSOToken token,
                          IdType type,
                          String name,
                          String serviceName,
                          SchemaType stype,
                          Map attrMap,
                          String amOrgName,
                          String amsdkDN)
                   throws IdRepoException,
                          SSOException

Specified by:

assignService in interface IdServices

Overrides:

assignService in class IdServicesImpl

Throws:

IdRepoException

SSOException

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 IdServicesImpl

Throws:

SSOException

IdRepoException

isActive

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

Specified by:

isActive in interface IdServices

Overrides:

isActive in class IdServicesImpl

Throws:

SSOException

IdRepoException

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 IdServicesImpl

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 IdServicesImpl

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 IdServicesImpl

Throws:

IdRepoException

SSOException

modifyMemberShip

public void modifyMemberShip(SSOToken token,
                             IdType type,
                             String name,
                             Set members,
                             IdType membersType,
                             int operation,
                             String amOrgName)
                      throws IdRepoException,
                             SSOException

Specified by:

modifyMemberShip in interface IdServices

Overrides:

modifyMemberShip in class IdServicesImpl

Throws:

IdRepoException

SSOException

create

public AMIdentity create(SSOToken token,
                         IdType type,
                         String name,
                         Map attrMap,
                         String amOrgName)
                  throws IdRepoException,
                         SSOException

Specified by:

create in interface IdServices

Overrides:

create in class IdServicesImpl

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 IdServicesImpl

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 IdServicesImpl

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 IdServicesImpl

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

Description copied from class: IdServicesImpl

Returns the set of fully qualified names for the identity. The fully qualified names would be unique for a given datastore.

Specified by:

getFullyQualifiedNames in interface IdServices

Overrides:

getFullyQualifiedNames in class IdServicesImpl

Parameters:

token - SSOToken that can be used by the datastore to determine the fully qualified name

type - type of the identity

name - name of the identity

Returns:

fully qualified names for the identity

Throws:

IdRepoException - If there are repository related error conditions

SSOException - If identity's single sign on token is invalid

notifyChanges

public void notifyChanges()

Description copied from interface: ConfigurationListener

This method will be call if configuration changed.

Specified by:

notifyChanges in interface ConfigurationListener