Package jenkins.security

Class PasswordComplexityRule

java.lang.Object

jenkins.security.PasswordComplexityRule

All Implemented Interfaces:

ExtensionPoint, Describable<PasswordComplexityRule>

Direct Known Subclasses:

BasicPasswordComplexityRule, NonePasswordComplexityRule

public abstract class PasswordComplexityRule
extends Object
implements Describable<PasswordComplexityRule>, ExtensionPoint

Extension point for password complexity validation in HudsonPrivateSecurityRealm.

Implementations define rules that passwords must satisfy during user registration and password changes. Each implementation can have an optional config.jelly to configure its validation rules.

Since:

2.572 (moved from hudson.security to jenkins.security in 2.TODO)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PasswordComplexityRule()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<PasswordComplexityRule,Descriptor<PasswordComplexityRule>>	all()	Returns all the registered PasswordComplexityRule descriptors.
PasswordComplexityRuleDescriptor	getDescriptor()	Gets the descriptor for this instance.
abstract void	validate(String password)	Validates the given password against this rule.

Methods inherited from class java.lang.Object

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

Constructor Details

PasswordComplexityRule

public PasswordComplexityRule()

Method Details

all

public static DescriptorExtensionList<PasswordComplexityRule,Descriptor<PasswordComplexityRule>> all()

Returns all the registered PasswordComplexityRule descriptors.

validate

public abstract void validate(@NonNull
 String password)
                       throws PasswordComplexityException

Validates the given password against this rule.

Parameters:

password - the password to validate

Throws:

PasswordComplexityException - if the password does not meet the requirements

getDescriptor

public PasswordComplexityRuleDescriptor getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<PasswordComplexityRule>