Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

netscape.ldap.beans

Class LDAPGetEntries

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

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

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

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(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 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

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

getEntries

public String[] getEntries()
Searches and returns values of a previously registered property, using previously set parameters
Returns:
Array of values for the property

getEntries

public void getEntries(ActionEvent x)

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

getResultString

public String getResultString()

main

public static void main(args[] )
The main body if we run it as application instead of applet.
Parameters:

setAttribute

public void setAttribute(String attr)
Sets the attribute to retrieve

setResultString

public void setResultString(String sNewValue)

Overview Package Class Use Tree Index Deprecated About