Package com.storedobject.core

Class PasswordPolicy

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.PasswordPolicy

All Implemented Interfaces:

Displayable, StringFiller, HasId

public class PasswordPolicy
extends StoredObject

The PasswordPolicy class represents a set of rules and constraints that define password requirements for a system. It includes parameters such as allowed character types, length constraints, expiration policies, and reuse restrictions. This class is designed to ensure passwords comply with specified security standards and can be applied to validate password input.

Attributes: - Defines the minimum and maximum allowed lengths for passwords. - Specifies character requirements, such as alphanumeric, special characters, or numeric-only. - Allows toggling case sensitivity and restriction on repeated characters. - Includes functionality for password expiry and reuse history. - Supports initial default password configuration.

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
PasswordPolicy()	Constructs a new instance of the PasswordPolicy class.

Method Summary

Modifier and Type	Method	Description
String	apply(char[] password)	Applies a password validation check based on predefined rules such as length limits, character composition, and prohibitions against specific sequences or repetitions.
static void	columns(Columns columns)	Configures the specified columns with predefined attributes and their respective data types.
String	describe()	Generates a descriptive string about the password requirements.
String	generatePassword()	Generates a new password based on the current password policy.
static PasswordPolicy	get(Id owner)	Retrieves the password policy associated with the specified owner.
static <T extends StoredObject> PasswordPolicy	get(T owner)	Retrieves a PasswordPolicy associated with the specified owner object.
boolean	getAllowRepeatCharacters()	Retrieves the value indicating whether repeated characters are allowed.
String	getDataClass()	Retrieves the associated data class.
int	getExpiryDays()	Retrieves the number of days until the item expires.
static <T extends StoredObject> PasswordPolicy	getForClass(Class<T> owner)	Retrieves the PasswordPolicy for the specified class.
String	getInitialPassword()	Retrieves the initial password assigned to a user or system entity.
int	getMaximumLength()	Retrieves the maximum length allowed by the password policy.
int	getMinimumLength()	Retrieves the minimum length value.
int	getRequirement()	Retrieves the requirement value for the password policy.
String	getRequirementValue()	Retrieves the requirement value associated with the current requirement.
static String	getRequirementValue(int value)	Retrieves a requirement value based on the given index.
static String[]	getRequirementValues()	Retrieves the array of requirement values associated with the password policy.
boolean	getRequireMixedcase()	Retrieves the status of whether mixed-case characters are required.
int	getReuseHistory()	Retrieves the reuse history count for the associated entity.
String	getUniqueCondition()	Constructs and returns a unique condition string based on the `dataClass` value.
static int	hints()	Provides a hint or constant value representing a specific object state, characteristic, or configuration.
static void	indices(Indices indices)	Adds an index to the `indices` object with predefined parameters.
void	setAllowRepeatCharacters(boolean allowRepeatCharacters)	Sets whether repeated characters are allowed in the password.
void	setDataClass(String dataClass)	Sets the value of the dataClass field.
void	setExpiryDays(int expiryDays)	Sets the number of days until expiration.
void	setInitialPassword(String initialPassword)	Sets the initial password for this password policy.
void	setMaximumLength(int maximumLength)	Sets the maximum length for the password.
void	setMinimumLength(int minimumLength)	Sets the minimum length for passwords in the policy.
void	setRequirement(int requirement)	Sets the requirement level for the password policy.
void	setRequireMixedcase(boolean requireMixedcase)	Sets whether the password policy requires passwords to include a mix of uppercase and lowercase letters.
void	setReuseHistory(int reuseHistory)	Sets the reuse history value.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, migrateLink, migrateLink, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PasswordPolicy

public PasswordPolicy()

Constructs a new instance of the PasswordPolicy class. This class is typically used for defining and enforcing rules and constraints on passwords to ensure they comply with security standards.

Method Details

columns

public static void columns(Columns columns)

Configures the specified columns with predefined attributes and their respective data types.

Parameters:

columns - The Columns object to which the specified attributes and data types will be added.

hints

public static int hints()

Provides a hint or constant value representing a specific object state, characteristic, or configuration. In this implementation, it returns the constant value for a small list hint.

Returns:

an integer constant representing the hint for a small list

indices

public static void indices(Indices indices)

Adds an index to the `indices` object with predefined parameters.

Parameters:

indices - the `Indices` object where the index will be added

getUniqueCondition

public String getUniqueCondition()

Constructs and returns a unique condition string based on the `dataClass` value.

Overrides:

getUniqueCondition in class StoredObject

Returns:

a string representing a unique condition in the format "DataClass='value'".

setDataClass

public void setDataClass(String dataClass)

Sets the value of the dataClass field.

Parameters:

dataClass - the new value to assign to the dataClass field

getDataClass

@Column(required=false,
        caption="Associated Class",
        order=100)
public String getDataClass()

Retrieves the associated data class.

Returns:

The name of the associated data class as a string. If no data class is associated, it returns null.

setMinimumLength

public void setMinimumLength(int minimumLength)

Sets the minimum length for passwords in the policy.

Parameters:

minimumLength - the minimum number of characters required for a password

getMinimumLength

@Column(order=200)
public int getMinimumLength()

Retrieves the minimum length value.

Returns:

the minimum length as an integer.

setMaximumLength

public void setMaximumLength(int maximumLength)

