org.jasig.cas.adaptors.ldap

Class LdapPasswordPolicyEnforcer

java.lang.Object

org.jasig.cas.authentication.AbstractPasswordPolicyEnforcer

org.jasig.cas.adaptors.ldap.LdapPasswordPolicyEnforcer

All Implemented Interfaces:

PasswordPolicyEnforcer, org.springframework.beans.factory.InitializingBean

public class LdapPasswordPolicyEnforcer
extends AbstractPasswordPolicyEnforcer

Class that fetches a password expiration date from an AD/LDAP database. Based on AccountStatusGetter by Bart Ophelders & Johan Peeters

Version:

1.3 12/14/2009 11:47:37

Author:

Eric Pierce

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dateAttribute The attribute that contains the date the password will expire or last password change
protected String	dateFormat The format of the date in DateAttribute
protected String	validDaysAttribute The attribute that contains the number of days the user's password is valid
protected Boolean	warnAll Disregard WarnPeriod and warn all users of password expiration
protected String	warningDaysAttribute The attribute that contains the user's warning days

Fields inherited from class org.jasig.cas.authentication.AbstractPasswordPolicyEnforcer

logger

Constructor Summary

Constructors

Constructor and Description
LdapPasswordPolicyEnforcer()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
long	getNumberOfDaysToPasswordExpirationDate(String userId)
void	setContextSource(org.springframework.ldap.core.ContextSource contextSource) Method to set the data source and generate a LDAPTemplate.
void	setDateAttribute(String dateAttribute)
void	setDateFormat(String dateFormat)
void	setFilter(String filter)
void	setIgnorePartialResultException(boolean ignorePartialResultException)
void	setMaxNumberResults(int maxNumberResults)
void	setNoWarnAttribute(String noWarnAttribute)
void	setNoWarnValues(List<String> noWarnValues)
void	setScope(int scope)
void	setSearchBase(String searchBase)
void	setTimeout(int timeout)
void	setValidDays(int validDays)
void	setValidDaysAttribute(String validDaysAttribute)
void	setWarnAll(Boolean warnAll)
void	setWarningDays(int warningDays)
void	setWarningDaysAttribute(String warnDays)

Methods inherited from class java.lang.Object

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

Field Detail

dateAttribute

protected String dateAttribute

The attribute that contains the date the password will expire or last password change

dateFormat

protected String dateFormat

The format of the date in DateAttribute

validDaysAttribute

protected String validDaysAttribute

The attribute that contains the number of days the user's password is valid

warnAll

protected Boolean warnAll

Disregard WarnPeriod and warn all users of password expiration

warningDaysAttribute

protected String warningDaysAttribute

The attribute that contains the user's warning days

Constructor Detail

LdapPasswordPolicyEnforcer

public LdapPasswordPolicyEnforcer()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Throws:

Exception

getNumberOfDaysToPasswordExpirationDate

public long getNumberOfDaysToPasswordExpirationDate(String userId)
                                             throws LdapPasswordPolicyEnforcementException

Parameters:

userId - The unique ID of the user

Returns:

Number of days left to the expiration date, or

Throws:

LdapPasswordPolicyEnforcementException

setContextSource

public void setContextSource(org.springframework.ldap.core.ContextSource contextSource)

Method to set the data source and generate a LDAPTemplate.

Parameters:

dataSource - the data source to use.

setDateAttribute

public void setDateAttribute(String dateAttribute)

Parameters:

DateAttribute - The DateAttribute to set.

setDateFormat

public void setDateFormat(String dateFormat)

Parameters:

dateFormat - String to pass to SimpleDateFormat() that describes the date in the ExpireDateAttribute. This parameter is required.

setFilter

public void setFilter(String filter)

Parameters:

filter - The LDAP filter to set.

setIgnorePartialResultException

public void setIgnorePartialResultException(boolean ignorePartialResultException)

setMaxNumberResults

public void setMaxNumberResults(int maxNumberResults)

Parameters:

maxNumberResults - The maxNumberResults to set.

setNoWarnAttribute

public void setNoWarnAttribute(String noWarnAttribute)

Parameters:

noWarnAttribute - The noWarnAttribute to set.

setNoWarnValues

public void setNoWarnValues(List<String> noWarnValues)

Parameters:

noWarnAttribute - The noWarnAttribute to set.

setScope

public void setScope(int scope)

Parameters:

filter - The scope to set.

setSearchBase

public void setSearchBase(String searchBase)

Parameters:

searchBase - The searchBase to set.

setTimeout

public void setTimeout(int timeout)

Parameters:

timeout - The timeout to set.

setValidDays

public void setValidDays(int validDays)

Parameters:

validDays - Number of days that a password is valid for. Used as a default if DateAttribute is not set or is not found in the LDAP results

setValidDaysAttribute

public void setValidDaysAttribute(String validDaysAttribute)

Parameters:

ValidDaysAttribute - The ValidDaysAttribute to set.

setWarnAll

public void setWarnAll(Boolean warnAll)

Parameters:

warnAll - Disregard warningPeriod and warn all users of password expiration.

setWarningDays

public void setWarningDays(int warningDays)

Parameters:

warningDays - Number of days before expiration that a warning message is displayed to set. Used as a default if warningDaysAttribute is not set or is not found in the LDAP results. This parameter is required.

setWarningDaysAttribute

public void setWarningDaysAttribute(String warnDays)

Parameters:

WarningDaysAttribute - The WarningDaysAttribute to set.