Package dev.relism.flash.ext.security.apikey

Record Class ApiKeyPrincipal<G>

java.lang.Object

java.lang.Record

dev.relism.flash.ext.security.apikey.ApiKeyPrincipal<G>

All Implemented Interfaces:

dev.relism.flash.ext.security.Principal

public record ApiKeyPrincipal<G>(String name, G grant)
extends Record
implements dev.relism.flash.ext.security.Principal

A caller authenticated by an API key, carrying the grant the key was issued with.

Constructor Summary

Constructors

Constructor	Description
ApiKeyPrincipal(String name, G grant)	Creates an instance of a ApiKeyPrincipal record class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.relism.flash.ext.security.Principal

hasAudience, hasScope, logoutUrl

Constructor Details

ApiKeyPrincipal

public ApiKeyPrincipal(String name,
 G grant)

Creates an instance of a ApiKeyPrincipal record class.

Parameters:

name - the value for the name record component

grant - the value for the grant 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.

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface dev.relism.flash.ext.security.Principal

Returns:

the value of the name record component

grant

public G grant()

Returns the value of the grant record component.

Returns:

the value of the grant record component