Record Class PkiServerAuthenticationResult.Rejected

java.lang.Object

java.lang.Record

zeroecho.pki.server.spi.PkiServerAuthenticationResult.Rejected

Record Components:

mode - administrative authentication topology

transportPrincipalId - trusted proxy principal when resolved

endClientPrincipalId - end-client principal when safely resolved

code - stable non-disclosing rejection code

All Implemented Interfaces:

PkiServerAuthenticationResult

Enclosing interface:

PkiServerAuthenticationResult

public static record PkiServerAuthenticationResult.Rejected(AdministrativeAuthenticationMode mode, Optional<String> transportPrincipalId, Optional<String> endClientPrincipalId, PkiServerAuthenticationResult.Code code)
extends Record
implements PkiServerAuthenticationResult

Authentication rejection containing only a stable safe code.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface PkiServerAuthenticationResult

PkiServerAuthenticationResult.Authenticated, PkiServerAuthenticationResult.Code, PkiServerAuthenticationResult.Rejected

Constructor Summary

Constructors

Constructor	Description
Rejected(AdministrativeAuthenticationMode mode, Optional<String> transportPrincipalId, Optional<String> endClientPrincipalId, PkiServerAuthenticationResult.Code code)	Validates the rejection.
Rejected(PkiServerAuthenticationResult.Code code)	Creates a direct-mode rejection without resolved identity metadata.

Method Summary

Modifier and Type	Method	Description
PkiServerAuthenticationResult.Code	code()	Returns the value of the code record component.
Optional<String>	endClientPrincipalId()	Returns the value of the endClientPrincipalId 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.
AdministrativeAuthenticationMode	mode()	Returns the value of the mode record component.
final String	toString()	Returns a string representation of this record class.
Optional<String>	transportPrincipalId()	Returns the value of the transportPrincipalId record component.

Methods inherited from class Object

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

Methods inherited from interface PkiServerAuthenticationResult

resolvedPrincipalId

Constructor Details

Rejected

public Rejected(AdministrativeAuthenticationMode mode,
 Optional<String> transportPrincipalId,
 Optional<String> endClientPrincipalId,
 PkiServerAuthenticationResult.Code code)

Validates the rejection.

Rejected

public Rejected(PkiServerAuthenticationResult.Code code)

Creates a direct-mode rejection without resolved identity metadata.

Parameters:

code - stable non-disclosing rejection code

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.

mode

public AdministrativeAuthenticationMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

transportPrincipalId

public Optional<String> transportPrincipalId()

Returns the value of the transportPrincipalId record component.

Returns:

the value of the transportPrincipalId record component

endClientPrincipalId

public Optional<String> endClientPrincipalId()

Returns the value of the endClientPrincipalId record component.

Returns:

the value of the endClientPrincipalId record component

code

public PkiServerAuthenticationResult.Code code()

Returns the value of the code record component.

Returns:

the value of the code record component