netscape.ldap.beans

Class LDAPGetProperty

Implemented Interfaces:
Serializable

public class LDAPGetProperty
extends LDAPBasePropertySupport
implements Serializable

Invisible Bean that just takes a name and password, host and port, and directory base and attribute name, and returns an attribute's values from a Directory Server. The values are assumed to be strings, and are returned as an array. The search has the scope "SUB", which means that it will find an entry anywhere at or below the directory base.

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

A null result means the property fetch failed. 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

LDAPGetProperty()
Constructor with no parameters
LDAPGetProperty(String theHost, int thePort, String theBase)
Constructor with host, port, and base initializers

Method Summary

String
getAttribute()
Returns the name of the attribute to retrieve
String[]
getProperty()
Searches and returns values of a previously registered property, using previously set parameters
void
getProperty(ActionEvent x)
String[]
getProperty(String host, int port, String base, String filter, String attribute)
Searches and returns values for a specified attribute
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
setDNs(PropertyChangeEvent evt)

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

LDAPGetProperty

public LDAPGetProperty()
Constructor with no parameters

LDAPGetProperty

public LDAPGetProperty(String theHost,
                       int thePort,
                       String theBase)
Constructor with host, port, and base initializers
Parameters:
theHost - host string
thePort - port number
theBase - directory base string

Method Details

getAttribute

public String getAttribute()
Returns the name of the attribute to retrieve
Returns:
attribute name to retrieve

getProperty

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

getProperty

public void getProperty(ActionEvent x)

getProperty

public String[] getProperty(String host,
                            int port,
                            String base,
                            String filter,
                            String attribute)
Searches and returns values for a specified attribute
Parameters:
host - host string
port - port number
base - directory base string
filter - search filter
attribute - name of property to return values for
Returns:
Array of values for the property

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

setDNs

public void setDNs(PropertyChangeEvent evt)