Package com.inet.authentication

Class AuthenticationDescription

java.lang.Object
com.inet.authentication.AuthenticationDescription
public class AuthenticationDescription extends Object
The description of a authentication method.
Since:
inetcore 4.0

  • Field Details

    • PROVIDER

      public static final String PROVIDER
      The authentication settings property name for the name of the provider.
      See Also:

    • DISPLAYNAME

      public static final String DISPLAYNAME
      The authentication settings property name for the display name in the GUI.
      See Also:

    • DISPLAYNAME_DETAILS

      public static final String DISPLAYNAME_DETAILS
      The authentication settings property name for the display details in the GUI.
      See Also:

    • COLOR

      public static final String COLOR
      The authentication settings property name for the color in the GUI.
      See Also:

    • PROVIDER_SYSTEM

      public static final String PROVIDER_SYSTEM
      Value of provider property for the one system provider.
      See Also:

    • PROVIDER_PRODUCT

      public static final String PROVIDER_PRODUCT
      Value of provider property for the one product provider.
      See Also:

    • SYSTEM_PROVIDER_ACTION

      public static final String SYSTEM_PROVIDER_ACTION
      Category and group for the config structure provider for the system authentication provider.
      See Also:

    • SYSTEM_LOGINTYPE

      public static final String SYSTEM_LOGINTYPE
      The authentication settings property name for the real provider for the "system" provider.
      See Also:

    • USER_CAN_REGISTER

      public static final String USER_CAN_REGISTER
      The authentication settings property name for the product provider for the flag if a user can register.
      See Also:

    • PASSWORD_MINIMUM_LENGTH

      public static final String PASSWORD_MINIMUM_LENGTH
      The minimum length of the password that has to be set for users created in the product provider
      See Also:

    • PASSWORD_MINIMUM_STRENGTH

      public static final String PASSWORD_MINIMUM_STRENGTH
      The minimum strength of the password that has to be set for users created in the product provider
      See Also:

    • PASSWORD_MINIMUM_STRENGTH_VALUES

      public static final String[] PASSWORD_MINIMUM_STRENGTH_VALUES
      The allowed values for the password strength

  • Constructor Details

    • AuthenticationDescription

      public AuthenticationDescription(@Nonnull @Nonnull AuthenticationProvider provider, @Nonnull @Nonnull Map<String,String> settings, @Nonnull @Nonnull String name, @Nonnull @Nonnull AuthenticationDescription.BasicSupport basicSupport)
      Create a description of the authentication method.
      Parameters:
      provider - the creating provider
      settings - the settings in the configuration manager
      name - the unique name
      basicSupport - the type of basic support
      Since:
      inetcore 4.0

  • Method Details

    • getProvider

      @Nonnull public @Nonnull AuthenticationProvider getProvider()
      Get the provider that has generate this description.
      Returns:
      the provider
      Since:
      inetcore 4.0

    • getSettings

      @Nonnull public @Nonnull Map<String,String> getSettings()
      Get all the settings in the configuration manager.
      Returns:
      the settings
      Since:
      inetcore 4.0

    • getName

      @Nonnull public @Nonnull String getName()
      The unique name of the authentication.
      Returns:
      the name
      Since:
      inetcore 4.0

    • getDisplayName

      public String getDisplayName()
      Get the display name for this authentication method.
      Returns:
      the name
      Since:
      inetcore 4.0

    • getColor

      public String getColor()
      Get the color as hex value, e.g. "#ff00ee"
      Returns:
      the color
      Since:
      inetcore 4.0

    • getIconURL

      public URL getIconURL()
      Get the Icon resource URL for displaying in the user ui.
      Returns:
      the url
      Since:
      inetcore 4.0

    • getBasicSupport

      @Nonnull public @Nonnull AuthenticationDescription.BasicSupport getBasicSupport()
      If this authentication supports basic authentication.
      Returns:
      the BasicSupport
      Since:
      inetcore 4.0

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable @Nullable Object obj)
      Overrides:
      equals in class Object