Package google.registry.request.auth

Record Class AuthSettings

java.lang.Object

java.lang.Record

google.registry.request.auth.AuthSettings

@Immutable
public record AuthSettings(com.google.common.collect.ImmutableList<AuthSettings.AuthMethod> methods, AuthSettings.AuthLevel minimumLevel, AuthSettings.UserPolicy userPolicy)
extends Record

Parameters used to configure the authenticator.

AuthSettings shouldn't be used directly, instead - use one of the predefined Auth enum values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthSettings.AuthLevel	Authentication level.
static enum	AuthSettings.AuthMethod	Available methods for authentication.
static enum	AuthSettings.UserPolicy	User authorization policy options.

Constructor Summary

Constructors

Constructor	Description
AuthSettings(com.google.common.collect.ImmutableList<AuthSettings.AuthMethod> methods, AuthSettings.AuthLevel minimumLevel, AuthSettings.UserPolicy userPolicy)	Creates an instance of a AuthSettings record class.

Method Summary

Modifier and Type	Method	Description
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.
com.google.common.collect.ImmutableList<AuthSettings.AuthMethod>	methods()	Returns the value of the methods record component.
AuthSettings.AuthLevel	minimumLevel()	Returns the value of the minimumLevel record component.
final String	toString()	Returns a string representation of this record class.
AuthSettings.UserPolicy	userPolicy()	Returns the value of the userPolicy record component.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthSettings

public AuthSettings(com.google.common.collect.ImmutableList<AuthSettings.AuthMethod> methods,
 AuthSettings.AuthLevel minimumLevel,
 AuthSettings.UserPolicy userPolicy)

Creates an instance of a AuthSettings record class.

Parameters:

methods - the value for the methods record component

minimumLevel - the value for the minimumLevel record component

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

methods

public com.google.common.collect.ImmutableList<AuthSettings.AuthMethod> methods()

Returns the value of the methods record component.

Returns:

the value of the methods record component

minimumLevel

public AuthSettings.AuthLevel minimumLevel()

Returns the value of the minimumLevel record component.

Returns:

the value of the minimumLevel record component

userPolicy

public AuthSettings.UserPolicy userPolicy()

Returns the value of the userPolicy record component.

Returns:

the value of the userPolicy record component