Class LDAPGetEntries

java.lang.Object

netscape.ldap.beans.LDAPBasePropertySupport

netscape.ldap.beans.LDAPGetEntries

All Implemented Interfaces:

Serializable

public class LDAPGetEntries
extends LDAPBasePropertySupport
implements Serializable

Invisible Bean that just takes a host, port, directory base, search string, and optional authentication name and password, and returns a list of all matching DNs. The search has the scope "SUB", which means that it will find an entry anywhere at or below the directory base, unless a different scope is specified.

Optionally, a client can register as a PropertyChangeListener and will be notified when the values are available.

A null result means no matching DNs were found. The reason is available through getErrorCode(), which returns one of the following:

     OK
     INVALID_PARAMETER
     CONNECT_ERROR
     AUTHENTICATION_ERROR
     PROPERTY_NOT_FOUND
     AMBIGUOUS_RESULTS

See Also:

• Serialized Form

Field Summary

Fields inherited from class LDAPBasePropertySupport

AMBIGUOUS_RESULTS, AUTHENTICATION_ERROR, CONNECT_ERROR, INVALID_PARAMETER, NO_SUCH_OBJECT, OK, PROPERTY_NOT_FOUND

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
LDAPGetEntries()	Constructor with no parameters
LDAPGetEntries(String theHost, int thePort, String theBase)	Constructor with host, port, and base initializers
LDAPGetEntries(String theHost, int thePort, String theBase, int theScope)	Constructor with host, port, base, and scope initializers

Method Summary

Modifier and Type	Method	Description
String	getAttribute()	Returns the name of the attribute to retrieve
String[]	getEntries()	Searches and returns values of a previously registered property, using previously set parameters
void	getEntries(ActionEvent x)
String[]	getEntries(String host, int port, String base, int scope, String filter)	Searches and returns values for a specified attribute
String[]	getEntries(String host, int port, String base, int scope, String userid, String userName)	Searches and returns values for a specified attribute
String	getResultString()
static void	main(String[] args)	The main body if we run it as application instead of applet.
void	setAttribute(String attr)	Sets the attribute to retrieve
void	setResultString(String sNewValue)

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

Constructor Details

LDAPGetEntries

public LDAPGetEntries()

Constructor with no parameters

LDAPGetEntries

public LDAPGetEntries(String theHost,
 int thePort,
 String theBase)

Constructor with host, port, and base initializers

Parameters:

theHost - host string

thePort - port number

theBase - directory base string

LDAPGetEntries

public LDAPGetEntries(String theHost,
 int thePort,
 String theBase,
 int theScope)

Constructor with host, port, base, and scope initializers

Parameters:

theHost - host string

thePort - port number

theBase - directory base string

theScope - one of LDAPConnection.SCOPE_BASE, LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE

Method Details

getAttribute

public String getAttribute()

Returns the name of the attribute to retrieve

Returns:

attribute name to retrieve

setAttribute

public void setAttribute(String attr)

Sets the attribute to retrieve

setResultString

public void setResultString(String sNewValue)

getResultString

public String getResultString()

getEntries

public String[] getEntries(String host,
 int port,
 String base,
 int scope,
 String filter)

Searches and returns values for a specified attribute

Parameters:

host - host string

port - port number

base - directory base string

scope - one of LDAPConnection.SCOPE_BASE, LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE

filter - search filter

Returns:

Array of values for the property

getEntries

public String[] getEntries(String host,
 int port,
 String base,
 int scope,
 String userid,
 String userName)

Searches and returns values for a specified attribute

Parameters:

host - host string

port - port number

base - directory base string

scope - one of LDAPConnection.SCOPE_BASE, LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE

userid - The user id

userName - The user name

Returns:

Array of DNs

getEntries

public void getEntries(ActionEvent x)

getEntries

public String[] getEntries()

Searches and returns values of a previously registered property, using previously set parameters

Returns:

Array of values for the property

main

public static void main(String[] args)

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

Parameters:

args - list of arguments