Package com.sun.identity.sm.ldap

Class SMSLdapObject

java.lang.Object

com.sun.identity.sm.SMSObject

com.sun.identity.sm.SMSObjectDB

com.sun.identity.sm.ldap.SMSLdapObject

All Implemented Interfaces:

SMSObjectListener, EventListener

public class SMSLdapObject
extends SMSObjectDB
implements SMSObjectListener

This object represents an LDAP entry in the directory server. The UMS have an equivalent class called PersistentObject. The SMS could not integrate with PersistentObject, because of the its dependecy on the Session object. This would mean that, to instantiate an PersistentObject inside SMS, we need to create an UMS instance, which would be having directory parameters of SMS.

This class is used both to read and write information into the directory server. The appropriate constructors discusses it is done.

There can be only three types of SMS entries in the directory (i) entry with organizationUnit object class (attribute: ou) (ii) entry with sunService object class (attributes: ou, labeledURI, sunServiceSchema, sunPluginSchema, and sunKeyValue (sunXMLKeyValue, in the future) (iii) entry with sunServiceComponent object class (attributes: ou, sunServiceID, sunSMSPriority, sunKeyValue. All the schema, configuration and plugin entries will be stored using the above entries.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ORG_CANNOT_OBTAIN
static String	SUBORG_CANNOT_OBTAIN

Fields inherited from interface com.sun.identity.sm.SMSObjectListener

ADD, DELETE, MODIFY

Constructor Summary

Constructors

Constructor	Description
SMSLdapObject()	Public constructor for SMSLdapObject

Method Summary

Modifier and Type	Method	Description
void	allObjectsChanged()	This callback notifies the listener that all object should be marked as "changed" or "dirty".
void	create(SSOToken token, String dn, Map attrs)	Create an entry in the directory
void	delete(SSOToken token, String dn)	Delete the entry in the directory.
void	deregisterCallbackHandler(String id)	De-Registration of Notification Callbacks
boolean	entryExists(SSOToken token, String dn)	Checks if the provided DN exists.
void	modify(SSOToken token, String dn, ModificationItem[] mods)	Save the entry using the token provided.
void	objectChanged(String dn, int type)	This callback method is called by the EventService when the Directory Server triggers a PersistentSearch notification
Map<String,Set<String>>	read(SSOToken token, String dn)	Reads in the object from persistent store, assuming that the guid and the SSOToken are valid
void	registerCallbackHandler(SMSObjectListener changeListener)	Registration of Notification Callbacks
Set<String>	schemaSubEntries(SSOToken token, String dn, String filter, String sidFilter, int numOfEntries, boolean sortResults, boolean ascendingOrder)	Returns the sub-entry names.
Set<String>	search(SSOToken token, String startDN, String filter, int numOfEntries, int timeLimit, boolean sortResults, boolean ascendingOrder)	Returns LDAP entries that match the filter, using the start DN provided in method
Iterator<SMSDataEntry>	search(SSOToken token, String startDN, String filter, int numOfEntries, int timeLimit, boolean sortResults, boolean ascendingOrder, Set<String> excludes)	Returns LDAP entries that match the filter, using the start DN provided in method
Set<String>	searchOrganizationNames(SSOToken token, String dn, int numOfEntries, boolean sortResults, boolean ascendingOrder, String serviceName, String attrName, Set values)	Returns the organization names.
Set<String>	searchSubOrgNames(SSOToken token, String dn, String filter, int numOfEntries, boolean sortResults, boolean ascendingOrder, boolean recursive)	Returns the suborganization names.
void	shutdown()
Set<String>	subEntries(SSOToken token, String dn, String filter, int numOfEntries, boolean sortResults, boolean ascendingOrder)	Returns the sub-entry names.
String	toString()

Methods inherited from class com.sun.identity.sm.SMSObjectDB

getAMSdkBaseDN, getRootSuffix

Methods inherited from class com.sun.identity.sm.SMSObject

cacheResults, debug, getAttributeNames, getNamingAttribute, getOrgNamingAttribute, getSearchFilter, getServiceIdSearchFilter, initialize

Methods inherited from class java.lang.Object

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

Field Detail

ORG_CANNOT_OBTAIN

public static final String ORG_CANNOT_OBTAIN

See Also:

Constant Field Values

SUBORG_CANNOT_OBTAIN

public static final String SUBORG_CANNOT_OBTAIN

See Also:

Constant Field Values

Constructor Detail

SMSLdapObject

public SMSLdapObject()
              throws SMSException

Public constructor for SMSLdapObject

Throws:

SMSException

Method Detail

read

public Map<String,Set<String>> read(SSOToken token,
                                          String dn)
                                   throws SMSException,
                                          SSOException

Reads in the object from persistent store, assuming that the guid and the SSOToken are valid

Specified by:

read in class SMSObject

Throws:

SMSException

SSOException

create

public void create(SSOToken token,
                   String dn,
                   Map attrs)
            throws SMSException,
                   SSOException

Create an entry in the directory

Specified by:

create in class SMSObject

Throws:

SMSException

SSOException

modify

public void modify(SSOToken token,
                   String dn,
                   ModificationItem[] mods)
            throws SMSException,
                   SSOException

Save the entry using the token provided. The principal provided will be used to get the proxy connection.

Specified by:

modify in class SMSObject

Throws:

SMSException

SSOException

delete

public void delete(SSOToken token,
                   String dn)
            throws SMSException,
                   SSOException

Delete the entry in the directory. This will delete sub-entries also!

Specified by:

delete in class SMSObject

Throws:

SMSException

SSOException

subEntries

public Set<String> subEntries(SSOToken token,
                              String dn,
                              String filter,
                              int numOfEntries,
                              boolean sortResults,
                              boolean ascendingOrder)
                       throws SMSException,
                              SSOException

Returns the sub-entry names. Returns a set of RDNs that are sub-entries. The paramter numOfEntries identifies the number of entries to return, if 0 returns all the entries.

Specified by:

subEntries in class SMSObject

Throws:

SMSException

SSOException

schemaSubEntries

public Set<String> schemaSubEntries(SSOToken token,
                                    String dn,
                                    String filter,
                                    String sidFilter,
                                    int numOfEntries,
                                    boolean sortResults,
                                    boolean ascendingOrder)
                             throws SMSException,
                                    SSOException

Returns the sub-entry names. Returns a set of RDNs that are sub-entries. The paramter numOfEntries identifies the number of entries to return, if 0 returns all the entries.

Specified by:

schemaSubEntries in class SMSObject

Throws:

SMSException

SSOException

toString

public String toString()

Overrides:

toString in class Object

search

public Iterator<SMSDataEntry> search(SSOToken token,
                                     String startDN,
                                     String filter,
                                     int numOfEntries,
                                     int timeLimit,
                                     boolean sortResults,
                                     boolean ascendingOrder,
                                     Set<String> excludes)
                              throws SSOException,
                                     SMSException

Returns LDAP entries that match the filter, using the start DN provided in method

Specified by:

search in class SMSObject

Throws:

SSOException

SMSException

search

public Set<String> search(SSOToken token,
                          String startDN,
                          String filter,
                          int numOfEntries,
                          int timeLimit,
                          boolean sortResults,
                          boolean ascendingOrder)
                   throws SSOException,
                          SMSException

Returns LDAP entries that match the filter, using the start DN provided in method

Specified by:

search in class SMSObject

Throws:

SSOException

SMSException

entryExists

public boolean entryExists(SSOToken token,
                           String dn)

Checks if the provided DN exists. Used by PolicyManager.

Specified by:

entryExists in class SMSObject

Parameters:

token - Admin token.

dn - The DN to check.

Returns:

true if the entry exists, false otherwise.

registerCallbackHandler

public void registerCallbackHandler(SMSObjectListener changeListener)
                             throws SMSException

Registration of Notification Callbacks

Overrides:

registerCallbackHandler in class SMSObject

Throws:

SMSException

deregisterCallbackHandler

public void deregisterCallbackHandler(String id)

Description copied from class: SMSObject

De-Registration of Notification Callbacks

Overrides:

deregisterCallbackHandler in class SMSObject

objectChanged

public void objectChanged(String dn,
                          int type)

Description copied from interface: SMSObjectListener

This callback method is called by the EventService when the Directory Server triggers a PersistentSearch notification

Specified by:

objectChanged in interface SMSObjectListener

allObjectsChanged

public void allObjectsChanged()

Description copied from interface: SMSObjectListener

This callback notifies the listener that all object should be marked as "changed" or "dirty". This callback is only used in the case when Event Service looses the directory connection and does not know what could have changed in the directory.

Specified by:

allObjectsChanged in interface SMSObjectListener

searchSubOrgNames

public Set<String> searchSubOrgNames(SSOToken token,
                                     String dn,
                                     String filter,
                                     int numOfEntries,
                                     boolean sortResults,
                                     boolean ascendingOrder,
                                     boolean recursive)
                              throws SMSException,
                                     SSOException

Returns the suborganization names. Returns a set of RDNs that are suborganization name. The paramter numOfEntries identifies the number of entries to return, if 0 returns all the entries.

Specified by:

searchSubOrgNames in class SMSObject

Throws:

SMSException

SSOException

searchOrganizationNames

public Set<String> searchOrganizationNames(SSOToken token,
                                           String dn,
                                           int numOfEntries,
                                           boolean sortResults,
                                           boolean ascendingOrder,
                                           String serviceName,
                                           String attrName,
                                           Set values)
                                    throws SMSException,
                                           SSOException

Returns the organization names. Returns a set of RDNs that are organization name. The paramter numOfEntries identifies the number of entries to return, if 0 returns all the entries.

Specified by:

searchOrganizationNames in class SMSObject

Throws:

SMSException

SSOException

shutdown

public void shutdown()

Overrides:

shutdown in class SMSObject