netscape.ldap.beans

Class LDAPGetEntries

java.lang.Object

netscape.ldap.beans.LDAPBasePropertySupport

netscape.ldap.beans.LDAPGetEntries

All Implemented Interfaces:

java.io.Serializable

public class LDAPGetEntries
extends LDAPBasePropertySupport
implements java.io.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 netscape.ldap.beans.LDAPBasePropertySupport

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

Constructor Summary

Constructors

Constructor and Description
LDAPGetEntries() Constructor with no parameters
LDAPGetEntries(java.lang.String theHost, int thePort, java.lang.String theBase) Constructor with host, port, and base initializers
LDAPGetEntries(java.lang.String theHost, int thePort, java.lang.String theBase, int theScope) Constructor with host, port, base, and scope initializers

Method Summary

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

Methods inherited from class netscape.ldap.beans.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

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPGetEntries

public LDAPGetEntries()

Constructor with no parameters

LDAPGetEntries

public LDAPGetEntries(java.lang.String theHost,
                      int thePort,
                      java.lang.String theBase)

Constructor with host, port, and base initializers

Parameters:

theHost - host string

thePort - port number

theBase - directory base string

LDAPGetEntries

public LDAPGetEntries(java.lang.String theHost,
                      int thePort,
                      java.lang.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 Detail

getAttribute

public java.lang.String getAttribute()

Returns the name of the attribute to retrieve

Returns:

attribute name to retrieve

setAttribute

public void setAttribute(java.lang.String attr)

Sets the attribute to retrieve

setResultString

public void setResultString(java.lang.String sNewValue)

getResultString

public java.lang.String getResultString()

getEntries

public java.lang.String[] getEntries(java.lang.String host,
                                     int port,
                                     java.lang.String base,
                                     int scope,
                                     java.lang.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 java.lang.String[] getEntries(java.lang.String host,
                                     int port,
                                     java.lang.String base,
                                     int scope,
                                     java.lang.String userid,
                                     java.lang.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

userName - The user name

userid - The user id

Returns:

Array of DNs

getEntries

public void getEntries(java.awt.event.ActionEvent x)

getEntries

public java.lang.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(java.lang.String[] args)

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

Parameters:

args - list of arguments