Package org.ametys.core.authentication

Class DefaultCredentialProviderModel

java.lang.Object

org.ametys.core.authentication.DefaultCredentialProviderModel

All Implemented Interfaces:

CredentialProviderModel

public class DefaultCredentialProviderModel
extends Object
implements CredentialProviderModel

Default implementation of CredentialProviderModel

Field Summary

Fields

Modifier and Type	Field	Description
private String	_color
private I18nizableText	_connectionLabel
private Class<CredentialProvider>	_cpClass
private Configuration	_cpConfig
private I18nizableText	_description
private String	_iconDecorator
private String	_iconGlyph
private String	_iconLarge
private String	_iconMedium
private String	_iconSmall
private String	_id
private I18nizableText	_label
private Map<String,? extends ItemCheckerDescriptor>	_parameterCheckers
private Map<String,? extends ElementDefinition>	_parameters
private String	_pluginName

Constructor Summary

Constructors

Constructor

Description

DefaultCredentialProviderModel(String id, Class<CredentialProvider> udClass, Configuration cpConfig, I18nizableText label, I18nizableText description, I18nizableText connectionLabel, String iconGlyph, String iconDecorator, String iconSmall, String iconMedium, String iconLarge, String color, Map<String,? extends ElementDefinition> parameters, Map<String,? extends ItemCheckerDescriptor> parameterCheckers, String pluginName)

Constructor

Method Summary

Modifier and Type	Method	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 ItemCheckerDescriptor>	getParameterCheckers()	Get the configuration parameter checkers
Map<String,? extends ElementDefinition>	getParameters()	Get the configuration parameters
String	getPluginName()	Returns the plugin name of declaration (for debug purpose)

Methods inherited from class java.lang.Object

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

Field Detail

_id

private String _id

_cpClass

private Class<CredentialProvider> _cpClass

_cpConfig

private Configuration _cpConfig

_label

private I18nizableText _label

_description

private I18nizableText _description

_connectionLabel

private I18nizableText _connectionLabel

_iconGlyph

private String _iconGlyph

_iconDecorator

private String _iconDecorator

_iconSmall

private String _iconSmall

_iconMedium

private String _iconMedium

_iconLarge

private String _iconLarge

_color

private String _color

_parameters

private Map<String,? extends ElementDefinition> _parameters

_parameterCheckers

private Map<String,? extends ItemCheckerDescriptor> _parameterCheckers

_pluginName

private String _pluginName

Constructor Detail

DefaultCredentialProviderModel

public DefaultCredentialProviderModel(String id,
                                      Class<CredentialProvider> udClass,
                                      Configuration cpConfig,
                                      I18nizableText label,
                                      I18nizableText description,
                                      I18nizableText connectionLabel,
                                      String iconGlyph,
                                      String iconDecorator,
                                      String iconSmall,
                                      String iconMedium,
                                      String iconLarge,
                                      String color,
                                      Map<String,? extends ElementDefinition> parameters,
                                      Map<String,? extends ItemCheckerDescriptor> parameterCheckers,
                                      String pluginName)

Constructor

Parameters:

id - The unique identifier of this credential provider model

udClass - The CredentialProvider class

cpConfig - Additional configuration for CredentialProvider class. Can be empty.

label - The i18n label

description - The i18n description

connectionLabel - The i18n label for the connection screen

iconGlyph - The CSS class for glyph icon

iconDecorator - The CSS class for glyph decorator icon

iconSmall - The path of the small icon resource

iconMedium - The path of the medium icon resource

iconLarge - The path of the large icon resource

color - The string representation of the color which will be used for the button in the connection screen

parameters - The parameters

parameterCheckers - the parameter checkers

pluginName - The plugin's name of declaration (for debug purpose)

Method Detail

getId

public String getId()

Description copied from interface: CredentialProviderModel

Get the id of this credential provider

Specified by:

getId in interface CredentialProviderModel

Returns:

the id of this credential provider

getLabel

public I18nizableText getLabel()

Description copied from interface: CredentialProviderModel

Get the label of the credential provider.

Specified by:

getLabel in interface CredentialProviderModel

Returns:

the label of the credential provider

getDescription

public I18nizableText getDescription()

Description copied from interface: CredentialProviderModel

Get the description text of the credential provider.

Specified by:

getDescription in interface CredentialProviderModel

Returns:

the description of the credential provider

getConnectionLabel

public I18nizableText getConnectionLabel()

Description copied from interface: CredentialProviderModel

Get the label for the connection screen of the credential provider

Specified by:

getConnectionLabel in interface CredentialProviderModel

Returns:

the label for the connection screen of the credential provider

getIconGlyph

public String getIconGlyph()

Description copied from interface: CredentialProviderModel

Get the CSS class for the glyph icon

Specified by:

getIconGlyph in interface CredentialProviderModel

Returns:

the CSS class for the glyph icon

getIconDecorator

public String getIconDecorator()

Description copied from interface: CredentialProviderModel

Get the CSS class for the glyph decorator icon

Specified by:

getIconDecorator in interface CredentialProviderModel

Returns:

the CSS class for the glyph decorator icon

getIconSmall

public String getIconSmall()

Description copied from interface: CredentialProviderModel

Get the path of the small icon resource

Specified by:

getIconSmall in interface CredentialProviderModel

Returns:

the path of the small icon resource

getIconMedium

public String getIconMedium()

Description copied from interface: CredentialProviderModel

Get the path of the small icon resource

Specified by:

getIconMedium in interface CredentialProviderModel

Returns:

the path of the small icon resource

getIconLarge

public String getIconLarge()

Description copied from interface: CredentialProviderModel

Get the path of the small icon resource

Specified by:

getIconLarge in interface CredentialProviderModel

Returns:

the path of the small icon resource

getColor

public String getColor()

Description copied from interface: CredentialProviderModel

Get the color of the credential provider

Specified by:

getColor in interface CredentialProviderModel

Returns:

the color of the credential provider

getParameters

public Map<String,? extends ElementDefinition> getParameters()

Description copied from interface: CredentialProviderModel

Get the configuration parameters

Specified by:

getParameters in interface CredentialProviderModel

Returns:

The configuration parameters

getParameterCheckers

public Map<String,? extends ItemCheckerDescriptor> getParameterCheckers()

Description copied from interface: CredentialProviderModel

Get the configuration parameter checkers

Specified by:

getParameterCheckers in interface CredentialProviderModel

Returns:

The configuration parameter checkers

getPluginName

public String getPluginName()

Description copied from interface: CredentialProviderModel

Returns the plugin name of declaration (for debug purpose)

Specified by:

getPluginName in interface CredentialProviderModel

Returns:

the plugin name

getCredentialProviderClass

public Class<CredentialProvider> getCredentialProviderClass()

Description copied from interface: CredentialProviderModel

Get the credential provider class

Specified by:

getCredentialProviderClass in interface CredentialProviderModel

Returns:

the credential provider class

getCredentialProviderConfiguration

public Configuration getCredentialProviderConfiguration()

Description copied from interface: CredentialProviderModel

Get the additional configuration for the implementation of CredentialProvider

Specified by:

getCredentialProviderConfiguration in interface CredentialProviderModel

Returns:

the additional configuration.