Package de.xima.fc.mdl.enums

Enum EAuthClientType

    • Method Detail

      • values

        public static EAuthClientType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EAuthClientType c : EAuthClientType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EAuthClientType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getByName

        public static EAuthClientType getByName​(String name)
        Returns the authenticator type with the given name.
        Parameters:
        name - The name of the authenticator type to get.
        Returns:
        The authenticator type with the given name or null if no such authenticator type exists.

      • getDefaultRenderType

        public EAuthRenderType getDefaultRenderType()
        Returns the default render type for this authenticator type. The default render type determines how an authenticator of this type should be rendered.
        Returns:
        The default render type for this authenticator type.
        Since:
        8.2.0

      • isSystemAuthenticator

        @Deprecated
public boolean isSystemAuthenticator()
        Deprecated.
        Use isNeedsAuthenticatorEntity() instead to determine if the authenticator needs an authenticator entity.
        Returns whether this authenticator type is a "system authenticator". System authenticators are authenticators that are provided by the "system" and don't need an authenticator entity. This method is deprecated because of its ambiguous name. system authenticators in formcycle are a type of authenticator entity on the system level. Use isNeedsAuthenticatorEntity() instead.
        Returns:
        true if this authenticator type is a "system authenticator" and false otherwise.

      • isDirectAuthenticator

        public boolean isDirectAuthenticator()
        Returns whether this authenticator is capable of producing a direct authenticator.
        Returns:
        true if this authenticator is capable of producing a direct authenticator and false otherwise.

      • isNeedsAuthenticatorEntity

        public boolean isNeedsAuthenticatorEntity()
        Returns whether this authenticator type requires an authenticator entity to be created in order to be used.
        Returns:
        true if an authenticator entity is required and false otherwise.

      • isCanProvideDistinctUsers

        public boolean isCanProvideDistinctUsers()
        Returns whether authenticators of this type can provide distinct user, as in users that can be distinguished from one another (via an ID).
        Returns:
        true if authenticators of this type can provide distinct users and false otherwise.

      • getIconStyleClass

        public String getIconStyleClass()
        Returns the default style class of the icon for authenticators of this type. May be used when rendering the authenticator.
        Returns:
        The default style class of the icon

      • getName

        public String getName()
        Returns the name of this authenticator type. The name of authenticator types that don't need an authenticator entity is used as the client name.
        Returns:
        The name of this authenticator type.

      • getDisplayName

        public String getDisplayName​(Locale locale)
        Returns the display name of this authenticator type in the given locale.
        Specified by:
        getDisplayName in interface INamedUiElement
        Parameters:
        locale - The locale to get the display name for.
        Returns:
        The display name of this authenticator type in the given locale.