Package org.camunda.bpm.engine.identity
Interface PasswordPolicyRule
- All Known Implementing Classes:
PasswordPolicyDigitRuleImpl
,PasswordPolicyLengthRuleImpl
,PasswordPolicyLowerCaseRuleImpl
,PasswordPolicySpecialCharacterRuleImpl
,PasswordPolicyUpperCaseRuleImpl
,PasswordPolicyUserDataRuleImpl
public interface PasswordPolicyRule
Describes a rule of a
PasswordPolicy
. All rules attached to a
PasswordPolicy
must be matched by passwords for engine-managed users
to be policy compliant.- Author:
- Miklas Boskamp
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks the given password against this rule.default boolean
Checks the given password and the user against this rule.Additional parameter that can be used to display a meaningful description.Placeholder string that can be used to display a description of this rule.
-
Method Details
-
getPlaceholder
String getPlaceholder()Placeholder string that can be used to display a description of this rule. The actual description text must be managed on the calling side.- Returns:
- the placeholder for the description text.
-
getParameters
Additional parameter that can be used to display a meaningful description.- Returns:
- a map of parameters
-
execute
Checks the given password against this rule.Heads-up: The return value is not respected when
execute(String, User)
is implemented.- Parameters:
candidatePassword
- which is checked against a password policy- Returns:
true
if the given password matches this rule.false
if the given password is not compliant with this rule.
-
execute
Checks the given password and the user against this rule.- Parameters:
candidatePassword
- which is checked against a password policyuser
- to be taken into account when checking the candidate password. Can benull
whenIdentityService.checkPassword(String, String)
is called.- Returns:
true
if the given password matches this rule.false
if the given password is not compliant with this rule.
-