Package com.thalesgroup.gemalto.fido2.client

Class AuthenticatorDescriptor

java.lang.Object

com.thalesgroup.gemalto.fido2.client.AuthenticatorDescriptor

public class AuthenticatorDescriptor
extends Object

A descriptor that provides a custom friendly name for an authenticator.

This is used to provide a more user-friendly name for an authenticator during FIDO2 operations, which can be displayed in the UI.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
AuthenticatorDescriptor(String friendlyName)	Creates a new authenticator descriptor with a friendly name.

Method Summary

Modifier and Type	Method	Description
String	getFriendlyName()	Gets the friendly name of the authenticator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthenticatorDescriptor

public AuthenticatorDescriptor(@NonNull
 String friendlyName)

Creates a new authenticator descriptor with a friendly name.

If the provided name exceeds 128 characters, it will be truncated.

Parameters:

friendlyName - The user-friendly name for the authenticator. Must not be null.

Throws:

IllegalArgumentException - if friendlyName is null.

Since:

1.0.0

Method Details

getFriendlyName

public String getFriendlyName()

Gets the friendly name of the authenticator.

Returns:

The friendly name.

Since:

1.0.0