oracle.ldap.util
Class LDAPEntry

java.lang.Object
  |
  +--oracle.ldap.util.LDAPEntry

Direct Known Subclasses:

LDAPGroup, Subscriber, User

public abstract class LDAPEntry

extends java.lang.Object

This abstract class represents an LDAP entry. It is subclassed by many of the objects in the oracle.ldap.util package - for example, User and Subscriber classes.

The class provides some general LDAP search and modify methods to be performed on an LDAP entry.

Method Summary

java.lang.String	getDN(javax.naming.directory.DirContext ctx) Returns the DN of the entry (resolves the DN if necessary).
PropertySetCollection	getProperties(javax.naming.directory.DirContext ctx, java.lang.String[] attrList, boolean usecache) Retrieves selected attributes associated with this entry.
abstract void	resolve(javax.naming.directory.DirContext ctx) Abstract method - implements validation of the LDAP entry by resolving the DN.
void	setProperties(javax.naming.directory.DirContext ctx, ModPropertySet ps) Sets or modifies the properties of this entry.

Methods inherited from class java.lang.Object

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

Method Detail

getProperties

public PropertySetCollection getProperties(javax.naming.directory.DirContext ctx,
                                           java.lang.String[] attrList,
                                           boolean usecache)
                                    throws UtilException

Retrieves selected attributes associated with this entry.

A cache is used where previous getProperties() results are stored. If a new search is desired, usecache should be set to false. A new LDAP search will be done and the cache will be refreshed with these new values.

Parameters:

ctx - a valid DirContext

attrList - an array of attributes to be retrieved

usecache - boolean value to determine ifthe va

Throws:

UtilException

setProperties

public void setProperties(javax.naming.directory.DirContext ctx,
ModPropertySet ps)
                   throws UtilException

Sets or modifies the properties of this entry.

A ModPropertySet object must be created first. PropertySet for the modification.

Parameters:

ctx - a valid DirContext

ps - a valid PropertySet containing the items to be modified

Throws:

UtilException

getDN

public java.lang.String getDN(javax.naming.directory.DirContext ctx)
                       throws UtilException

Returns the DN of the entry (resolves the DN if necessary).

Parameters:

ctx - a valid DirContext

Throws:

UtilException

resolve

public abstract void resolve(javax.naming.directory.DirContext ctx)
                      throws UtilException

Abstract method - implements validation of the LDAP entry by resolving the DN.

Throws:

UtilException