Record Class SecurityPrincipal

java.lang.Object

java.lang.Record

zeroecho.pki.server.SecurityPrincipal

Record Components:

principalId - canonical stable principal identity

type - closed principal type

displayName - safe administrative display label

organization - optional canonical owner/organization relationship

attributes - finite safe relationship attributes

enabled - whether authorization assignments may be considered

public record SecurityPrincipal(String principalId, SecurityPrincipal.Type type, String displayName, Optional<String> organization, Map<String,String> attributes, boolean enabled)
extends Record

Transport-independent authenticated-identity target used by authorization. Authentication credentials and secrets are deliberately excluded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SecurityPrincipal.Type	Closed principal types.

Constructor Summary

Constructors

Constructor	Description
SecurityPrincipal(String principalId, SecurityPrincipal.Type type, String displayName, Optional<String> organization, Map<String,String> attributes, boolean enabled)	Validates and snapshots finite safe principal metadata.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
String	displayName()	Returns the value of the displayName record component.
boolean	enabled()	Returns the value of the enabled 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.
Optional<String>	organization()	Returns the value of the organization record component.
String	principalId()	Returns the value of the principalId record component.
final String	toString()	Returns a string representation of this record class.
SecurityPrincipal.Type	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

SecurityPrincipal

public SecurityPrincipal(String principalId,
 SecurityPrincipal.Type type,
 String displayName,
 Optional<String> organization,
 Map<String,String> attributes,
 boolean enabled)

Validates and snapshots finite safe principal metadata.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

principalId

public String principalId()

Returns the value of the principalId record component.

Returns:

the value of the principalId record component

type

public SecurityPrincipal.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

organization

public Optional<String> organization()

Returns the value of the organization record component.

Returns:

the value of the organization record component

attributes

public Map<String,String> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

enabled

public boolean enabled()

Returns the value of the enabled record component.

Returns:

the value of the enabled record component