Package org.ametys.core.user.directory

Class DefaultUserDirectoryModel

java.lang.Object

org.ametys.core.user.directory.DefaultUserDirectoryModel

All Implemented Interfaces:

UserDirectoryModel

public class DefaultUserDirectoryModel
extends Object
implements UserDirectoryModel

Default implementation of UserDirectoryModel

Field Summary

Fields

Modifier and Type	Field	Description
private I18nizableText	_description
private String	_id
private I18nizableText	_label
private Map<String,? extends ItemCheckerDescriptor>	_parameterCheckers
private Map<String,? extends ElementDefinition>	_parameters
private String	_pluginName
private Class<UserDirectory>	_udClass
private Configuration	_udConfig

Constructor Summary

Constructors

Constructor	Description
DefaultUserDirectoryModel(String id, Class<UserDirectory> udClass, Configuration udConfig, I18nizableText label, I18nizableText description, Map<String,? extends ElementDefinition> parameters, Map<String,? extends ItemCheckerDescriptor> parameterCheckers, String pluginName)	Constructor

Method Summary

Modifier and Type	Method	Description
I18nizableText	getDescription()	Get the description text of the directory.
String	getId()	Get the id of this user directory
I18nizableText	getLabel()	Get the label of the directory.
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)
Class<UserDirectory>	getUserDirectoryClass()	Get the user directory class
Configuration	getUserDirectoryConfiguration()	Get the additional configuration for the implementation of UserDirectory

Methods inherited from class java.lang.Object

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

Field Detail

_id

private String _id

_udClass

private Class<UserDirectory> _udClass

_udConfig

private Configuration _udConfig

_label

private I18nizableText _label

_description

private I18nizableText _description

_parameters

private Map<String,? extends ElementDefinition> _parameters

_parameterCheckers

private Map<String,? extends ItemCheckerDescriptor> _parameterCheckers

_pluginName

private String _pluginName

Constructor Detail

DefaultUserDirectoryModel

public DefaultUserDirectoryModel(String id,
                                 Class<UserDirectory> udClass,
                                 Configuration udConfig,
                                 I18nizableText label,
                                 I18nizableText description,
                                 Map<String,? extends ElementDefinition> parameters,
                                 Map<String,? extends ItemCheckerDescriptor> parameterCheckers,
                                 String pluginName)

Constructor

Parameters:

id - The unique identifier of this user directory model

udClass - The UserDirectory class

udConfig - Additional configuration for UserDirectory class. Can be empty.

label - The i18n label

description - The i18n description

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: UserDirectoryModel

Get the id of this user directory

Specified by:

getId in interface UserDirectoryModel

Returns:

the id of this user directory

getLabel

public I18nizableText getLabel()

Description copied from interface: UserDirectoryModel

Get the label of the directory.

Specified by:

getLabel in interface UserDirectoryModel

Returns:

the label of the directory

getDescription

public I18nizableText getDescription()

Description copied from interface: UserDirectoryModel

Get the description text of the directory.

Specified by:

getDescription in interface UserDirectoryModel

Returns:

the description of the directory

getParameters

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

Description copied from interface: UserDirectoryModel

Get the configuration parameters

Specified by:

getParameters in interface UserDirectoryModel

Returns:

The configuration parameters

getParameterCheckers

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

Description copied from interface: UserDirectoryModel

Get the configuration parameter checkers

Specified by:

getParameterCheckers in interface UserDirectoryModel

Returns:

The configuration parameter checkers

getPluginName

public String getPluginName()

Description copied from interface: UserDirectoryModel

Returns the plugin name of declaration (for debug purpose)

Specified by:

getPluginName in interface UserDirectoryModel

Returns:

the plugin name

getUserDirectoryClass

public Class<UserDirectory> getUserDirectoryClass()

Description copied from interface: UserDirectoryModel

Get the user directory class

Specified by:

getUserDirectoryClass in interface UserDirectoryModel

Returns:

the user directory class

getUserDirectoryConfiguration

public Configuration getUserDirectoryConfiguration()

Description copied from interface: UserDirectoryModel

Get the additional configuration for the implementation of UserDirectory

Specified by:

getUserDirectoryConfiguration in interface UserDirectoryModel

Returns:

the additional configuration.