com.sun.identity.idm.common

Class IdCacheBlock

java.lang.Object

com.iplanet.am.sdk.common.CacheBlockBase

com.sun.identity.idm.common.IdCacheBlock

public class IdCacheBlock
extends CacheBlockBase

This class represents the value part stored in the cache. Each IdCacheBlock object would represent a Directory entry. It caches the attributes corresponding to that entry. It also keeps track of red other details such as the Organization DN for the entry.

Also, this cache block can be used to serve as dummy block representing a non-existent directory entry (negative caching). This prevents making un-necessary directory calls for non-existent directory entries.

Since the attributes that can be retrieved depends on the principal performing the operation (ACI's set), the result set would vary. The attributes that are returned are the ones that are readable by the principal. Each cache block keeps account of these differences in result sets by storing all the attributes readable (and writable) on a per principal basis. This information is stored in a PrincipalAccess object. In order to avoid duplicate copy of the values, the all attribute values are not cached per principal. A single copy of the attributes is stored in the IdCacheBlock object. Also this copy of attributes stored in the cache block keeps track of non-existent directory attributes (invalid attributes). This would also prevent un-necessary directory calls for non-existent entry attributes. The attribute copy is dirtied by removing the entries which get modified.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	ENTRY_DEFAULT_EXPIRE_TIME
protected static String	ENTRY_DEFAULT_EXPIRE_TIME_KEY
protected static boolean	ENTRY_EXPIRATION_ENABLED_FLAG
protected static String	ENTRY_EXPIRATION_ENABLED_KEY
protected static long	ENTRY_USER_EXPIRE_TIME
protected static String	ENTRY_USER_EXPIRE_TIME_KEY

Constructor Summary

Constructors

Constructor and Description
IdCacheBlock(String entryDN, boolean validEntry)
IdCacheBlock(String entryDN, String orgDN, boolean validEntry)

Method Summary

Modifier and Type	Method and Description
Debug	getDebug()
long	getDefaultEntryExpirationTime()
Set	getFullyQualifiedNames()
long	getUserEntryExpirationTime()
boolean	isEntryExpirationEnabled()
void	setFullyQualifiedNames(Set fqn)

Methods inherited from class com.iplanet.am.sdk.common.CacheBlockBase

clear, getAttributes, getAttributes, getEntryDN, getObjectType, getOrganizationDN, hasCache, hasCompleteSet, hasExpiredAndUpdated, isExists, putAttributes, removeAttributes, removeAttributes, replaceAttributes, setExists, setObjectType, setOrganizationDN, toString

Methods inherited from class java.lang.Object

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

Field Detail

ENTRY_EXPIRATION_ENABLED_KEY

protected static final String ENTRY_EXPIRATION_ENABLED_KEY

See Also:

Constant Field Values

ENTRY_USER_EXPIRE_TIME_KEY

protected static final String ENTRY_USER_EXPIRE_TIME_KEY

See Also:

Constant Field Values

ENTRY_DEFAULT_EXPIRE_TIME_KEY

protected static final String ENTRY_DEFAULT_EXPIRE_TIME_KEY

See Also:

Constant Field Values

ENTRY_EXPIRATION_ENABLED_FLAG

protected static boolean ENTRY_EXPIRATION_ENABLED_FLAG

ENTRY_USER_EXPIRE_TIME

protected static long ENTRY_USER_EXPIRE_TIME

ENTRY_DEFAULT_EXPIRE_TIME

protected static long ENTRY_DEFAULT_EXPIRE_TIME

Constructor Detail

IdCacheBlock

public IdCacheBlock(String entryDN,
                    boolean validEntry)

IdCacheBlock

public IdCacheBlock(String entryDN,
                    String orgDN,
                    boolean validEntry)

Method Detail

getFullyQualifiedNames

public Set getFullyQualifiedNames()

setFullyQualifiedNames

public void setFullyQualifiedNames(Set fqn)

isEntryExpirationEnabled

public boolean isEntryExpirationEnabled()

Specified by:

isEntryExpirationEnabled in class CacheBlockBase

getUserEntryExpirationTime

public long getUserEntryExpirationTime()

Specified by:

getUserEntryExpirationTime in class CacheBlockBase

getDefaultEntryExpirationTime

public long getDefaultEntryExpirationTime()

Specified by:

getDefaultEntryExpirationTime in class CacheBlockBase

getDebug

public Debug getDebug()

Specified by:

getDebug in class CacheBlockBase