Sets the maximum length for the password.

Parameters:

maximumLength - the maximum number of characters allowed for the password

getMaximumLength

@Column(order=300)
public int getMaximumLength()

Retrieves the maximum length allowed by the password policy.

Returns:

The maximum allowable length for passwords.

setRequirement

public void setRequirement(int requirement)

Sets the requirement level for the password policy.

Parameters:

requirement - the requirement level to be set. It determines the password policy's specific constraints or rules.

getRequirement

@Column(order=400)
public int getRequirement()

Retrieves the requirement value for the password policy.

Returns:

The requirement value as an integer, representing specific conditions or rules associated with the password policy.

getRequirementValues

public static String[] getRequirementValues()

Retrieves the array of requirement values associated with the password policy.

Returns:

An array of strings representing the requirement values.

getRequirementValue

public static String getRequirementValue(int value)

Retrieves a requirement value based on the given index. The value is determined from a predefined array of requirement values, cycling through the array if the index exceeds its length.

Parameters:

value - The index to retrieve the requirement value. If the index exceeds the length of the requirement values array, it wraps around using modulo operation.

Returns:

A string representing the requirement value corresponding to the provided index.

getRequirementValue

public String getRequirementValue()

Retrieves the requirement value associated with the current requirement.

Returns:

A string representing the requirement value mapped to the current requirement.

setRequireMixedcase

public void setRequireMixedcase(boolean requireMixedcase)

Sets whether the password policy requires passwords to include a mix of uppercase and lowercase letters.

Parameters:

requireMixedcase - a boolean indicating if mixed case is required; true if passwords must include both uppercase and lowercase letters, false otherwise.

getRequireMixedcase

@Column(order=500)
public boolean getRequireMixedcase()

Retrieves the status of whether mixed-case characters are required.

Returns:

True if mixed-case characters are required; otherwise, false.

setAllowRepeatCharacters

public void setAllowRepeatCharacters(boolean allowRepeatCharacters)

Sets whether repeated characters are allowed in the password.

Parameters:

allowRepeatCharacters - a boolean value where true allows repeated characters in the password, and false disallows them.

getAllowRepeatCharacters

@Column(order=600)
public boolean getAllowRepeatCharacters()

Retrieves the value indicating whether repeated characters are allowed.

Returns:

true if repeated characters are allowed, false otherwise.

setExpiryDays

public void setExpiryDays(int expiryDays)

Sets the number of days until expiration.

Parameters:

expiryDays - the number of days to set for expiration

getExpiryDays

@Column(order=700,
        required=false)
public int getExpiryDays()

Retrieves the number of days until the item expires.

Returns:

the number of expiry days as an integer.

setReuseHistory

public void setReuseHistory(int reuseHistory)

Sets the reuse history value.

Parameters:

reuseHistory - the number of times an object or action has been reused

getReuseHistory

@Column(required=false,
        order=800)
public int getReuseHistory()

Retrieves the reuse history count for the associated entity.

Returns:

the number of times the entity has been reused.

setInitialPassword

public void setInitialPassword(String initialPassword)

Sets the initial password for this password policy.

Parameters:

initialPassword - the initial password to be set

getInitialPassword

@Column(order=900)
public String getInitialPassword()

Retrieves the initial password assigned to a user or system entity.

Returns:

the initial password as a String.

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

describe

public String describe()

Generates a descriptive string about the password requirements. The description includes: - The type of characters allowed or required (e.g., alphanumeric, numeric, etc.). - Whether mixed case is required (upper and lowercase letters). - Whether repeating characters are allowed. - The history of previously used passwords that cannot be reused. - The minimum length required for the password.

Returns:

A string describing the password requirements based on the current configuration.

apply

public String apply(char[] password)

Applies a password validation check based on predefined rules such as length limits, character composition, and prohibitions against specific sequences or repetitions.

Parameters:

password - the input array of characters representing the password to be validated.

Returns:

a string describing the validation result. Returns null if the password satisfies all rules, or an error message indicating the validation failure reason otherwise.

get

public static PasswordPolicy get(Id owner)

Retrieves the password policy associated with the specified owner. If the owner is null, it returns a default password policy.

Parameters:

owner - the identifier of the owner whose password policy is to be retrieved

Returns:

the password policy associated with the given owner, or a default password policy if the owner is null

get

public static <T extends StoredObject>
PasswordPolicy get(T owner)

Retrieves a PasswordPolicy associated with the specified owner object. If the owner is null, a default PasswordPolicy is returned.

Type Parameters:

T - the type of the owner, which must extend StoredObject

Parameters:

owner - the owner object for which the PasswordPolicy is to be retrieved; if null, a default PasswordPolicy is returned

Returns:

the PasswordPolicy associated with the owner's class, or a default PasswordPolicy if the owner is null

getForClass

public static <T extends StoredObject>
PasswordPolicy getForClass(Class<T> owner)

Retrieves the PasswordPolicy for the specified class.

Type Parameters:

T - The type parameter extending StoredObject.

Parameters:

owner - The class for which the PasswordPolicy is to be retrieved. If null, a default PasswordPolicy is returned.

Returns:

The PasswordPolicy associated with the specified class. If no policy is found, a default PasswordPolicy is returned.

generatePassword

public String generatePassword()

Generates a new password based on the current password policy.

Returns:

a string representing the generated password.