Package com.inet.authentication

Class AuthenticationDescription

java.lang.Object

com.inet.authentication.AuthenticationDescription

public class AuthenticationDescription
extends java.lang.Object

The description of a authentication method.

Since:

inetcore 4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticationDescription.BasicSupport	Support types for Basic authentication

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COLOR	The authentication settings property name for the color in the GUI.
static java.lang.String	DISPLAYNAME	The authentication settings property name for the display name in the GUI.
static java.lang.String	DISPLAYNAME_DETAILS	The authentication settings property name for the display details in the GUI.
static java.lang.String	PASSWORD_MINIMUM_LENGTH	The minimum length of the password that has to be set for users created in the product provider
static java.lang.String	PASSWORD_MINIMUM_STRENGTH	The minimum strength of the password that has to be set for users created in the product provider
static java.lang.String[]	PASSWORD_MINIMUM_STRENGTH_VALUES	The allowed values for the password strength
static java.lang.String	PROVIDER	The authentication settings property name for the name of the provider.
static java.lang.String	PROVIDER_PRODUCT	Value of provider property for the one product provider.
static java.lang.String	PROVIDER_SYSTEM	Value of provider property for the one system provider.
static java.lang.String	SYSTEM_LOGINTYPE	The authentication settings property name for the real provider for the "system" provider.
static java.lang.String	SYSTEM_PROVIDER_ACTION	Category and group for the config structure provider for the system authentication provider.
static java.lang.String	USER_CAN_REGISTER	The authentication settings property name for the product provider for the flag if a user can register.

Constructor Summary

Constructors

Constructor	Description
AuthenticationDescription(AuthenticationProvider provider, java.util.Map<java.lang.String,java.lang.String> settings, java.lang.String name, AuthenticationDescription.BasicSupport basicSupport)	Create a description of the authentication method.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
AuthenticationDescription.BasicSupport	getBasicSupport()	If this authentication supports basic authentication.
java.lang.String	getColor()	Get the color as hex value, e.g.
java.lang.String	getDisplayName()	Get the display name for this authentication method.
java.net.URL	getIconURL()	Get the Icon resource URL for displaying in the user ui.
java.lang.String	getName()	The unique name of the authentication.
AuthenticationProvider	getProvider()	Get the provider that has generate this description.
java.util.Map<java.lang.String,java.lang.String>	getSettings()	Get all the settings in the configuration manager.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

PROVIDER

public static final java.lang.String PROVIDER

The authentication settings property name for the name of the provider.

See Also:

Constant Field Values

DISPLAYNAME

public static final java.lang.String DISPLAYNAME

The authentication settings property name for the display name in the GUI.

See Also:

Constant Field Values

DISPLAYNAME_DETAILS

public static final java.lang.String DISPLAYNAME_DETAILS

The authentication settings property name for the display details in the GUI.

See Also:

Constant Field Values

COLOR

public static final java.lang.String COLOR

The authentication settings property name for the color in the GUI.

See Also:

Constant Field Values

PROVIDER_SYSTEM

public static final java.lang.String PROVIDER_SYSTEM

Value of provider property for the one system provider.

See Also:

Constant Field Values

PROVIDER_PRODUCT

public static final java.lang.String PROVIDER_PRODUCT

Value of provider property for the one product provider.

See Also:

Constant Field Values

SYSTEM_PROVIDER_ACTION

public static final java.lang.String SYSTEM_PROVIDER_ACTION

Category and group for the config structure provider for the system authentication provider.

See Also:

Constant Field Values

SYSTEM_LOGINTYPE

public static final java.lang.String SYSTEM_LOGINTYPE

The authentication settings property name for the real provider for the "system" provider.

See Also:

Constant Field Values

USER_CAN_REGISTER

public static final java.lang.String USER_CAN_REGISTER

The authentication settings property name for the product provider for the flag if a user can register.

See Also:

Constant Field Values

PASSWORD_MINIMUM_LENGTH

public static final java.lang.String PASSWORD_MINIMUM_LENGTH

The minimum length of the password that has to be set for users created in the product provider

See Also:

Constant Field Values

PASSWORD_MINIMUM_STRENGTH

public static final java.lang.String PASSWORD_MINIMUM_STRENGTH

The minimum strength of the password that has to be set for users created in the product provider

See Also:

Constant Field Values

PASSWORD_MINIMUM_STRENGTH_VALUES

public static final java.lang.String[] PASSWORD_MINIMUM_STRENGTH_VALUES

The allowed values for the password strength

Constructor Detail

AuthenticationDescription

public AuthenticationDescription(@Nonnull
                                 AuthenticationProvider provider,
                                 @Nonnull
                                 java.util.Map<java.lang.String,java.lang.String> settings,
                                 @Nonnull
                                 java.lang.String name,
                                 @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 Detail

getProvider

@Nonnull
public AuthenticationProvider getProvider()

Get the provider that has generate this description.

Returns:

the provider

Since:

inetcore 4.0

getSettings

@Nonnull
public java.util.Map<java.lang.String,java.lang.String> getSettings()

Get all the settings in the configuration manager.

Returns:

the settings

Since:

inetcore 4.0

getName

public java.lang.String getName()

The unique name of the authentication.

Returns:

the name

Since:

inetcore 4.0

getDisplayName

public java.lang.String getDisplayName()

Get the display name for this authentication method.

Returns:

the name

Since:

inetcore 4.0

getColor

public java.lang.String getColor()

Get the color as hex value, e.g. "#ff00ee"

Returns:

the color

Since:

inetcore 4.0

getIconURL

public java.net.URL getIconURL()

Get the Icon resource URL for displaying in the user ui.

Returns:

the url

Since:

inetcore 4.0

getBasicSupport

public AuthenticationDescription.BasicSupport getBasicSupport()

If this authentication supports basic authentication.

Returns:

the BasicSupport

Since:

inetcore 4.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object