This is a base class that is extended by various specialized LDAP
Beans. It provides the common properties and accessors used by
them.
AMBIGUOUS_RESULTS
public static final int AMBIGUOUS_RESULTS
AUTHENTICATION_ERROR
public static final int AUTHENTICATION_ERROR
CONNECT_ERROR
public static final int CONNECT_ERROR
INVALID_PARAMETER
public static final int INVALID_PARAMETER
NO_SUCH_OBJECT
public static final int NO_SUCH_OBJECT
OK
public static final int OK
PROPERTY_NOT_FOUND
public static final int PROPERTY_NOT_FOUND
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
Add a client to be notified when an authentication result is in
listener
- a client to be notified of changes
connect
protected void connect(LDAPConnection conn,
String host,
int port)
throws LDAPException
Sets up basic connection privileges for Communicator if necessary,
and connects
host
- Host to connect to.port
- Port number.
convertToString
public String convertToString(String[] aResult)
Utility method to convert an array of Strings to a single String
with line feeds between elements.
aResult
- The array of Strings to convert
- A String with the elements separated by line feeds
firePropertyChange
public void firePropertyChange(String propName,
Object oldValue,
Object newValue)
Support for bound property notification
propName
- Name of changed propertyoldValue
- Previous value of propertynewValue
- New value of property
getAuthDN
public String getAuthDN()
Returns the DN to authenticate as; null or empty for anonymous.
getAuthPassword
public String getAuthPassword()
Returns the password for the DN to authenticate as
- Password of DN to authenticate as
getBase
public String getBase()
Returns the directory base to search at.
getDebug
public boolean getDebug()
Returns true if debug output is on
- true if debug output is on
getErrorCode
public int getErrorCode()
Returns the latest error code
getFilter
public String getFilter()
Returns the search filter
getHost
public String getHost()
Returns the host to search at.
- DNS name or dotted IP name of host to search at
getPort
public int getPort()
Returns the port to search at.
getScope
public int getScope()
Get the current search scope
- the current search scope as integer
getUserID
public String getUserID()
Return the user ID.
getUserName
public String getUserName()
Returns the user name
printDebug
protected void printDebug(String s)
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a client which had requested notification on authentication
listener
- a client to not be notified of changes
setAuthDN
public void setAuthDN(String authDN)
Sets the DN to authenticate as; null or empty for anonymous.
authDN
- the DN to authenticate as
setAuthPassword
public void setAuthPassword(String authPassword)
Sets the password for the DN to authenticate as
authPassword
- the password to use in authentication
setBase
public void setBase(String theBase)
Sets the starting base
setDebug
public void setDebug(boolean on)
Turns debug output on or off
on
- true for debug output
setDefaultReferralCredentials
protected void setDefaultReferralCredentials(LDAPConnection conn)
setErrorCode
public void setErrorCode(int code)
Sets an error code for retrieval by a client
setFilter
public void setFilter(String filter)
Sets the search filter
setHost
public void setHost(String theHost)
Sets host string.
setPort
public void setPort(int thePort)
Sets port number.
setScope
public void setScope(int scope)
Set the search scope using an integer
scope
- one of LDAPConnection.SCOPE_BASE,
LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE
setUserID
public void setUserID(String name)
Set the user ID.
name
- the value of the user id
setUserName
public void setUserName(String name)
Set the user name. The name should be of the form "Polly Plum".