oracle.ldap.util

Class Group

java.lang.Object

oracle.ldap.util.LDAPEntry

oracle.ldap.util.LDAPGroup

oracle.ldap.util.Group

All Implemented Interfaces:

java.io.Serializable

public class Group
extends LDAPGroup

This class represents a Group object in the directory.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Group(int inGroupIdType, java.lang.String inGroupIdName) Constructs a Group using a group ID along with its type

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDn(javax.naming.directory.DirContext ctx) Returns the DN of this group.
java.lang.String	getGUID(javax.naming.directory.DirContext ctx) Returns the GUID of the entry (resolves the name if necessary).
PropertySetCollection	getProperties(javax.naming.directory.DirContext ctx, java.lang.String[] attrList) Returns the attributes specified from this group.
boolean	isDirectUniqueMember(javax.naming.directory.DirContext ctx, java.lang.String uDN)
boolean	isMember(javax.naming.directory.DirContext ctx, java.lang.String userDN, boolean nested) Check if a particular user is a member of this group
boolean	isMember(javax.naming.directory.DirContext ctx, User user, boolean nested) Checks if a particular user is a member of this group.
boolean	isNestedOwner(javax.naming.directory.DirContext ctx, java.lang.String userDN)
boolean	isOwner(javax.naming.directory.DirContext ctx, java.lang.String userDN, boolean nested)
void	resolve(javax.naming.directory.DirContext ctx) Validates the group by identifying its DN

Methods inherited from class oracle.ldap.util.LDAPGroup

addUniquemember, getAllUniquemembers, isUniquemember, removeUniquemember

Methods inherited from class oracle.ldap.util.LDAPEntry

getDN, getProperties, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group(int inGroupIdType,
             java.lang.String inGroupIdName)
      throws UtilException

Constructs a Group using a group ID along with its type

Parameters:

inGroupIdType - The type of group ID being used - either Util.IDTYPE_DN or Util.IDTYPE_GUID

inGroupIdName - the Group ID

Throws:

UtilException

Method Detail

resolve

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

Validates the group by identifying its DN

Specified by:

resolve in class LDAPEntry

Parameters:

ctx - A valid DirContext

Throws:

UtilException

isMember

public boolean isMember(javax.naming.directory.DirContext ctx,
                        User user,
                        boolean nested)
                 throws UtilException

Checks if a particular user is a member of this group. The method returns true if the user is a member of this group. Otherwise, it will return false.

Parameters:

ctx - A valid DirContext

user - A valid User object

nested - Set to true if nested memberships are allowed. Otherwise, only direct memberships are considered

Returns:

true if the given user is a member of this group; false otherwise.

Throws:

UtilException

isOwner

public boolean isOwner(javax.naming.directory.DirContext ctx,
                       java.lang.String userDN,
                       boolean nested)
                throws UtilException

Throws:

UtilException

isNestedOwner

public boolean isNestedOwner(javax.naming.directory.DirContext ctx,
                             java.lang.String userDN)
                      throws UtilException

Throws:

UtilException

isDirectUniqueMember

public boolean isDirectUniqueMember(javax.naming.directory.DirContext ctx,
                                    java.lang.String uDN)

isMember

public boolean isMember(javax.naming.directory.DirContext ctx,
                        java.lang.String userDN,
                        boolean nested)
                 throws UtilException

Check if a particular user is a member of this group

Parameters:

ctx - A valid DirContext

userDN - A valid User Distinguish Name

nested - Set to true if nested memberships are allowed. Otherwise, only direct memberships are considered

Returns:

true if the given user is a member of this group; false otherwise.

Throws:

UtilException

getDn

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

Returns the DN of this group.

Parameters:

ctx - a valid DirContext

Returns:

The DN of this group.

Throws:

UtilException

getProperties

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

Returns the attributes specified from this group. Any previously cached values in this group object from previous searches will be used If a new search is desired, use the other getProperties(DirContext, St ring, boolean)

Parameters:

ctx - a valid DirContext

attrList - an array of attributes to be returned

Throws:

UtilException

getGUID

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

Returns the GUID of the entry (resolves the name if necessary).

Parameters:

ctx - a valid DirContext

Throws:

UtilException