Package de.xima.fc.interfaces.auth

Interface IClientDescriptor

All Superinterfaces:
Serializable
public interface IClientDescriptor extends Serializable
Common interface describing an authentication client. Client descriptors are used for creating security clients used for authentication & authorization. Implementations must implement hashCode() & equals(Object).
Since:
8.0.0
Author:
XIMA Media GmbH

  • Method Details

    • getType

      @NotNull @NotNull EAuthClientType getType()
      Returns:
      the authenticator / client type.

    • getAuthenticator

      @Nullable IAuthenticator<?> getAuthenticator()
      Returns the authenticator entity of the client that provides the properties for the client. Not all clients need an authenticator to be defined. See EAuthClientType.isNeedsAuthenticatorEntity() which clients require an entity authenticator.
      Returns:
      the entity authenticator that provides the properties of the client.

    • getParameters

      Map<String,Serializable> getParameters()
      Returns:
      Additional parameters that may be required to define a client.

    • getClientIdentifier

      default String getClientIdentifier()
      A String identifying this client within its scope. Should always be used in conjunction with its scope!
      Returns:
      the identifier of the client.

    • getClientScope

      default String getClientScope()
      A string representing the scope of the client. ClientAuthenticators have the FC client UUID as scope and SystemAuthenticators and type authenticators have SYSTEM as scope.
      Returns:
      scope of the client.

    • getClientName

      default String getClientName()
      Returns the name of the client which is the callback UUID of the entity authenticator or the name of the type authenticator.
      Returns:
      the name of the client.

    • getDisplayName

      default String getDisplayName(Locale locale)
      Parameters:
      locale - to determine the display name for.
      Returns:
      The display name of the client for the given locale.

    • getI18nAuthBtnTextPlaceholder

      default String getI18nAuthBtnTextPlaceholder()
      Returns:
      the I18N variable placeholder that will be used for the label of the authentication button.