Record Class PasswordChangeCommand

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.credential.change.PasswordChangeCommand

Record Components:

username - the user whose credential is being changed

currentPassword - the present-day password — required for the explicit re-authentication step (CWE-620)

newPassword - the proposed new password

public record PasswordChangeCommand(String username, SecretValue currentPassword, SecretValue newPassword)
extends Record

Input to PasswordChangeService.change(PasswordChangeCommand).

The two SecretValues are owned by the caller and are not destroyed by the service. Wrap the call in a try-with-resources block when possible.

Constructor Summary

Constructors

Constructor	Description
PasswordChangeCommand(String username, SecretValue currentPassword, SecretValue newPassword)	Creates an instance of a PasswordChangeCommand record class.

Method Summary

Modifier and Type	Method	Description
SecretValue	currentPassword()	Returns the value of the currentPassword record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
SecretValue	newPassword()	Returns the value of the newPassword record component.
final String	toString()	Returns a string representation of this record class.
String	username()	Returns the value of the username record component.

Methods inherited from class Object

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

Constructor Details

PasswordChangeCommand

public PasswordChangeCommand(String username,
 SecretValue currentPassword,
 SecretValue newPassword)

Creates an instance of a PasswordChangeCommand record class.

Parameters:

username - the value for the username record component

currentPassword - the value for the currentPassword record component

newPassword - the value for the newPassword record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

currentPassword

public SecretValue currentPassword()

Returns the value of the currentPassword record component.

Returns:

the value of the currentPassword record component

newPassword

public SecretValue newPassword()

Returns the value of the newPassword record component.

Returns:

the value of the newPassword record component