This project has retired. For details please refer to its Attic page.

org.apache.jetspeed.security.spi.impl
Class LdapCredentialHandler

java.lang.Object
  org.apache.jetspeed.security.spi.impl.LdapCredentialHandler

All Implemented Interfaces:

org.apache.jetspeed.security.spi.CredentialHandler

public class LdapCredentialHandler
extends Object
implements org.apache.jetspeed.security.spi.CredentialHandler

Author:

Mike Long

See Also:

CredentialHandler

Field Summary

private LdapUserCredentialDao	ldap The LdapUserCredentialDao.
private static org.apache.commons.logging.Log	LOG The logger.

Constructor Summary

LdapCredentialHandler()
Default constructor.

LdapCredentialHandler(LdapUserCredentialDao ldap)
Constructor given a LdapUserCredentialDao.

Method Summary

boolean	authenticate(String uid, String password)
Set	getPrivateCredentials(String uid)
Set	getPublicCredentials(String username)
void	importPassword(String uid, String newPassword)
private void	logSecurityException(org.apache.jetspeed.security.SecurityException e, String uid)
void	setPassword(String uid, String oldPassword, String newPassword) Adds or updates a private password credential.
void	setPasswordEnabled(String userName, boolean enabled)
void	setPasswordExpiration(String userName, Date expirationDate)
void	setPasswordUpdateRequired(String userName, boolean updateRequired)
private void	validate(String uid, String password) Validates the uid.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

The logger.

ldap

private LdapUserCredentialDao ldap

The LdapUserCredentialDao.

Constructor Detail

LdapCredentialHandler

public LdapCredentialHandler()
                      throws NamingException,
                             org.apache.jetspeed.security.SecurityException

Default constructor.

Throws:

NamingException

org.apache.jetspeed.security.SecurityException

LdapCredentialHandler

public LdapCredentialHandler(LdapUserCredentialDao ldap)
                      throws NamingException,
                             org.apache.jetspeed.security.SecurityException

Constructor given a LdapUserCredentialDao.

Parameters:

ldap - The LdapUserCredentialDao.

Throws:

NamingException - A NamingException.

org.apache.jetspeed.security.SecurityException - A SecurityException.

Method Detail

getPublicCredentials

public Set getPublicCredentials(String username)

Specified by:

getPublicCredentials in interface org.apache.jetspeed.security.spi.CredentialHandler

See Also:

CredentialHandler.getPublicCredentials(java.lang.String)

getPrivateCredentials

public Set getPrivateCredentials(String uid)

Specified by:

getPrivateCredentials in interface org.apache.jetspeed.security.spi.CredentialHandler

See Also:

CredentialHandler.getPrivateCredentials(java.lang.String)

logSecurityException

private void logSecurityException(org.apache.jetspeed.security.SecurityException e,
                                  String uid)

importPassword

public void importPassword(String uid,
                           String newPassword)
                    throws org.apache.jetspeed.security.SecurityException

Specified by:

importPassword in interface org.apache.jetspeed.security.spi.CredentialHandler

Throws:

org.apache.jetspeed.security.SecurityException

See Also:

CredentialHandler.importPassword(java.lang.String,java.lang.String)

setPassword

public void setPassword(String uid,
                        String oldPassword,
                        String newPassword)
                 throws org.apache.jetspeed.security.SecurityException

Adds or updates a private password credential.
If oldPassword is not null, the oldPassword will first be checked (authenticated).

Specified by:

setPassword in interface org.apache.jetspeed.security.spi.CredentialHandler

Parameters:

uid - The LDAP uid attribute.

oldPassword - The old PasswordCredential.

newPassword - The new PasswordCredential.

Throws:

org.apache.jetspeed.security.SecurityException - when the lookup fails because the user does not exist or the non-null password is not correct. Throws a SecurityException.

setPasswordEnabled

public void setPasswordEnabled(String userName,
                               boolean enabled)
                        throws org.apache.jetspeed.security.SecurityException

Specified by:

setPasswordEnabled in interface org.apache.jetspeed.security.spi.CredentialHandler

Throws:

org.apache.jetspeed.security.SecurityException

See Also:

CredentialHandler.setPasswordEnabled(java.lang.String, boolean)

setPasswordUpdateRequired

public void setPasswordUpdateRequired(String userName,
                                      boolean updateRequired)
                               throws org.apache.jetspeed.security.SecurityException

Specified by:

setPasswordUpdateRequired in interface org.apache.jetspeed.security.spi.CredentialHandler

Throws:

org.apache.jetspeed.security.SecurityException

See Also:

CredentialHandler.setPasswordUpdateRequired(java.lang.String, boolean)

setPasswordExpiration

public void setPasswordExpiration(String userName,
                                  Date expirationDate)
                           throws org.apache.jetspeed.security.SecurityException

Specified by:

setPasswordExpiration in interface org.apache.jetspeed.security.spi.CredentialHandler

Throws:

org.apache.jetspeed.security.SecurityException

See Also:

CredentialHandler.setPasswordExpiration(java.lang.String, java.sql.Date)

authenticate

public boolean authenticate(String uid,
                            String password)
                     throws org.apache.jetspeed.security.SecurityException

Specified by:

authenticate in interface org.apache.jetspeed.security.spi.CredentialHandler

Throws:

org.apache.jetspeed.security.SecurityException

See Also:

CredentialHandler.authenticate(java.lang.String, java.lang.String)

validate

private void validate(String uid,
                      String password)
               throws org.apache.jetspeed.security.SecurityException

Validates the uid.

Parameters:

uid - The uid.

password - The password.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.