Package netscape.ldap.beans
Class LDAPBasePropertySupport
java.lang.Object
netscape.ldap.beans.LDAPBasePropertySupport
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
LDAPGetEntries
,LDAPGetProperty
,LDAPIsMember
,LDAPSimpleAuth
This is a base class that is extended by various specialized LDAP
Beans. It provides the common properties and accessors used by
them.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a client to be notified when an authentication result is inprotected void
connect
(LDAPConnection conn, String host, int port) Sets up basic connection privileges for Communicator if necessary, and connectsconvertToString
(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 notificationReturns the DN to authenticate as; null or empty for anonymous.Returns the password for the DN to authenticate asgetBase()
Returns the directory base to search at.boolean
getDebug()
Returns true if debug output is onint
Returns the latest error codeReturns the search filtergetHost()
Returns the host to search at.int
getPort()
Returns the port to search at.int
getScope()
Get the current search scopeReturn the user ID.Returns the user nameprotected void
printDebug
(String s) void
Remove a client which had requested notification on authenticationvoid
Sets the DN to authenticate as; null or empty for anonymous.void
setAuthPassword
(String authPassword) Sets the password for the DN to authenticate asvoid
Sets the starting basevoid
setDebug
(boolean on) Turns debug output on or offprotected void
void
setErrorCode
(int code) Sets an error code for retrieval by a clientvoid
Sets the search filtervoid
Sets host string.void
setPort
(int thePort) Sets port number.void
setScope
(int scope) Set the search scope using an integervoid
Set the user ID.void
setUserName
(String name) Set the user name.
-
Field Details
-
OK
public static final int OK- See Also:
-
INVALID_PARAMETER
public static final int INVALID_PARAMETER- See Also:
-
CONNECT_ERROR
public static final int CONNECT_ERROR- See Also:
-
AUTHENTICATION_ERROR
public static final int AUTHENTICATION_ERROR- See Also:
-
PROPERTY_NOT_FOUND
public static final int PROPERTY_NOT_FOUND- See Also:
-
AMBIGUOUS_RESULTS
public static final int AMBIGUOUS_RESULTS- See Also:
-
NO_SUCH_OBJECT
public static final int NO_SUCH_OBJECT- See Also:
-
-
Constructor Details
-
LDAPBasePropertySupport
public LDAPBasePropertySupport()Constructor with no parameters
-
-
Method Details
-
getHost
Returns the host to search at.- Returns:
- DNS name or dotted IP name of host to search at
-
setHost
Sets host string.- Parameters:
theHost
- host name
-
getPort
public int getPort()Returns the port to search at.- Returns:
- Port to search at
-
setPort
public void setPort(int thePort) Sets port number.- Parameters:
thePort
- port
-
getBase
Returns the directory base to search at.- Returns:
- directory base to search
-
setBase
Sets the starting base- Parameters:
theBase
- starting base
-
getAuthDN
Returns the DN to authenticate as; null or empty for anonymous.- Returns:
- DN to authenticate as
-
setAuthDN
Sets the DN to authenticate as; null or empty for anonymous.- Parameters:
authDN
- the DN to authenticate as
-
getAuthPassword
Returns the password for the DN to authenticate as- Returns:
- Password of DN to authenticate as
-
setAuthPassword
Sets the password for the DN to authenticate as- Parameters:
authPassword
- the password to use in authentication
-
getUserName
Returns the user name- Returns:
- The user name
-
setUserName
Set the user name. The name should be of the form "Polly Plum".- Parameters:
name
- The user name
-
getUserID
Return the user ID.- Returns:
- name the user id
-
setUserID
Set the user ID.- Parameters:
name
- the value of the user id
-
getScope
public int getScope()Get the current search scope- Returns:
- the current search scope as integer
-
setScope
public void setScope(int scope) Set the search scope using an integer- Parameters:
scope
- one of LDAPConnection.SCOPE_BASE, LDAPConnection.SCOPE_SUB, LDAPConnection.SCOPE_ONE
-
getFilter
Returns the search filter- Returns:
- search filter
-
setFilter
Sets the search filter- Parameters:
filter
- search filter
-
getDebug
public boolean getDebug()Returns true if debug output is on- Returns:
- true if debug output is on
-
setDebug
public void setDebug(boolean on) Turns debug output on or off- Parameters:
on
- true for debug output
-
getErrorCode
public int getErrorCode()Returns the latest error code- Returns:
- The latest error code
-
setErrorCode
public void setErrorCode(int code) Sets an error code for retrieval by a client- Parameters:
code
- An error code
-
addPropertyChangeListener
Add a client to be notified when an authentication result is in- Parameters:
listener
- a client to be notified of changes
-
removePropertyChangeListener
Remove a client which had requested notification on authentication- Parameters:
listener
- a client to not be notified of changes
-
firePropertyChange
Support for bound property notification- Parameters:
propName
- Name of changed propertyoldValue
- Previous value of propertynewValue
- New value of property
-
printDebug
-
connect
Sets up basic connection privileges for Communicator if necessary, and connects- Parameters:
host
- Host to connect to.port
- Port number.- Throws:
LDAPException
- from connect()
-
setDefaultReferralCredentials
-
convertToString
Utility method to convert an array of Strings to a single String with line feeds between elements.- Parameters:
aResult
- The array of Strings to convert- Returns:
- A String with the elements separated by line feeds
-