org.springframework.credhub.support.password

Class PasswordParameters

java.lang.Object

org.springframework.credhub.support.password.PasswordParameters

public class PasswordParameters
extends java.lang.Object

Parameters for generating a new password credential. All parameters are optional; if not specified, CredHub-provided defaults will be used.

Author:

Scott Frederick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PasswordParameters.PasswordParametersBuilder A builder that provides a fluent API for constructing PasswordParameters.PasswordParametersBuilders.

Constructor Summary

Constructors

Constructor and Description
PasswordParameters() Create a PasswordParameters using defaults for all parameter values.
PasswordParameters(int length, boolean excludeUpper, boolean excludeLower, boolean excludeNumber, boolean includeSpecial) Create a PasswordParameters using the specified values.

Method Summary

Modifier and Type	Method and Description
static PasswordParameters.PasswordParametersBuilder	builder() Create a builder that provides a fluent API for providing the values required to construct a PasswordParameters.
java.lang.Boolean	getExcludeLower() Get the value of the exclude lower case characters parameter.
java.lang.Boolean	getExcludeNumber() Get the value of the exclude numeric characters parameter.
java.lang.Boolean	getExcludeUpper() Get the value of the exclude upper case characters parameter.
java.lang.Boolean	getIncludeSpecial() Get the value of the include non-alphanumeric characters parameter.
java.lang.Integer	getLength() Get the value of the length parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordParameters

public PasswordParameters()

Create a PasswordParameters using defaults for all parameter values.

PasswordParameters

public PasswordParameters(int length,
                          boolean excludeUpper,
                          boolean excludeLower,
                          boolean excludeNumber,
                          boolean includeSpecial)

Create a PasswordParameters using the specified values.

Parameters:

length - length of generated password value

excludeUpper - true to exclude upper case alpha characters from generated credential value

excludeLower - true to exclude lower case alpha characters from generated credential value

excludeNumber - true to exclude numeric characters from generated credential value

includeSpecial - true to include non-alphanumeric characters in generated credential value

Method Detail

getLength

public java.lang.Integer getLength()

Get the value of the length parameter.

Returns:

the value of the parameter; will be null if not explicitly set

getExcludeUpper

public java.lang.Boolean getExcludeUpper()

Get the value of the exclude upper case characters parameter.

Returns:

the value of the parameter; will be null if not explicitly set

getExcludeLower

public java.lang.Boolean getExcludeLower()

Get the value of the exclude lower case characters parameter.

Returns:

the value of the parameter; will be null if not explicitly set

getExcludeNumber

public java.lang.Boolean getExcludeNumber()

Get the value of the exclude numeric characters parameter.

Returns:

the value of the parameter; will be null if not explicitly set

getIncludeSpecial

public java.lang.Boolean getIncludeSpecial()

Get the value of the include non-alphanumeric characters parameter.

Returns:

the value of the parameter; will be null if not explicitly set

builder

public static PasswordParameters.PasswordParametersBuilder builder()

Create a builder that provides a fluent API for providing the values required to construct a PasswordParameters.

Returns:

a builder