Class LDAPIsMember

java.lang.Object

netscape.ldap.beans.LDAPBasePropertySupport

netscape.ldap.beans.LDAPIsMember

All Implemented Interfaces:

Serializable

public class LDAPIsMember
extends LDAPBasePropertySupport
implements Serializable

Invisible Bean that just takes a host and port, optional authentication name and password, and DN of a group and another DN which might be a member of the group, and returns true or false, depending on whether the second DN is a member of the first.
Also handles the case of dynamic groups by derefencing the URL and searching for membership based on the url search.
It doesn't handle nested groups.

A false result means the member could not be identified as belonging to the group. The exact reason is available through getErrorCode(), which returns one of the following:

     OK
     INVALID_PARAMETER
     CONNECT_ERROR
     AUTHENTICATION_ERROR
     PROPERTY_NOT_FOUND
     AMBIGUOUS_RESULTS
     NO_SUCH_OBJECT

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AMBIGUOUS_RESULTS
static final int	AUTHENTICATION_ERROR
static final int	CONNECT_ERROR
static final int	INVALID_PARAMETER
static final int	NO_SUCH_OBJECT
static final int	OK
static final int	PROPERTY_NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
LDAPIsMember()	Constructor with no parameters
LDAPIsMember(String host, int port, String group)	Constructor with host, port, and group DN initializers
LDAPIsMember(String host, int port, String dn, String password, String theGroup)	Constructor with host, port, authentication DN and password and group DN initializers

Method Summary

Modifier and Type	Method	Description
String	getGroup()	Returns the distinguished name of the group
String	getMember()	Returns the distinguished name of the member
boolean	isMember()	Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)
void	isMember(ActionEvent e)	Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)
boolean	isMember(String host, int port, String dn, String password, String group, String member)	Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)
static void	main(String[] args)	The main body if we run it as application instead of applet.
void	setGroup(String group)	Sets the distinguished name of the group
void	setMember(String member)	Sets the distinguished name of the member

Methods inherited from class LDAPBasePropertySupport

addPropertyChangeListener, connect, convertToString, firePropertyChange, getAuthDN, getAuthPassword, getBase, getDebug, getErrorCode, getFilter, getHost, getPort, getScope, getUserID, getUserName, printDebug, removePropertyChangeListener, setAuthDN, setAuthPassword, setBase, setDebug, setDefaultReferralCredentials, setErrorCode, setFilter, setHost, setPort, setScope, setUserID, setUserName

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Add a client to be notified when an authentication result is in
protected void	connect(LDAPConnection conn, String host, int port)	Sets up basic connection privileges for Communicator if necessary, and connects
String	convertToString(String[] aResult)	Utility method to convert an array of Strings to a single String with line feeds between elements.
void	firePropertyChange(String propName, Object oldValue, Object newValue)	Support for bound property notification
String	getAuthDN()	Returns the DN to authenticate as; null or empty for anonymous.
String	getAuthPassword()	Returns the password for the DN to authenticate as
String	getBase()	Returns the directory base to search at.
boolean	getDebug()	Returns true if debug output is on
int	getErrorCode()	Returns the latest error code
String	getFilter()	Returns the search filter
String	getHost()	Returns the host to search at.
int	getPort()	Returns the port to search at.
int	getScope()	Get the current search scope
String	getUserID()	Return the user ID.
String	getUserName()	Returns the user name
protected void	printDebug(String s)
void	removePropertyChangeListener(PropertyChangeListener listener)	Remove a client which had requested notification on authentication
void	setAuthDN(String authDN)	Sets the DN to authenticate as; null or empty for anonymous.
void	setAuthPassword(String authPassword)	Sets the password for the DN to authenticate as
void	setBase(String theBase)	Sets the starting base
void	setDebug(boolean on)	Turns debug output on or off
protected void	setDefaultReferralCredentials(LDAPConnection conn)
void	setErrorCode(int code)	Sets an error code for retrieval by a client
void	setFilter(String filter)	Sets the search filter
void	setHost(String theHost)	Sets host string.
void	setPort(int thePort)	Sets port number.
void	setScope(int scope)	Set the search scope using an integer
void	setUserID(String name)	Set the user ID.
void	setUserName(String name)	Set the user name.

Methods inherited from class Object

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

Field Details

OK

public static final int OK

See Also:

• Constant Field Values

INVALID_PARAMETER

public static final int INVALID_PARAMETER

See Also:

• Constant Field Values

CONNECT_ERROR

public static final int CONNECT_ERROR

See Also:

• Constant Field Values

AUTHENTICATION_ERROR

public static final int AUTHENTICATION_ERROR

See Also:

• Constant Field Values

PROPERTY_NOT_FOUND

public static final int PROPERTY_NOT_FOUND

See Also:

• Constant Field Values

AMBIGUOUS_RESULTS

public static final int AMBIGUOUS_RESULTS

See Also:

• Constant Field Values

NO_SUCH_OBJECT

public static final int NO_SUCH_OBJECT

See Also:

• Constant Field Values

Constructor Details

LDAPIsMember

public LDAPIsMember()

Constructor with no parameters

LDAPIsMember

public LDAPIsMember(String host,
 int port,
 String group)

Constructor with host, port, and group DN initializers

Parameters:

host - host string

port - port number

group - distinguished name of the group

LDAPIsMember

public LDAPIsMember(String host,
 int port,
 String dn,
 String password,
 String theGroup)

Constructor with host, port, authentication DN and password and group DN initializers

Parameters:

host - host string

port - port number

dn - fully qualified distinguished name to authenticate

password - password for authenticating the dn

theGroup - distinguished name of the group

Method Details

isMember

public boolean isMember()

Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)

Returns:

true if the specified member belongs to the group

isMember

public boolean isMember(String host,
 int port,
 String dn,
 String password,
 String group,
 String member)

Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)

Parameters:

host - host string

port - port number

dn - fully qualified distinguished name to authenticate; can be null or ""

password - password for authenticating the dn; can be null or ""

group - distinguished name of the group

member - distinguished name of member to be checked

Returns:

true if the specified member belongs to the group

isMember

public void isMember(ActionEvent e)

Checks if an entity (specified by distinguished name) is a member of a particular group (specified by distinguished name)

getGroup

public String getGroup()

Returns the distinguished name of the group

Returns:

group name

setGroup

public void setGroup(String group)

Sets the distinguished name of the group

Parameters:

group - group name

getMember

public String getMember()

Returns the distinguished name of the member

Returns:

member name

setMember

public void setMember(String member)

Sets the distinguished name of the member

Parameters:

member - member name

main

public static void main(String[] args)

The main body if we run it as application instead of applet.

Parameters:

args - list of arguments