PasswordPolicyRule (Camunda Platform Javadocs 7.20.0-SNAPSHOT)

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`execute(String candidatePassword)`	Checks the given password against this rule.
`default boolean`	`execute(String candidatePassword, User user)`	Checks the given password and the user against this rule.
`Map<String,String>`	`getParameters()`	Additional parameter that can be used to display a meaningful description.
`String`	`getPlaceholder()`	Placeholder string that can be used to display a description of this rule.

- Method Detail
  - 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
```
Map<String,String> getParameters()
```
    Additional parameter that can be used to display a meaningful description.
    
    Returns:
    
    a map of parameters
  - execute
```
boolean execute(String candidatePassword)
```
    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
```
default boolean execute(String candidatePassword,
                        User user)
```
    Checks the given password and the user against this rule.
    
    Parameters:
    
    candidatePassword - which is checked against a password policy
    
    user - to be taken into account when checking the candidate password. Can be null when IdentityService.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.