Package com.sun.identity.sm

Class CachedSubEntries

java.lang.Object

com.sun.identity.sm.CachedSubEntries

All Implemented Interfaces:

SMSEventListener

public class CachedSubEntries
extends Object
implements SMSEventListener

Field Summary

Fields

Modifier and Type	Field	Description
protected CachedSMSEntry	cachedEntry
protected static Map<String,CachedSubEntries>	smsEntries
protected Map<String,Set>	ssoTokenToSubEntries

Method Summary

Modifier and Type	Method	Description
protected void	add(String entry)
protected boolean	contains(SSOToken t, String entry)
protected void	finalize()
static CachedSubEntries	getInstance(SSOToken token, String dn)
static CachedSubEntries	getInstanceIfCached(SSOToken token, String dn, boolean cached)
Set	getSchemaSubEntries(SSOToken token, String pattern, String serviceidPattern)	Returns sub-entries that belong to given SubSchema name and statisfies the pattern.
protected SMSEntry	getSMSEntry()
protected Set	getSubEntries(SSOToken t)	Returns one-level sub-entries for the given DN.
Set<String>	getSubEntries(SSOToken token, String pattern)	Return sub-entries that match the pattern.
protected boolean	isEmpty(SSOToken t)
void	notifySMSEvent(org.forgerock.opendj.ldap.DN dn, int event)	Called when an SMS event occurs to the requested object.
protected void	remove(String entry)
Set	searchOrgNames(SSOToken token, String serviceName, String attrName, Set values)	Returns realm names that match the attribute-values pair for the given service name.
Set	searchSubOrgNames(SSOToken token, String pattern, boolean recursive)	Returns realm names that matches the given pattern.
protected void	update()

Methods inherited from class java.lang.Object

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

Field Detail

smsEntries

protected static Map<String,CachedSubEntries> smsEntries

ssoTokenToSubEntries

protected Map<String,Set> ssoTokenToSubEntries

cachedEntry

protected CachedSMSEntry cachedEntry

Method Detail

getSubEntries

protected Set getSubEntries(SSOToken t)
                     throws SMSException,
                            SSOException

Returns one-level sub-entries for the given DN. Results are cached.

Parameters:

t - SSOToken to used for searching

Returns:

sub entries for the given DN

Throws:

SMSException - if an error occurs accessing the data store.

SSOException - if the single sign-on token is invalid.

getSubEntries

public Set<String> getSubEntries(SSOToken token,
                                 String pattern)
                          throws SMSException,
                                 SSOException

Return sub-entries that match the pattern. Performs data store operation, the results are not cached

Parameters:

token - the SSOToken used for searching

pattern - the search pattern to match sub-entries against

Returns:

subentries that match the pattern

Throws:

SMSException - if an error occurs accessing the data store.

SSOException - if the single sign-on token is invalid.

getSchemaSubEntries

public Set getSchemaSubEntries(SSOToken token,
                               String pattern,
                               String serviceidPattern)
                        throws SMSException,
                               SSOException

Returns sub-entries that belong to given SubSchema name and statisfies the pattern. The results are not cached.

Parameters:

token - the SSOToken used for searching

pattern - the search pattern to match sub-entries against

serviceidPattern - sub-schema name

Returns:

subentries that belong to given SubSchema name and satisfies the pattern

Throws:

SMSException - if an error occurs accessing the data store.

SSOException - if the single sign-on token is invalid.

add

protected void add(String entry)

remove

protected void remove(String entry)

isEmpty

protected boolean isEmpty(SSOToken t)
                   throws SMSException,
                          SSOException

Throws:

SMSException

SSOException

contains

protected boolean contains(SSOToken t,
                           String entry)
                    throws SMSException,
                           SSOException

Throws:

SMSException

SSOException

getSMSEntry

protected SMSEntry getSMSEntry()

update

protected void update()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

searchSubOrgNames

public Set searchSubOrgNames(SSOToken token,
                             String pattern,
                             boolean recursive)
                      throws SMSException,
                             SSOException

Returns realm names that matches the given pattern. If recursive is set to true, a sub-tree search is performed. The results are not cached.

Parameters:

token - the SSOToken used for searching

pattern - the search pattern to match realm names against

recursive - if true a sub-tree search is performed

Returns:

realm names that matches the given pattern

Throws:

SMSException - if an error occurs accessing the data store.

SSOException - if the single sign-on token is invalid.

searchOrgNames

public Set searchOrgNames(SSOToken token,
                          String serviceName,
                          String attrName,
                          Set values)
                   throws SMSException,
                          SSOException

Returns realm names that match the attribute-values pair for the given service name. The attribute-values pairs is based on organization attribute schema. A sub-tree search is performed. The results are not cached.

Parameters:

token - the SSOToken used for searching

serviceName - the service name whose attribute schema is used

attrName - the attribute name to match

values - the attribute values to match

Returns:

realm names that match the attributevalues pair for the given service name

Throws:

SMSException - if an error occurs accessing the data store.

SSOException - if the single sign-on token is invalid.

getInstanceIfCached

public static CachedSubEntries getInstanceIfCached(SSOToken token,
                                                   String dn,
                                                   boolean cached)
                                            throws SMSException

Throws:

SMSException

getInstance

public static CachedSubEntries getInstance(SSOToken token,
                                           String dn)
                                    throws SMSException

Throws:

SMSException

notifySMSEvent

public void notifySMSEvent(org.forgerock.opendj.ldap.DN dn,
                           int event)

Description copied from interface: SMSEventListener

Called when an SMS event occurs to the requested object.

Specified by:

notifySMSEvent in interface SMSEventListener

Parameters:

dn - The DN of the object that the event has occurred for.

event - The event that has occurred.