Record Class Principal

java.lang.Object

java.lang.Record

org.j7m.middleware.security.api.Principal

Record Components:

id - stable principal id

displayName - safe display name

roles - role names

tags - public caller tags

All Implemented Interfaces:

Serializable

public record Principal(String id, String displayName, Set<String> roles, Set<String> tags)
extends Record
implements Serializable

Immutable authenticated or anonymous caller principal.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Principal(String id, String displayName, Set<String> roles, Set<String> tags)	Creates immutable principal fields.

Method Summary

Modifier and Type	Method	Description
static Principal	anonymous()	Returns an anonymous principal.
String	displayName()	Returns the value of the displayName 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.
String	id()	Returns the value of the id record component.
Set<String>	roles()	Returns the value of the roles record component.
static Principal	runtime(String runtimeId)	Returns a system principal.
Set<String>	tags()	Returns the value of the tags record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Principal

public Principal(String id,
 String displayName,
 Set<String> roles,
 Set<String> tags)

Creates immutable principal fields.

Method Details

anonymous

public static Principal anonymous()

Returns an anonymous principal.

Returns:

anonymous principal

runtime

public static Principal runtime(String runtimeId)

Returns a system principal.

Parameters:

runtimeId - runtime id

Returns:

system principal

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.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

roles

public Set<String> roles()

Returns the value of the roles record component.

Returns:

the value of the roles record component

tags

public Set<String> tags()

Returns the value of the tags record component.

Returns:

the value of the tags record component