org.jahia.services.pwdpolicy

Class PolicyEnforcementResult

java.lang.Object

org.jahia.services.pwdpolicy.PolicyEnforcementResult

public class PolicyEnforcementResult
extends Object

The password policy evaluation result.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
PolicyEnforcementResult(List<JahiaPasswordPolicyRule> violatedRules) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
EngineMessages	getEngineMessages() Returns the result of the evaluation as the EngineMessages object, that can be displayed in the front-end.
List<JahiaPasswordPolicyRule>	getInvalidationRules() Returns the invalidationRules.
List<String>	getTextMessages() Returns the result of the evaluation as the list of plain English messages.
List<JahiaPasswordPolicyRule>	getViolatedRules() Returns the violatedRules.
List<JahiaPasswordPolicyRule>	getWarningRules() Returns the warningRules.
boolean	isPasswordInvalidationRequired() Returns true if at least one of the violated rules requires password invalidation as a target action.
boolean	isSuccess() Returns true if none of the applied rules is violated.
boolean	isWarningRequired() Returns true if at least one of the violated rules requires displaying a notification as a target action.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyEnforcementResult

public PolicyEnforcementResult(List<JahiaPasswordPolicyRule> violatedRules)

Initializes an instance of this class.

Parameters:

violatedRules -

Method Detail

getEngineMessages

public EngineMessages getEngineMessages()

Returns the result of the evaluation as the EngineMessages object, that can be displayed in the front-end. Each message is composed using an I18N key and a list of arguments to be substituted.

Returns:

the result of the evaluation as the EngineMessages object, that can be displayed in the front-end. Each message is composed using an I18N key and a list of arguments to be substituted

getTextMessages

public List<String> getTextMessages()

Returns the result of the evaluation as the list of plain English messages.

Returns:

the result of the evaluation as the list of plain English messages

getInvalidationRules

public List<JahiaPasswordPolicyRule> getInvalidationRules()

Returns the invalidationRules.

Returns:

the invalidationRules

getViolatedRules

public List<JahiaPasswordPolicyRule> getViolatedRules()

Returns the violatedRules.

Returns:

the violatedRules

getWarningRules

public List<JahiaPasswordPolicyRule> getWarningRules()

Returns the warningRules.

Returns:

the warningRules

isPasswordInvalidationRequired

public boolean isPasswordInvalidationRequired()

Returns true if at least one of the violated rules requires password invalidation as a target action.

Returns:

true if at least one of the violated rules requires password invalidation as a target action

isSuccess

public boolean isSuccess()

Returns true if none of the applied rules is violated.

Returns:

true if none of the applied rules is violated

isWarningRequired

public boolean isWarningRequired()

Returns true if at least one of the violated rules requires displaying a notification as a target action.

Returns:

true if at least one of the violated rules requires displaying a notification as a target action