org.jahia.services.pwdpolicy

Class JahiaPasswordPolicyService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.pwdpolicy.JahiaPasswordPolicyService

public class JahiaPasswordPolicyService
extends JahiaService

Jahia service for managing and enforcing the password policy.

Author:

Sergiy Shyrkov

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JahiaPasswordPolicyService()

Method Summary

Modifier and Type	Method and Description
PolicyEnforcementResult	enforcePolicyOnLogin(JCRUserNode user) Enforce the password policy for the specified user if applicable during on user login.
PolicyEnforcementResult	enforcePolicyOnPasswordChange(JCRUserNode user, String password, boolean isUserInitiated) Enforce the password policy for the specified user if applicable during the password change.
PolicyEnforcementResult	enforcePolicyOnUserCreate(String username, String password) Enforce the password policy for the newly created user.
JahiaPasswordPolicy	getDefaultPolicy()
static JahiaPasswordPolicyService	getInstance() Returns an instance of this service.
List<PasswordHistoryEntry>	getPasswordHistory(JCRUserNode user) Returns the (encrypted) password history map, sorted by change date descending, i.e.
boolean	isPasswordReadOnly(JCRUserNode user) Method to test if the user comes from a read-only provider.
boolean	isPolicyEnabled(JCRUserNode user) Checks, if the password policy should be enforced for the specified user (existing user).
boolean	isPolicyEnforcementEnabled() Checks, if the global password policy enforcement is enabled.
void	setDefaultPasswordPolicy(JahiaPasswordPolicy defaultPasswordPolicy) Sets the default password policy object.
void	setPasswordPolicyManager(org.jahia.services.pwdpolicy.JahiaPasswordPolicyManager mgr) Sets the reference to the manager service.
void	setPolicyEnforcementEnabled(boolean policyEnabled)
void	setUserManagerService(JahiaUserManagerService userMgrService) Injects an instance of the JahiaUserManagerService
void	start()
void	stop()
void	storePasswordHistory(JCRUserNode user) Stores the current user's password into password history.
void	updatePolicy(JahiaPasswordPolicy policy) Persists the changes made to the password policy.

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaPasswordPolicyService

public JahiaPasswordPolicyService()

Method Detail

getInstance

public static JahiaPasswordPolicyService getInstance()

Returns an instance of this service.

Returns:

an instance of this service

enforcePolicyOnLogin

public PolicyEnforcementResult enforcePolicyOnLogin(JCRUserNode user)

Enforce the password policy for the specified user if applicable during on user login.

Parameters:

user - the current user

Returns:

the evaluation result

enforcePolicyOnPasswordChange

public PolicyEnforcementResult enforcePolicyOnPasswordChange(JCRUserNode user,
                                                             String password,
                                                             boolean isUserInitiated)

Enforce the password policy for the specified user if applicable during the password change.

Parameters:

user - the current user

password - the new user password in clear text

isUserInitiated - set to true if the change in the password is initiated by the user and not via administration interface.

Returns:

the evaluation result

enforcePolicyOnUserCreate

public PolicyEnforcementResult enforcePolicyOnUserCreate(String username,
                                                         String password)

Enforce the password policy for the newly created user.

Parameters:

password - the new user password in clear text

Returns:

the evaluation result

getDefaultPolicy

public JahiaPasswordPolicy getDefaultPolicy()

isPolicyEnforcementEnabled

public boolean isPolicyEnforcementEnabled()

Checks, if the global password policy enforcement is enabled.

Returns:

true, if the password policy should be enforced

isPolicyEnabled

public boolean isPolicyEnabled(JCRUserNode user)

Checks, if the password policy should be enforced for the specified user (existing user).

Parameters:

user - the user, to perform the check for

Returns:

true, if the password policy should be enforced for the specified user (existing user)

setDefaultPasswordPolicy

public void setDefaultPasswordPolicy(JahiaPasswordPolicy defaultPasswordPolicy)

Sets the default password policy object.

Parameters:

defaultPasswordPolicy - the default password policy

setPasswordPolicyManager

public void setPasswordPolicyManager(org.jahia.services.pwdpolicy.JahiaPasswordPolicyManager mgr)

Sets the reference to the manager service.

Parameters:

mgr - the manager service instance

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException

updatePolicy

public void updatePolicy(JahiaPasswordPolicy policy)

Persists the changes made to the password policy.

Parameters:

policy - returns the same instance of password policy with the persisted data.

isPasswordReadOnly

public boolean isPasswordReadOnly(JCRUserNode user)

Method to test if the user comes from a read-only provider.

Returns:

boolean true if the user comes from a read-only provider

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userMgrService)

Injects an instance of the JahiaUserManagerService

Parameters:

userMgrService - an instance of the JahiaUserManagerService

getPasswordHistory

public List<PasswordHistoryEntry> getPasswordHistory(JCRUserNode user)

Returns the (encrypted) password history map, sorted by change date descending, i.e. the newer passwords are at the top of the list.

Returns:

the (encrypted) password history list, sorted by change date descending, i.e. the newer passwords are at the top of the list

storePasswordHistory

public void storePasswordHistory(JCRUserNode user)

Stores the current user's password into password history.

Parameters:

user - the user to store password history for

setPolicyEnforcementEnabled

public void setPolicyEnforcementEnabled(boolean policyEnabled)