netscape.ldap.beans
Class LDAPSimpleAuth

java.lang.Object
  |
  +--netscape.ldap.beans.LDAPBasePropertySupport
        |
        +--netscape.ldap.beans.LDAPSimpleAuth

public class LDAPSimpleAuth

extends LDAPBasePropertySupport

implements java.io.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":

 
 <SCRIPT LANGUAGE="JavaScript">
 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 );
 }
 </SCRIPT>
 

See Also:

Serialized Form

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

LDAPSimpleAuth()
Constructor with no parameters

LDAPSimpleAuth(java.lang.String theHost, int thePort)
Constructor with host and port initializers

LDAPSimpleAuth(java.lang.String theHost, int thePort, java.lang.String dn, java.lang.String password)
Constructor with all required authentication parameters

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPSimpleAuth

public LDAPSimpleAuth()

Constructor with no parameters

LDAPSimpleAuth

public LDAPSimpleAuth(java.lang.String theHost,
                      int thePort)

Constructor with host and port initializers

Parameters:

theHost - host string

thePort - port number

LDAPSimpleAuth

public LDAPSimpleAuth(java.lang.String theHost,
                      int thePort,
                      java.lang.String dn,
                      java.lang.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 Detail

authenticate

public java.lang.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 java.lang.String authenticate(java.lang.String dn,
                                     java.lang.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(java.awt.event.ActionEvent x)

main

public static void main(java.lang.String[] args)

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

Parameters:

args - list of arguments