JahiaPasswordPolicyRule (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.pwdpolicy.JahiaPasswordPolicyRule

All Implemented Interfaces:

Serializable
```
public class JahiaPasswordPolicyRule
extends Object
implements Serializable
```
Password policy rule data object.

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ACTION_INVALIDATE_PASSWORD` Indicates that the password will be invalidated and the user will be forced to change it.
`static char`	`ACTION_WARN` Indicates that the warning (validation or notification) message will be shown to the user.
`static char`	`EVALUATOR_GROOVY` The rule condition represents a Groovy-based implementation to be called.
`static char`	`EVALUATOR_JAVA` The rule condition represents a Java-based implementation to be called.

Constructor Summary

Constructors
Constructor and Description
`JahiaPasswordPolicyRule()` Initializes an instance of this class.
`JahiaPasswordPolicyRule(JahiaPasswordPolicyRule rule)` Copy constructor
`JahiaPasswordPolicyRule(String id, String name, boolean active, boolean periodical, boolean lastRule, char evaluator, String condition, char action)` Initializes an instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`char`	`getAction()` Returns the action type.
`List<JahiaPasswordPolicyRuleParam>`	`getActionParameters()` Returns the actionParameters.
`Map<String,String>`	`getActionParametersValues()` Returns the map with all action parameters, keyed by their names.
`String`	`getCondition()` Returns the condition.
`List<JahiaPasswordPolicyRuleParam>`	`getConditionParameters()` Returns the conditionParameters.
`Map<String,String>`	`getConditionParametersValues()` Returns the map with all condition parameters, keyed by their names.
`char`	`getEvaluator()` Returns the evaluator type.
`String`	`getId()` Returns the rule id.
`String`	`getName()` Returns the rule name.
`int`	`hashCode()`
`boolean`	`isActive()` Returns `true` if this rule is active.
`boolean`	`isLastRule()` Returns the `true` if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules.
`boolean`	`isPeriodical()` Returns `true` if this is a reoccurring rule (e.g.
`void`	`setAction(char action)` Sets the value of action.
`void`	`setActionParameters(List<JahiaPasswordPolicyRuleParam> actionParameters)` Sets the value of actionParameters.
`void`	`setActive(boolean active)` Sets the value of active flag.
`void`	`setCondition(String condition)` Sets the value of condition.
`void`	`setConditionParameters(List<JahiaPasswordPolicyRuleParam> conditionParameters)` Sets the value of conditionParameters.
`void`	`setEvaluator(char evaluator)` Sets the value of evaluator.
`void`	`setId(String id)` Sets the value of rule id.
`void`	`setLastRule(boolean lastRule)` Set to `true` if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules.
`void`	`setName(String name)` Sets the value of rule name.
`void`	`setParameters(List<JahiaPasswordPolicyRuleParam> parameters)` Sets the value of parameters.
`void`	`setPeriodical(boolean periodical)` Sets the value of periodical flag.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACTION_INVALIDATE_PASSWORD
```
public static final char ACTION_INVALIDATE_PASSWORD
```
    Indicates that the password will be invalidated and the user will be forced to change it.
    
    See Also:
    
    Constant Field Values
  - ACTION_WARN
```
public static final char ACTION_WARN
```
    Indicates that the warning (validation or notification) message will be shown to the user.
    
    See Also:
    
    Constant Field Values
  - EVALUATOR_GROOVY
```
public static final char EVALUATOR_GROOVY
```
    The rule condition represents a Groovy-based implementation to be called.
    
    See Also:
    
    Constant Field Values
  - EVALUATOR_JAVA
```
public static final char EVALUATOR_JAVA
```
    The rule condition represents a Java-based implementation to be called.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JahiaPasswordPolicyRule
```
public JahiaPasswordPolicyRule()
```
    Initializes an instance of this class.
  - JahiaPasswordPolicyRule
```
public JahiaPasswordPolicyRule(String id,
                               String name,
                               boolean active,
                               boolean periodical,
                               boolean lastRule,
                               char evaluator,
                               String condition,
                               char action)
```
    Initializes an instance of this class.
    
    Parameters:
    
    id -
    
    name -
    
    active -
    
    periodical -
    
    lastRule -
    
    evaluator -
    
    condition -
    
    action -
  - JahiaPasswordPolicyRule
```
public JahiaPasswordPolicyRule(JahiaPasswordPolicyRule rule)
```
    Copy constructor
    
    Parameters:
    
    rule - the rule to create a copy from
- Method Detail
  - getAction
```
public char getAction()
```
    Returns the action type.
    
    Returns:
    
    the action type
  - getActionParameters
```
public List<JahiaPasswordPolicyRuleParam> getActionParameters()
```
    Returns the actionParameters.
    
    Returns:
    
    the actionParameters
  - getActionParametersValues
```
public Map<String,String> getActionParametersValues()
```
    Returns the map with all action parameters, keyed by their names. The new map is created each time this method is called.
    
    Returns:
    
    the map with all action parameters, keyed by their names
  - getCondition
```
public String getCondition()
```
    Returns the condition.
    
    Returns:
    
    the condition
  - getConditionParameters
```
public List<JahiaPasswordPolicyRuleParam> getConditionParameters()
```
    Returns the conditionParameters.
    
    Returns:
    
    the conditionParameters
  - getConditionParametersValues
```
public Map<String,String> getConditionParametersValues()
```
    Returns the map with all condition parameters, keyed by their names. The new map is created each time this method is called.
    
    Returns:
    
    the map with all condition parameters, keyed by their names
  - getEvaluator
```
public char getEvaluator()
```
    Returns the evaluator type.
    
    Returns:
    
    the evaluator type
  - getId
```
public String getId()
```
    Returns the rule id.
    
    Returns:
    
    the rule id
  - getName
```
public String getName()
```
    Returns the rule name.
    
    Returns:
    
    the rule name
  - isActive
```
public boolean isActive()
```
    Returns true if this rule is active.
    
    Returns:
    
    true if this rule is active
  - isLastRule
```
public boolean isLastRule()
```
    Returns the true if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules.
    
    Returns:
    
    the true if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules
  - isPeriodical
```
public boolean isPeriodical()
```
    Returns true if this is a reoccurring rule (e.g. on each user login).
    
    Returns:
    
    true if this is a reoccurring rule (e.g. on each user login)
  - setAction
```
public void setAction(char action)
```
    Sets the value of action.
    
    Parameters:
    
    action - the action to set
  - setActionParameters
```
public void setActionParameters(List<JahiaPasswordPolicyRuleParam> actionParameters)
```
    Sets the value of actionParameters.
    
    Parameters:
    
    actionParameters - the actionParameters to set
  - setActive
```
public void setActive(boolean active)
```
    Sets the value of active flag.
    
    Parameters:
    
    active - the active flag value to set
  - setCondition
```
public void setCondition(String condition)
```
    Sets the value of condition.
    
    Parameters:
    
    condition - the condition to set
  - setConditionParameters
```
public void setConditionParameters(List<JahiaPasswordPolicyRuleParam> conditionParameters)
```
    Sets the value of conditionParameters.
    
    Parameters:
    
    conditionParameters - the conditionParameters to set
  - setEvaluator
```
public void setEvaluator(char evaluator)
```
    Sets the value of evaluator.
    
    Parameters:
    
    evaluator - the evaluator to set
  - setId
```
public void setId(String id)
```
    Sets the value of rule id.
    
    Parameters:
    
    id - the rule id to set
  - setLastRule
```
public void setLastRule(boolean lastRule)
```
    Set to true if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules.
    
    Parameters:
    
    lastRule - true if the processing of further rules in the policy is stopped if this one is violated, thus it is possible to define exclusive rules
  - setName
```
public void setName(String name)
```
    Sets the value of rule name.
    
    Parameters:
    
    name - the rule name to set
  - setParameters
```
public void setParameters(List<JahiaPasswordPolicyRuleParam> parameters)
```
    Sets the value of parameters.
    
    Parameters:
    
    parameters - the parameters to set
  - setPeriodical
```
public void setPeriodical(boolean periodical)
```
    Sets the value of periodical flag.
    
    Parameters:
    
    periodical - the periodical flag to set
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JahiaPasswordPolicyRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_INVALIDATE_PASSWORD

ACTION_WARN

EVALUATOR_GROOVY

EVALUATOR_JAVA

Constructor Detail

JahiaPasswordPolicyRule

JahiaPasswordPolicyRule

JahiaPasswordPolicyRule

Method Detail

getAction

getActionParameters

getActionParametersValues

getCondition

getConditionParameters

getConditionParametersValues

getEvaluator

getId

getName

isActive

isLastRule

isPeriodical

setAction

setActionParameters

setActive

setCondition

setConditionParameters

setEvaluator

setId

setLastRule

setName

setParameters

setPeriodical

equals

hashCode

toString