Package com.inet.authentication
Class AuthenticationDescription
java.lang.Object
com.inet.authentication.AuthenticationDescription
The description of a authentication method.
- Since:
- inetcore 4.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Support types for Basic authentication -
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The authentication settings property name for the color in the GUI.static final String
The authentication settings property name for the display name in the GUI.static final String
The authentication settings property name for the display details in the GUI.static final String
The minimum length of the password that has to be set for users created in the product providerstatic final String
The minimum strength of the password that has to be set for users created in the product providerstatic final String[]
The allowed values for the password strengthstatic final String
The authentication settings property name for the name of the provider.static final String
Value of provider property for the one product provider.static final String
Value of provider property for the one system provider.static final String
The authentication settings property name for the real provider for the "system" provider.static final String
Category and group for the config structure provider for the system authentication provider.static final String
The authentication settings property name for the product provider for the flag if a user can register. -
Constructor Summary
ConstructorDescriptionAuthenticationDescription
(@Nonnull AuthenticationProvider provider, @Nonnull Map<String, String> settings, @Nonnull String name, @Nonnull AuthenticationDescription.BasicSupport basicSupport) Create a description of the authentication method. -
Method Summary
Modifier and TypeMethodDescriptionboolean
If this authentication supports basic authentication.getColor()
Get the color as hex value, e.g.Get the display name for this authentication method.Get the Icon resource URL for displaying in the user ui.@Nonnull String
getName()
The unique name of the authentication.@Nonnull AuthenticationProvider
Get the provider that has generate this description.Get all the settings in the configuration manager.int
hashCode()
-
Field Details
-
PROVIDER
The authentication settings property name for the name of the provider.- See Also:
-
DISPLAYNAME
The authentication settings property name for the display name in the GUI.- See Also:
-
DISPLAYNAME_DETAILS
The authentication settings property name for the display details in the GUI.- See Also:
-
COLOR
The authentication settings property name for the color in the GUI.- See Also:
-
PROVIDER_SYSTEM
Value of provider property for the one system provider.- See Also:
-
PROVIDER_PRODUCT
Value of provider property for the one product provider.- See Also:
-
SYSTEM_PROVIDER_ACTION
Category and group for the config structure provider for the system authentication provider.- See Also:
-
SYSTEM_LOGINTYPE
The authentication settings property name for the real provider for the "system" provider.- See Also:
-
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
The minimum length of the password that has to be set for users created in the product provider- See Also:
-
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
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 providersettings
- the settings in the configuration managername
- the unique namebasicSupport
- the type of basic support- Since:
- inetcore 4.0
-
-
Method Details
-
getProvider
Get the provider that has generate this description.- Returns:
- the provider
- Since:
- inetcore 4.0
-
getSettings
Get all the settings in the configuration manager.- Returns:
- the settings
- Since:
- inetcore 4.0
-
getName
The unique name of the authentication.- Returns:
- the name
- Since:
- inetcore 4.0
-
getDisplayName
Get the display name for this authentication method.- Returns:
- the name
- Since:
- inetcore 4.0
-
getColor
Get the color as hex value, e.g. "#ff00ee"- Returns:
- the color
- Since:
- inetcore 4.0
-
getIconURL
Get the Icon resource URL for displaying in the user ui.- Returns:
- the url
- Since:
- inetcore 4.0
-
getBasicSupport
If this authentication supports basic authentication.- Returns:
- the BasicSupport
- Since:
- inetcore 4.0
-
hashCode
public int hashCode() -
equals
-