Class LDAPSimpleAuth

java.lang.Object

netscape.ldap.beans.LDAPBasePropertySupport

netscape.ldap.beans.LDAPSimpleAuth

All Implemented Interfaces:

Serializable

public class LDAPSimpleAuth
extends LDAPBasePropertySupport
implements Serializable

Invisible Bean that just authenticates a user with a Directory Server and returns Y or N. It takes a host and port, and then either a full distinguished name and password, an RDN and directory base, or a cn value and directory base.

Optionally, a client can register as a PropertyChangeListener and will be notified when an authentication completes.

The Bean can be used from JavaScript, as in the following example where the parameters are taken from HTML text fields in an HTML form called "input":

 
 function checkAuthentication() {
     auth = new Packages.netscape.ldap.beans.LDAPSimpleAuth();
     auth.setHost( document.input.host.value );
     auth.setPort( parseInt(document.input.port.value) );
     auth.setAuthDN( document.input.username.value );
     auth.setAuthPassword( document.input.password.value );
     result = auth.authenticate();
     alert( "The response is: " + result );
 }
 

See Also:

• Serialized Form

Field Summary

Fields inherited from class LDAPBasePropertySupport

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

Modifier and Type	Field	Description
static final int	AMBIGUOUS_RESULTS
static final int	AUTHENTICATION_ERROR
static final int	CONNECT_ERROR
static final int	INVALID_PARAMETER
static final int	NO_SUCH_OBJECT
static final int	OK
static final int	PROPERTY_NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
LDAPSimpleAuth()	Constructor with no parameters
LDAPSimpleAuth(String theHost, int thePort)	Constructor with host and port initializers
LDAPSimpleAuth(String theHost, int thePort, String dn, String password)	Constructor with all required authentication parameters

Method Summary

Modifier and Type	Method	Description
String	authenticate()	Connect to LDAP server using parameters specified in constructor and/or by setting properties and attempt to authenticate.
void	authenticate(ActionEvent x)
String	authenticate(String dn, String password)	Connect to LDAP server using parameters specified in constructor and/or by setting properties and attempt to authenticate.
static void	main(String[] args)	The main body if we run it as stand-alone application.

Methods inherited from class 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

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)	Add a client to be notified when an authentication result is in
protected void	connect(LDAPConnection conn, String host, int port)	Sets up basic connection privileges for Communicator if necessary, and connects
String	convertToString(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 notification
String	getAuthDN()	Returns the DN to authenticate as; null or empty for anonymous.
String	getAuthPassword()	Returns the password for the DN to authenticate as
String	getBase()	Returns the directory base to search at.
boolean	getDebug()	Returns true if debug output is on
int	getErrorCode()	Returns the latest error code
String	getFilter()	Returns the search filter
String	getHost()	Returns the host to search at.
int	getPort()	Returns the port to search at.
int	getScope()	Get the current search scope
String	getUserID()	Return the user ID.
String	getUserName()	Returns the user name
protected void	printDebug(String s)
void	removePropertyChangeListener(PropertyChangeListener listener)	Remove a client which had requested notification on authentication
void	setAuthDN(String authDN)	Sets the DN to authenticate as; null or empty for anonymous.
void	setAuthPassword(String authPassword)	Sets the password for the DN to authenticate as
void	setBase(String theBase)	Sets the starting base
void	setDebug(boolean on)	Turns debug output on or off
protected void	setDefaultReferralCredentials(LDAPConnection conn)
void	setErrorCode(int code)	Sets an error code for retrieval by a client
void	setFilter(String filter)	Sets the search filter
void	setHost(String theHost)	Sets host string.
void	setPort(int thePort)	Sets port number.
void	setScope(int scope)	Set the search scope using an integer
void	setUserID(String name)	Set the user ID.
void	setUserName(String name)	Set the user name.

Methods inherited from class Object

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

Constructor Details

LDAPSimpleAuth

public LDAPSimpleAuth()

Constructor with no parameters

LDAPSimpleAuth

public LDAPSimpleAuth(String theHost,
 int thePort)

Constructor with host and port initializers

Parameters:

theHost - host string

thePort - port number

LDAPSimpleAuth

public LDAPSimpleAuth(String theHost,
 int thePort,
 String dn,
 String password)

Constructor with all required authentication parameters

Parameters:

theHost - host string

thePort - port number

dn - fully qualified distinguished name to authenticate

password - password for authenticating the dn

Method Details

authenticate

public String authenticate()

Connect to LDAP server using parameters specified in constructor and/or by setting properties and attempt to authenticate.

Returns:

"Y" on successful authentication, "N" otherwise

authenticate

public String authenticate(String dn,
 String password)

Connect to LDAP server using parameters specified in constructor and/or by setting properties and attempt to authenticate.

Parameters:

dn - fully qualified distinguished name to authenticate

password - password for authenticating the dn

Returns:

"Y" on successful authentication, "N" otherwise

authenticate

public void authenticate(ActionEvent x)

main

public static void main(String[] args)

The main body if we run it as stand-alone application.

Parameters:

args - list of arguments