org.ametys.core.authentication

Interface CredentialProviderModel

All Known Implementing Classes:

DefaultCredentialProviderModel

public interface CredentialProviderModel

This class representes a model for a CredentialProvider

Method Summary

Modifier and Type	Method and Description
String	getColor() Get the color of the credential provider
I18nizableText	getConnectionLabel() Get the label for the connection screen of the credential provider
Class<CredentialProvider>	getCredentialProviderClass() Get the credential provider class
Configuration	getCredentialProviderConfiguration() Get the additional configuration for the implementation of CredentialProvider
I18nizableText	getDescription() Get the description text of the credential provider.
String	getIconDecorator() Get the CSS class for the glyph decorator icon
String	getIconGlyph() Get the CSS class for the glyph icon
String	getIconLarge() Get the path of the small icon resource
String	getIconMedium() Get the path of the small icon resource
String	getIconSmall() Get the path of the small icon resource
String	getId() Get the id of this credential provider
I18nizableText	getLabel() Get the label of the credential provider.
Map<String,? extends ParameterCheckerDescriptor>	getParameterCheckers() Get the configuration parameter checkers
Map<String,? extends Parameter<ParameterHelper.ParameterType>>	getParameters() Get the configuration parameters
String	getPluginName() Returns the plugin name of declaration (for debug purpose)

Method Detail

getId

String getId()

Get the id of this credential provider

Returns:

the id of this credential provider

getLabel

I18nizableText getLabel()

Get the label of the credential provider.

Returns:

the label of the credential provider

getDescription

I18nizableText getDescription()

Get the description text of the credential provider.

Returns:

the description of the credential provider

getConnectionLabel

I18nizableText getConnectionLabel()

Get the label for the connection screen of the credential provider

Returns:

the label for the connection screen of the credential provider

getIconGlyph

String getIconGlyph()

Get the CSS class for the glyph icon

Returns:

the CSS class for the glyph icon

getIconDecorator

String getIconDecorator()

Get the CSS class for the glyph decorator icon

Returns:

the CSS class for the glyph decorator icon

getIconSmall

String getIconSmall()

Get the path of the small icon resource

Returns:

the path of the small icon resource

getIconMedium

String getIconMedium()

Get the path of the small icon resource

Returns:

the path of the small icon resource

getIconLarge

String getIconLarge()

Get the path of the small icon resource

Returns:

the path of the small icon resource

getColor

String getColor()

Get the color of the credential provider

Returns:

the color of the credential provider

getParameters

Map<String,? extends Parameter<ParameterHelper.ParameterType>> getParameters()

Get the configuration parameters

Returns:

The configuration parameters

getParameterCheckers

Map<String,? extends ParameterCheckerDescriptor> getParameterCheckers()

Get the configuration parameter checkers

Returns:

The configuration parameter checkers

getPluginName

String getPluginName()

Returns the plugin name of declaration (for debug purpose)

Returns:

the plugin name

getCredentialProviderClass

Class<CredentialProvider> getCredentialProviderClass()

Get the credential provider class

Returns:

the credential provider class

getCredentialProviderConfiguration

Configuration getCredentialProviderConfiguration()

Get the additional configuration for the implementation of CredentialProvider

Returns:

the additional configuration.