Package org.deltava.security

Class LDAPAuthenticator

java.lang.Object

org.deltava.security.LDAPAuthenticator

All Implemented Interfaces:

Closeable, AutoCloseable, Authenticator

public class LDAPAuthenticator
extends Object
implements Authenticator

An authenticator to validate users against an LDAP server.

Since:

1.0

Version:

11.1

Author:

Luke

Field Summary

Fields

Modifier and Type	Field	Description
protected final Hashtable<String,String>	_env	JNDI environment.
protected static final org.apache.logging.log4j.Logger	log

Fields inherited from interface org.deltava.security.Authenticator

DEFAULT_PROPS_FILE

Constructor Summary

Constructors

Constructor	Description
LDAPAuthenticator()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(Person usr)	This Authenticator accepts all users with a valid Directory Name.
void	add(Person usr, String pwd)	Adds a User to the Directory.
void	authenticate(Person usr, String pwd)	Authenticates the user by doing an LDAP bind operation and checking if it succeeded.
boolean	contains(Person usr)	Checks if a particular name exists in the Directory.
void	disable(Person usr)	Disables a user's account.
void	init(String propsFile)	Initializes the authenticator.
void	remove(Person usr)	Removes a User from the Directory.
void	rename(Person usr, String newName)	Renames a user in the Directory.
void	updatePassword(Person usr, String pwd)	Updates a user's password.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.security.Authenticator

close

Field Details

log

protected static final org.apache.logging.log4j.Logger log

_env

protected final Hashtable<String,String> _env

JNDI environment.

Constructor Details

LDAPAuthenticator

public LDAPAuthenticator()

Method Details

init

public void init(String propsFile)
          throws SecurityException

Initializes the authenticator.

Specified by:

init in interface Authenticator

Parameters:

propsFile - the properties file to use

Throws:

SecurityException - if an error occurs

authenticate

public void authenticate(Person usr,
 String pwd)
                  throws SecurityException

Authenticates the user by doing an LDAP bind operation and checking if it succeeded.

Specified by:

authenticate in interface Authenticator

Parameters:

usr - the user bean

pwd - the user's password

Throws:

SecurityException - if authentication fails for any reason, contained within the cause of the exception.

See Also:

• Authenticator.authenticate(Person, String)

updatePassword

public void updatePassword(Person usr,
 String pwd)
                    throws SecurityException

Updates a user's password.

Specified by:

updatePassword in interface Authenticator

Parameters:

usr - the user bean

pwd - the new password

Throws:

SecurityException - if an error occurs

add

public void add(Person usr,
 String pwd)
         throws SecurityException

Adds a User to the Directory.

Specified by:

add in interface Authenticator

Parameters:

usr - the user bean

pwd - the User's password

Throws:

SecurityException - if an error occurs

contains

public boolean contains(Person usr)
                 throws SecurityException

Checks if a particular name exists in the Directory.

Specified by:

contains in interface Authenticator

Parameters:

usr - the user bean

Returns:

TRUE if the user exists, otherwise FALSE

Throws:

SecurityException - if an error occurs

accepts

public boolean accepts(Person usr)

This Authenticator accepts all users with a valid Directory Name.

Specified by:

accepts in interface Authenticator

Parameters:

usr - the user bean

Returns:

TRUE if the user's DN property is not empty

disable

public void disable(Person usr)
             throws SecurityException

Disables a user's account. This deletes the User.

Specified by:

disable in interface Authenticator

Parameters:

usr - the user bean

Throws:

SecurityException - if an error occurs

remove

public void remove(Person usr)
            throws SecurityException

Removes a User from the Directory.

Specified by:

remove in interface Authenticator

Parameters:

usr - the user bean

Throws:

SecurityException - if an error occurs

rename

public void rename(Person usr,
 String newName)
            throws SecurityException

Renames a user in the Directory.

Specified by:

rename in interface Authenticator

Parameters:

usr - the user bean

newName - the new fully-qualified directory

Throws:

SecurityException - if an error occurs