Plugin core

Version: Not specified

Description

This is the mandatory plugin included in runtime that comes with :

mandatory extensions points (users...),
default implementations,
screens for the administrator area,
helpers,
main database pool,
...

Configuration parameters summary

runtime.authentication.basic.realm	This parameter contains the realm name for basic authentication purposes
runtime.authentication.cas.authorizedProxy	This parameter contains the url of the authorized proxies for CAS
runtime.authentication.cas.serverUrl	This parameter contains the url to reach the CAS server
runtime.authentication.jcifs.clientDomain	This parameter contains the clien domain name.
runtime.authentication.jcifs.domainController	This parameter contains the ip of the domain controller
runtime.authentication.jcifs.netBios	This parameter contains the ip of the net bios server
runtime.authentication.jcifs.production	This parameter parametrize the JCIFs client in production mode or not determining which other parameters to take in account.
runtime.authentication.remote.realm	This parameter contains the realm name for remote authentication purposes
runtime.datasource.core.jdbc.driver	This parameter contains the jdbc driver class to load to connect the core database pool.
runtime.datasource.core.jdbc.passwd	This parameter contains the jdbc password to connect the core database pool.
runtime.datasource.core.jdbc.url	This parameter contains the jdbc url to connect the core database pool.
runtime.datasource.core.jdbc.user	This parameter contains the jdbc username to connect the core database pool.
runtime.datasource.core.ldap.adminDN	If the authMethod is not anonymous, this parameter contains the DN of the user to use to connect to the LDAP.
runtime.datasource.core.ldap.adminPasswd	If the authMethod is not anonymous, this parameter contains the password of the user to use to connect to the LDAP.
runtime.datasource.core.ldap.authMethod	This parameter determines if the connection to LDAP can be anonymous.
runtime.datasource.core.ldap.baseDN	This parameter contains the base of the DN to add to all search. May be empty if search have to be done in several branches.
runtime.datasource.core.ldap.baseUrl	This parameter contains the base url (protocol + server name + port) to connect to the core ldap connection.
runtime.datasource.core.ldap.useSSL	This parameter determines if the connection to the ldap server is secured or not. Depending on the JVM, the use of 'ldaps' in the protocol is not supported.
runtime.groups.ldap.description	When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the description (or readable name)
runtime.groups.ldap.filter	When groups are handled in the LDAP, this parameter contains the filter to find groups objects in the current DN.
runtime.groups.ldap.groupDN	When groups are handled in the LDAP, this parameter the DN to append to the base DN to guide to groups.
runtime.groups.ldap.id	When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the identifier
runtime.groups.ldap.member	When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the assocation with users. This attribute is multiple and will contain the login of users. A user can be part of several groups.
runtime.groups.ldap.memberof	When groups are handled in the LDAP, this parameter contains the name of the attribute on users objects (implying users to be handled in LDAP also) handling the reverse association to the groups. If this attribute is multiple a user can be part of several groups.
runtime.groups.ldap.scope	When groups are handled in the LDAP, this parameter determine where to look for groups objects in the current DN. In the current DN only (object) In the sub branch of current DN only (one) In the current DN and all sub branches (sub) - low perf
runtime.users.ldap.baseFilter	When users are handled in the LDAP, this parameter contains the filter to find users objects in the current DN.
runtime.users.ldap.emailAttr	When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the email
runtime.users.ldap.firstnameAttr	When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the firstname
runtime.users.ldap.lastnameAttr	When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the lastname
runtime.users.ldap.loginAttr	When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the login
runtime.users.ldap.peopleDN	When users are handled in the LDAP, this parameter contains the DN to append to the base DN to guide to users.
runtime.users.ldap.scope	When users are handled in the LDAP, this parameter determine where to look for users objects in the current DN. In the current DN only (object) In the sub branch of current DN only (one) In the current DN and all sub branches (sub) - low perf

Extension points summary

Single extension point

org.ametys.runtime.right.RightsManager
org.ametys.runtime.user.UsersManager
org.ametys.runtime.group.GroupsManager
org.ametys.runtime.exception.ExceptionHandler
org.ametys.runtime.authentication.CredentialsProvider
org.ametys.runtime.request.InitRequestHandler
org.ametys.runtime.plugins.core.administrator.version.VersionsHandler

Multiple extension point

org.ametys.runtime.ui.item.UIItemManager
org.ametys.runtime.authentication.AuthenticationManager
org.ametys.runtime.plugins.core.right.RightsExtensionPoint
org.apache.cocoon.components.modules.input.InputModuleSelector
org.apache.excalibur.source.SourceFactorySelector
org.apache.avalon.excalibur.datasource.DataSourceComponentSelector
org.ametys.runtime.cocoon.SitemapConfigurationExtensionPoint
org.ametys.runtime.plugins.core.sqlmap.SqlMapExtensionPoint

Features summary

runtime.core	This feature is a mandatory feature of the runtime defining basic tools
runtime.datasource.core	This feature defines the pool of connection to the database.
runtime.workspace.admin	This feature defines components needed by the workspace admin
runtime.admin	This feature defines screen that may be uses in the administrator area
runtime.users	This feature contains only the interaction for handling users
runtime.users.rights	This feature brings the rights needed to manage users
runtime.user.impl.static	This features defines the static implementation of users
runtime.user.impl.jdbc.core	This features defines the base jdbc implementation of users (based on core database pool)
runtime.user.impl.jdbc.modifiable.core	The same as runtime.user.impl.jdbc.core but where users can be modified through the API
runtime.user.impl.jdbc.credentialsaware.core	The same as runtime.user.impl.jdbc.core but where users can be authentified through the API
runtime.user.impl.jdbc.modifiablecredentialsaware.core	The same as runtime.user.impl.jdbc.core but where users can be modified and authentified through the API
runtime.user.impl.ldap	This features defines the base ldap implementation of users
runtime.user.impl.ldap.credentialsaware	The same as runtime.user.impl.ldap but where users can be authentified through the API
runtime.groups	This feature contains only the interaction for handling groups
runtime.groups.rights	This feature brings the rights needed to manage groups
runtime.groups.impl.empty	This features defines an 'empty' groups to avoid group handling.
runtime.groups.impl.jdbc	This features defines the base jdbc implementation of users (based on core database pool)
runtime.groups.impl.ldap.groupDriven	This features defines the base ldap implementation of groups where the group information is handle by the group object
runtime.groups.impl.ldap.usersDriven	This features defines the base ldap implementation of groups where the group information is handle by the user object
runtime.rights	This feature contains interactions to handle rights based on profiles
runtime.rights.rights	This feature declares rights for handling rights screens
runtime.rights.impl.basic	This feature declares the basic rights manager that always anwers OK
runtime.rights.impl.profil	This feature declares the profile based rights manager. This manager use the core database pool. A profile is a set of atomic rights.
runtime.rights.impl.hierarchicalProfil	The same as runtime.rights.impl.profil but where rights are inherited in contexts : having the right on '/foo' gives the right on '/foo/subfoo'
runtime.exception.impl.default	This feature has the default behavior on errors that display the embeded error pages.
runtime.authentication.impl.defined	This feature defines a simple credential provider as it always answer that 'anonymous' is connected
runtime.authentication.impl.basic	This feature defines the 'basic' credential provider (i.e. where the credential is requested to the user by the navigator - the incomming values are not trusted)
runtime.authentication.impl.remote	This feature defines the 'remote' credential provider (i.e. where the credential is automatically setted and trusted by environment in the REMOTE_USER variable)
runtime.authentication.impl.jcifs	This feature defines the windows NT credential provider. Use its extension to automatically get the login of the user connected on the NT domain : user is authenticated externally and trusted by the NT environment.
runtime.authentication.impl.cas	This feature defines the 'cas' credential provider (i.e. user is authenticated externally and trusted by a CAS Server)
runtime.authentication.impl.cas.gateway	The same as runtime.authentication.impl.cas but where CAS is configured to be used as a gateway : An already authenticated user is trusted but a new one can also connect ! To give the user the oppotunity to enter its credentials you will have to manually redirect to the CAS login page.
runtime.request.impl.default	The default request handler... doing nothing

Main configuration parameters detail

runtime.authentication.basic.realm

This parameter contains the realm name for basic authentication purposes

Konwn uses:
runtime.authentication.impl.basic

Configuration:


<param id="runtime.authentication.basic.realm">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_BASIC_CONFIG_REALM_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_BASIC_CONFIG_REALM_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>Application domain name</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_BASIC</Group>


<Order>10</Order>

</param>

In the same category:
runtime.authentication.remote.realm, runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.authentication.cas.authorizedProxy

This parameter contains the url of the authorized proxies for CAS

Konwn uses:
runtime.authentication.impl.cas, runtime.authentication.impl.cas.gateway

Configuration:


<param id="runtime.authentication.cas.authorizedProxy">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_CAS_CONFIG_AUTHORIZEDPROXY_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_CAS_CONFIG_AUTHORIZEDPROXY_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue/>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_CAS</Group>


<Order>20</Order>

</param>

In the same group:
runtime.authentication.cas.serverUrl

In the same category:
runtime.authentication.basic.realm, runtime.authentication.remote.realm, runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController

runtime.authentication.cas.serverUrl

This parameter contains the url to reach the CAS server

Konwn uses:
runtime.authentication.impl.cas, runtime.authentication.impl.cas.gateway

Configuration:


<param id="runtime.authentication.cas.serverUrl">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_CAS_CONFIG_URL_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_CAS_CONFIG_URL_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>https://servername</DefaultValue>


<Validation>

<mandatory/>


<regexp>^https://</regexp>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_CAS</Group>


<Order>10</Order>

</param>

In the same group:
runtime.authentication.cas.authorizedProxy

runtime.authentication.jcifs.clientDomain

This parameter contains the clien domain name.

Konwn uses:
runtime.authentication.impl.jcifs

Configuration:


<param id="runtime.authentication.jcifs.clientDomain">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_CLIENTDOMAIN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_CLIENTDOMAIN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue/>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_JCIFS</Group>


<Order>20</Order>

</param>

In the same group:
runtime.authentication.jcifs.production, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController

In the same category:
runtime.authentication.basic.realm, runtime.authentication.remote.realm, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.authentication.jcifs.domainController

This parameter contains the ip of the domain controller

Konwn uses:
runtime.authentication.impl.jcifs

Configuration:


<param id="runtime.authentication.jcifs.domainController">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_DOMAINCONTROLLER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_DOMAINCONTROLLER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue/>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_JCIFS</Group>


<Order>40</Order>

</param>

In the same group:
runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios

In the same category:
runtime.authentication.basic.realm, runtime.authentication.remote.realm, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.authentication.jcifs.netBios

This parameter contains the ip of the net bios server

Konwn uses:
runtime.authentication.impl.jcifs

Configuration:


<param id="runtime.authentication.jcifs.netBios">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_NETBIOS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_NETBIOS_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue/>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_JCIFS</Group>


<Order>30</Order>

</param>

In the same group:
runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.domainController

In the same category:
runtime.authentication.basic.realm, runtime.authentication.remote.realm, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.authentication.jcifs.production

This parameter parametrize the JCIFs client in production mode or not determining which other parameters to take in account.

Konwn uses:
runtime.authentication.impl.jcifs

Configuration:


<param id="runtime.authentication.jcifs.production">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_PRODUCTION_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_JCIFS_CONFIG_PRODUCTION_DESCRIPTION</DescriptionKey>


<Type>boolean</Type>


<DefaultValue>false</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_JCIFS</Group>


<Order>10</Order>

</param>

In the same group:
runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController

In the same category:
runtime.authentication.basic.realm, runtime.authentication.remote.realm, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.authentication.remote.realm

This parameter contains the realm name for remote authentication purposes

Konwn uses:
runtime.authentication.impl.remote, runtime.authentication.impl.jcifs

Configuration:


<param id="runtime.authentication.remote.realm">

<LabelKey>PLUGINS_CORE_AUTHENTICATION_REMOTE_CONFIG_REALM_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_AUTHENTICATION_REMOTE_CONFIG_REALM_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>Remote domain name</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_AUTHENTICATION_GROUP_REMOTE</Group>


<Order>10</Order>

</param>

In the same category:
runtime.authentication.basic.realm, runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController, runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

runtime.datasource.core.jdbc.driver

This parameter contains the jdbc driver class to load to connect the core database pool.

Konwn uses:
runtime.datasource.core

Configuration:


<param id="runtime.datasource.core.jdbc.driver">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_DRIVER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_DRIVER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>com.mysql.jdbc.Driver</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE_GROUP_CORE</Group>


<Order>10</Order>

</param>

In the same group:
runtime.datasource.core.jdbc.url, runtime.datasource.core.jdbc.user, runtime.datasource.core.jdbc.passwd

runtime.datasource.core.jdbc.passwd

This parameter contains the jdbc password to connect the core database pool.

Konwn uses:
runtime.datasource.core

Configuration:


<param id="runtime.datasource.core.jdbc.passwd">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_PASSWORD_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_PASSWORD_DESCRIPTION</DescriptionKey>


<Type>password</Type>


<DefaultValue>password</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE_GROUP_CORE</Group>


<Order>40</Order>

</param>

In the same group:
runtime.datasource.core.jdbc.driver, runtime.datasource.core.jdbc.url, runtime.datasource.core.jdbc.user

runtime.datasource.core.jdbc.url

This parameter contains the jdbc url to connect the core database pool.

Konwn uses:
runtime.datasource.core

Configuration:


<param id="runtime.datasource.core.jdbc.url">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_URL_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_URL_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>jdbc:mysql://servername/basename</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE_GROUP_CORE</Group>


<Order>20</Order>

</param>

In the same group:
runtime.datasource.core.jdbc.driver, runtime.datasource.core.jdbc.user, runtime.datasource.core.jdbc.passwd

runtime.datasource.core.jdbc.user

This parameter contains the jdbc username to connect the core database pool.

Konwn uses:
runtime.datasource.core

Configuration:


<param id="runtime.datasource.core.jdbc.user">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_USER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_USER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>username</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_JDBC_CATEGORY_DATASOURCE_GROUP_CORE</Group>


<Order>30</Order>

</param>

In the same group:
runtime.datasource.core.jdbc.driver, runtime.datasource.core.jdbc.url, runtime.datasource.core.jdbc.passwd

runtime.datasource.core.ldap.adminDN

If the authMethod is not anonymous, this parameter contains the DN of the user to use to connect to the LDAP.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.adminDN">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ADMINDN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_DATASOURCE_CORE_LDAP_LDAPUSER_CONFIG_ADMINDN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>cn=admin</DefaultValue>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>50</Order>

</param>

In the same group:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminPasswd

In the same category:
runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member, runtime.groups.ldap.memberof

runtime.datasource.core.ldap.adminPasswd

If the authMethod is not anonymous, this parameter contains the password of the user to use to connect to the LDAP.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.adminPasswd">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ADMINPASSWORD_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ADMINPASSWORD_DESCRIPTION</DescriptionKey>


<Type>password</Type>


<DefaultValue>password</DefaultValue>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>60</Order>

</param>

runtime.datasource.core.ldap.authMethod

This parameter determines if the connection to LDAP can be anonymous.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.authMethod">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_AUTH_METHOD_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_AUTH_METHOD_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>none</DefaultValue>


<Enumeration>

<none i18n="true">PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_AUTH_METHOD_ENUM_NONE</none>


<simple i18n="true">PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_AUTH_METHOD_ENUM_SIMPLE</simple>

</Enumeration>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>40</Order>

</param>

runtime.datasource.core.ldap.baseDN

This parameter contains the base of the DN to add to all search.
May be empty if search have to be done in several branches.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.baseDN">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_BASEDN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_BASEDN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>dc=ametys,dc=org</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>30</Order>

</param>

In the same group:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd

runtime.datasource.core.ldap.baseUrl

This parameter contains the base url (protocol + server name + port) to connect to the core ldap connection.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.baseUrl">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_BASEURL_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_BASEURL_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>ldap://server:389</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>10</Order>

</param>

In the same group:
runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd

runtime.datasource.core.ldap.useSSL

This parameter determines if the connection to the ldap server is secured or not.
Depending on the JVM, the use of 'ldaps' in the protocol is not supported.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.datasource.core.ldap.useSSL">

<LabelKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_SSL_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_SSL_DESCRIPTION</DescriptionKey>


<Type>boolean</Type>


<DefaultValue>false</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_CATEGORY_LDAP_GROUP_CORE</Group>


<Order>20</Order>

</param>

In the same group:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd

runtime.groups.ldap.description

When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the description (or readable name)

Konwn uses:
runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.description">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_DESCRIPTION_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_DESCRIPTION_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>description</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>50</Order>

</param>

In the same group:
runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.member

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

runtime.groups.ldap.filter

When groups are handled in the LDAP, this parameter contains the filter to find groups objects in the current DN.

Konwn uses:
runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.filter">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_FILTER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_FILTER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>(objectclass=groupOfNames)</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>20</Order>

</param>

In the same group:
runtime.groups.ldap.groupDN, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.groups.ldap.groupDN

When groups are handled in the LDAP, this parameter the DN to append to the base DN to guide to groups.

Konwn uses:
runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.groupDN">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_GROUPDN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_GROUPDN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>ou=group</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>10</Order>

</param>

In the same group:
runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.groups.ldap.id

When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the identifier

Konwn uses:
runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.id">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_ID_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_ID_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>cn</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>40</Order>

</param>

In the same group:
runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.description, runtime.groups.ldap.member

When groups are handled in the LDAP, this parameter contains the name of the attribute on groups objects handling the assocation with users.
This attribute is multiple and will contain the login of users.
A user can be part of several groups.

Konwn uses:
runtime.groups.impl.ldap.groupDriven

Configuration:


<param id="runtime.groups.ldap.member">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_MEMBER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_MEMBER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>member</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>60</Order>

</param>

In the same group:
runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description

runtime.groups.ldap.memberof

When groups are handled in the LDAP, this parameter contains the name of the attribute on users objects (implying users to be handled in LDAP also) handling the reverse association to the groups. If this attribute is multiple a user can be part of several groups.

Konwn uses:
runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.memberof">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_MEMBEROF_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_MEMBEROF_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>memberof</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>80</Order>

</param>

In the same group:
runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.groups.ldap.scope

When groups are handled in the LDAP, this parameter determine where to look for groups objects in the current DN.

In the current DN only (object)
In the sub branch of current DN only (one)
In the current DN and all sub branches (sub) - low perf

Konwn uses:
runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.groups.ldap.scope">

<LabelKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_SEARCH_SCOPE_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_SEARCH_SCOPE_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>one</DefaultValue>


<Enumeration>

<object i18n="true">PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_SEARCH_SCOPE_ENUM_OBJECT</object>


<one i18n="true">PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_SEARCH_SCOPE_ENUM_ONE</one>


<sub i18n="true">PLUGINS_CORE_GROUPS_LDAPGROUP_CONFIG_SEARCH_SCOPE_ENUM_SUB</sub>

</Enumeration>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_GROUPS</Group>


<Order>30</Order>

</param>

In the same group:
runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.baseFilter

When users are handled in the LDAP, this parameter contains the filter to find users objects in the current DN.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.users.ldap.baseFilter">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_BASEFILTER_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_BASEFILTER_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>(objectclass=*)</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>20</Order>

</param>

In the same group:
runtime.users.ldap.peopleDN, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.emailAttr

When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the email

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware

Configuration:


<param id="runtime.users.ldap.emailAttr">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_EMAIL_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_EMAIL_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>mail</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>70</Order>

</param>

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.firstnameAttr

When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the firstname

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware

Configuration:


<param id="runtime.users.ldap.firstnameAttr">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_FIRSTNAME_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_FIRSTNAME_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>givenName</DefaultValue>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>50</Order>

</param>

In the same group:
runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.lastnameAttr

When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the lastname

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware

Configuration:


<param id="runtime.users.ldap.lastnameAttr">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_LASTNAME_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_LASTNAME_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>sn</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>60</Order>

</param>

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.loginAttr

When users are handled in the LDAP, this parameter contains the name of the attribute on users objects handling the login

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.users.ldap.loginAttr">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_LOGIN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_ATTR_LOGIN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>uid</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>40</Order>

</param>

In the same group:
runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.peopleDN

When users are handled in the LDAP, this parameter contains the DN to append to the base DN to guide to users.

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.groupDriven, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.users.ldap.peopleDN">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_PEOPLEDN_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_PEOPLEDN_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>ou=people</DefaultValue>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>10</Order>

</param>

In the same group:
runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

runtime.users.ldap.scope

When users are handled in the LDAP, this parameter determine where to look for users objects in the current DN.

In the current DN only (object)
In the sub branch of current DN only (one)
In the current DN and all sub branches (sub) - low perf

Konwn uses:
runtime.user.impl.ldap, runtime.user.impl.ldap.credentialsaware, runtime.groups.impl.ldap.usersDriven

Configuration:


<param id="runtime.users.ldap.scope">

<LabelKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_SEARCH_SCOPE_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_LDAPUSER_CONFIG_SEARCH_SCOPE_DESCRIPTION</DescriptionKey>


<Type>string</Type>


<DefaultValue>one</DefaultValue>


<Enumeration>

<object i18n="true">PLUGINS_CORE_USERS_LDAPUSER_CONFIG_SEARCH_SCOPE_ENUM_OBJECT</object>


<one i18n="true">PLUGINS_CORE_USERS_LDAPUSER_CONFIG_SEARCH_SCOPE_ENUM_ONE</one>


<sub i18n="true">PLUGINS_CORE_USERS_LDAPUSER_CONFIG_SEARCH_SCOPE_ENUM_SUB</sub>

</Enumeration>


<Validation>

<mandatory/>

</Validation>


<Category>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP</Category>


<Group>PLUGINS_CORE_DATASOURCE_CORE_CONFIG_CATEGORY_LDAP_GROUP_USERS</Group>


<Order>30</Order>

</param>

In the same group:
runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr, runtime.groups.ldap.memberof

In the same category:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member

Extension points detail

Single extension point

Multiple extension point

org.ametys.runtime.ui.item.UIItemManager

Associated java class:
org.ametys.runtime.ui.item.UIItemManager

org.ametys.runtime.authentication.AuthenticationManager

Associated java class:
org.ametys.runtime.authentication.AuthenticationManager

Known implementations:
org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication

org.ametys.runtime.plugins.core.right.RightsExtensionPoint

Associated java class:
org.ametys.runtime.plugins.core.right.RightsExtensionPoint

Known implementations:
runtime.use.rights.users, runtime.use.rights.groups, runtime.use.rights.profile

org.apache.cocoon.components.modules.input.InputModuleSelector

Associated java class:
org.ametys.runtime.cocoon.InputModulesExtensionPoint

Known implementations:
config, parent-context-attr, context-attr

org.apache.excalibur.source.SourceFactorySelector

Associated java class:
org.ametys.runtime.cocoon.SourceFactoriesExtensionPoint

org.apache.avalon.excalibur.datasource.DataSourceComponentSelector

Associated java class:
org.ametys.runtime.cocoon.DataSourceComponentsExtensionPoint

Known implementations:
runtime.datasource.core.jdbc.pool

org.ametys.runtime.cocoon.SitemapConfigurationExtensionPoint

Associated java class:
org.ametys.runtime.cocoon.SitemapConfigurationExtensionPoint

org.ametys.runtime.plugins.core.sqlmap.SqlMapExtensionPoint

Associated java class:
org.ametys.runtime.plugins.core.sqlmap.SqlMapExtensionPoint

Features detail

runtime.core

This feature is a mandatory feature of the runtime defining basic tools

Components:

org.ametys.runtime.request.RequestListenerManager

Associated java class:
org.ametys.runtime.request.RequestListenerManager

Configuration:


<component role="org.ametys.runtime.request.RequestListenerManager" class="org.ametys.runtime.request.RequestListenerManager"/>

org.apache.excalibur.source.SourceResolver

Associated java class:
org.apache.excalibur.source.impl.SourceResolverImpl

Configuration:


<component role="org.apache.excalibur.source.SourceResolver" class="org.apache.excalibur.source.impl.SourceResolverImpl"/>

Extensions:

config

Associated java class:
org.ametys.runtime.config.ConfigInputModule

Extension point extended:
org.apache.cocoon.components.modules.input.InputModuleSelector

Configuration:


<extension point="org.apache.cocoon.components.modules.input.InputModuleSelector" id="config" class="org.ametys.runtime.config.ConfigInputModule" logger="org.ametys.runtime.config.ConfigInputModule"/>

parent-context-attr

Associated java class:
org.ametys.runtime.util.cocoon.ParentContextInputModule

Extension point extended:
org.apache.cocoon.components.modules.input.InputModuleSelector

Configuration:


<extension point="org.apache.cocoon.components.modules.input.InputModuleSelector" id="parent-context-attr" class="org.ametys.runtime.util.cocoon.ParentContextInputModule" logger="org.ametys.runtime.util.cocoon.ParentContextInputModule"/>

context-attr

Associated java class:
org.ametys.runtime.util.cocoon.ContextAttributesInputModule

Extension point extended:
org.apache.cocoon.components.modules.input.InputModuleSelector

Configuration:


<extension point="org.apache.cocoon.components.modules.input.InputModuleSelector" id="context-attr" class="org.ametys.runtime.util.cocoon.ContextAttributesInputModule" logger="org.ametys.runtime.util.cocoon.ContextAttributesInputModule"/>

org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication

Associated java class:
org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication

Extension point extended:
org.ametys.runtime.authentication.AuthenticationManager

Configuration:


<extension point="org.ametys.runtime.authentication.AuthenticationManager" id="org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication" class="org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication" logger="org.ametys.runtime.plugins.core.authentication.UsersManagerAuthentication"/>

runtime.datasource.core

This feature defines the pool of connection to the database.

Use shared configuration parameters:
runtime.datasource.core.jdbc.driver, runtime.datasource.core.jdbc.url, runtime.datasource.core.jdbc.user, runtime.datasource.core.jdbc.passwd

Extensions:

runtime.datasource.core.jdbc.pool

Associated java class:
org.ametys.runtime.cocoon.JDBCDataSource

Extension point extended:
org.apache.avalon.excalibur.datasource.DataSourceComponentSelector

Configuration:


<extension point="org.apache.avalon.excalibur.datasource.DataSourceComponentSelector" id="runtime.datasource.core.jdbc.pool" class="org.ametys.runtime.cocoon.JDBCDataSource" logger="org.ametys.runtime.datasource.core.jdbc.pool">

<pool-controller max="10" max-strict="true" blocking="true" timeout="0" trim-interval="60000"/>


<keep-alive age="5000" disabled="false">select 1</keep-alive>


<auto-commit>false</auto-commit>


<driver runtime-config-parameter="runtime.datasource.core.jdbc.driver"/>


<dburl runtime-config-parameter="runtime.datasource.core.jdbc.url"/>


<user runtime-config-parameter="runtime.datasource.core.jdbc.user"/>


<password runtime-config-parameter="runtime.datasource.core.jdbc.passwd"/>

</extension>

runtime.workspace.admin

This feature defines components needed by the workspace admin

Components:

org.ametys.runtime.workspaces.admin.DesktopManager

Associated java class:
org.ametys.runtime.ui.manager.DesktopManager

Configuration:


<component role="org.ametys.runtime.workspaces.admin.DesktopManager" class="org.ametys.runtime.ui.manager.DesktopManager" config="/WEB-INF/param/workspace-admin.xml"/>

runtime.admin

This feature defines screen that may be uses in the administrator area

Extensions:

org.ametys.runtime.plugins.core.administrator.Password

This interaction allows the administrator to change its password

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.Password" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.password">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_PASSWORD_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_PASSWORD_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/password/icon_small.gif</Small>


<Medium>img/administrator/password/icon_medium.gif</Medium>


<Large>img/administrator/password/icon_large.gif</Large>

</Icons>


<Action type="class">

<Class value="RUNTIME_Plugin_Runtime_Administrator_Password"/>


<Imports>

<File>js/administrator/password.js.i18n</File>

</Imports>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.Config

This interaction allows the administrator to change the main configuration of the application

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.Config" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.config">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_CONFIG_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_CONFIG_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/config/icon_small.gif</Small>


<Medium>img/administrator/config/icon_medium.gif</Medium>


<Large>img/administrator/config/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="administrator/config/edit.html"/>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.JVMStatus

This interaction allows the administrator to check the status of the JVM

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.JVMStatus" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.status">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_STATUS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_STATUS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/jvmstatus/icon_small.gif</Small>


<Medium>img/administrator/jvmstatus/icon_medium.gif</Medium>


<Large>img/administrator/jvmstatus/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="administrator/jvmstatus/view.html"/>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.Plugins

This interaction allows the administrator to see plugins. Usefull for developpers.

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.Plugins" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.plugins">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_PLUGINS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_PLUGINS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/plugins/icon_small.gif</Small>


<Medium>img/administrator/plugins/icon_medium.gif</Medium>


<Large>img/administrator/plugins/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="administrator/plugins/view.html"/>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.Logs

This interaction allows the administrator to see and manage logs

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.Logs" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.logs">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_LOGS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_LOGS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/logs/icon_small.gif</Small>


<Medium>img/administrator/logs/icon_medium.gif</Medium>


<Large>img/administrator/logs/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="administrator/logs/view.html"/>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.System

This interaction allows the administrator to handle the system (maintenance mode, welcome message...)

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.administrator.System" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.administrator.system">

<Static>

<LabelKey>PLUGINS_CORE_ADMINISTRATOR_SYSTEM_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_ADMINISTRATOR_SYSTEM_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/administrator/system/icon_small.gif</Small>


<Medium>img/administrator/system/icon_medium.gif</Medium>


<Large>img/administrator/system/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="administrator/system/view.html"/>

</Action>

</Static>

</extension>

org.ametys.runtime.plugins.core.administrator.version.Default

Associated java class:
org.ametys.runtime.plugins.core.administrator.version.DefaultVersionsHandler

Extension point extended:
org.ametys.runtime.plugins.core.administrator.version.VersionsHandler

Configuration:


<extension point="org.ametys.runtime.plugins.core.administrator.version.VersionsHandler" id="org.ametys.runtime.plugins.core.administrator.version.Default" class="org.ametys.runtime.plugins.core.administrator.version.DefaultVersionsHandler" logger="org.ametys.runtime.plugins.core.administrator.versions"/>

runtime.users

This feature contains only the interaction for handling users

Extensions:

org.ametys.runtime.plugins.core.Users

This interaction allow to handle users (read or read/write)

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.Users" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.users">

<Static>

<LabelKey>PLUGINS_CORE_USERS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_USERS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/users/icon_small.gif</Small>


<Medium>img/users/icon_medium.gif</Medium>


<Large>img/users/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="users/view.html"/>

</Action>


<Right>Runtime_Rights_User_Handle</Right>

</Static>

</extension>

runtime.users.rights

This feature brings the rights needed to manage users

Extensions:

runtime.use.rights.users

Define the right for handling users

Extension point extended:
org.ametys.runtime.plugins.core.right.RightsExtensionPoint

Configuration:


<extension point="org.ametys.runtime.plugins.core.right.RightsExtensionPoint" id="runtime.use.rights.users">

<right id="Runtime_Rights_User_Handle">

<label>PLUGINS_CORE_USERS_RIGHTS_HANDLE_LABEL</label>


<description>PLUGINS_CORE_USERS_RIGHTS_HANDLE_DESCRIPTION</description>


<category>PLUGINS_CORE_USERANDRIGHTS_CATEGORY</category>

</right>

</extension>

runtime.user.impl.static

This features defines the static implementation of users

Extensions:

org.ametys.runtime.plugins.core.user.Static

Associated java class:
org.ametys.runtime.plugins.core.user.StaticUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.user.Static" class="org.ametys.runtime.plugins.core.user.StaticUsersManager" logger="org.ametys.runtime.plugins.core.users.static">

<user id="anonymous">

<fullname>Anonymous user</fullname>

</user>

</extension>

runtime.user.impl.jdbc.core

This features defines the base jdbc implementation of users (based on core database pool)

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.user.CoreJdbc

Associated java class:
org.ametys.runtime.plugins.core.user.jdbc.JdbcUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.user.CoreJdbc" class="org.ametys.runtime.plugins.core.user.jdbc.JdbcUsersManager" logger="org.ametys.runtime.plugins.core.users.jdbc.simple">

<pool>runtime.datasource.core.jdbc.pool</pool>


<table>Users</table>


<param id="login"/>


<param id="firstname"/>


<param id="lastname"/>


<param id="email"/>

</extension>

runtime.user.impl.jdbc.modifiable.core

The same as runtime.user.impl.jdbc.core but where users can be modified through the API

See also:
runtime.user.impl.jdbc.core

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.user.CoreModifiableJdbc

Associated java class:
org.ametys.runtime.plugins.core.user.jdbc.ModifiableJdbcUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.user.CoreModifiableJdbc" class="org.ametys.runtime.plugins.core.user.jdbc.ModifiableJdbcUsersManager" logger="org.ametys.runtime.plugins.core.users.jdbc.modifiable">

<pool>runtime.datasource.core.jdbc.pool</pool>


<table>Users</table>


<param id="login"/>


<param id="firstname"/>


<param id="lastname"/>


<param id="email"/>

</extension>

runtime.user.impl.jdbc.credentialsaware.core

The same as runtime.user.impl.jdbc.core but where users can be authentified through the API

See also:
runtime.user.impl.jdbc.core

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.user.CoreCredentialsAwareJdbc

Associated java class:
org.ametys.runtime.plugins.core.user.jdbc.CredentialsAwareJdbcUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.user.CoreCredentialsAwareJdbc" class="org.ametys.runtime.plugins.core.user.jdbc.CredentialsAwareJdbcUsersManager" logger="org.ametys.runtime.plugins.core.users.jdbc.credential">

<pool>runtime.datasource.core.jdbc.pool</pool>


<table>Users</table>


<param id="login"/>


<param id="password"/>


<param id="firstname"/>


<param id="lastname"/>


<param id="email"/>

</extension>

runtime.user.impl.jdbc.modifiablecredentialsaware.core

The same as runtime.user.impl.jdbc.core but where users can be modified and authentified through the API

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.user.CoreModifiableCredentialsAwareJdbc

Associated java class:
org.ametys.runtime.plugins.core.user.jdbc.ModifiableCredentialsAwareJdbcUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.user.CoreModifiableCredentialsAwareJdbc" class="org.ametys.runtime.plugins.core.user.jdbc.ModifiableCredentialsAwareJdbcUsersManager" logger="org.ametys.runtime.plugins.core.users.jdbc.credentialmodifiable">

<pool>runtime.datasource.core.jdbc.pool</pool>


<table>Users</table>


<param id="login"/>


<param id="password"/>


<param id="firstname"/>


<param id="lastname"/>


<param id="email"/>

</extension>

runtime.user.impl.ldap

This features defines the base ldap implementation of users

Use shared configuration parameters:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr, runtime.users.ldap.firstnameAttr, runtime.users.ldap.lastnameAttr, runtime.users.ldap.emailAttr

Extensions:

org.ametys.runtime.plugins.core.Ldap

Associated java class:
org.ametys.runtime.plugins.core.user.ldap.LdapUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.Ldap" class="org.ametys.runtime.plugins.core.user.ldap.LdapUsersManager" logger="org.ametys.runtime.plugins.core.user.ldap.simple">

<BaseUrl>runtime.datasource.core.ldap.baseUrl</BaseUrl>


<UseSSL>runtime.datasource.core.ldap.useSSL</UseSSL>


<BaseDN>runtime.datasource.core.ldap.baseDN</BaseDN>


<AuthenticationMethod>runtime.datasource.core.ldap.authMethod</AuthenticationMethod>


<AdminDN>runtime.datasource.core.ldap.adminDN</AdminDN>


<AdminPassword>runtime.datasource.core.ldap.adminPasswd</AdminPassword>


<RelativeDN>runtime.users.ldap.peopleDN</RelativeDN>


<Filter>runtime.users.ldap.baseFilter</Filter>


<SearchScope>runtime.users.ldap.scope</SearchScope>


<Login>runtime.users.ldap.loginAttr</Login>


<Firstname>runtime.users.ldap.firstnameAttr</Firstname>


<Lastname>runtime.users.ldap.lastnameAttr</Lastname>


<Email mandatory="false">runtime.users.ldap.emailAttr</Email>

</extension>

runtime.user.impl.ldap.credentialsaware

The same as runtime.user.impl.ldap but where users can be authentified through the API

See also:
runtime.user.impl.ldap

Extensions:

org.ametys.runtime.plugins.core.CredentialsAwareLdap

Associated java class:
org.ametys.runtime.plugins.core.user.ldap.CredentialsAwareLdapUsersManager

Extension point extended:
org.ametys.runtime.user.UsersManager

Configuration:


<extension point="org.ametys.runtime.user.UsersManager" id="org.ametys.runtime.plugins.core.CredentialsAwareLdap" class="org.ametys.runtime.plugins.core.user.ldap.CredentialsAwareLdapUsersManager" logger="org.ametys.runtime.plugins.core.user.ldap.credential">

<BaseUrl>runtime.datasource.core.ldap.baseUrl</BaseUrl>


<UseSSL>runtime.datasource.core.ldap.useSSL</UseSSL>


<BaseDN>runtime.datasource.core.ldap.baseDN</BaseDN>


<AuthenticationMethod>runtime.datasource.core.ldap.authMethod</AuthenticationMethod>


<AdminDN>runtime.datasource.core.ldap.adminDN</AdminDN>


<AdminPassword>runtime.datasource.core.ldap.adminPasswd</AdminPassword>


<RelativeDN>runtime.users.ldap.peopleDN</RelativeDN>


<Filter>runtime.users.ldap.baseFilter</Filter>


<SearchScope>runtime.users.ldap.scope</SearchScope>


<Login>runtime.users.ldap.loginAttr</Login>


<Firstname>runtime.users.ldap.firstnameAttr</Firstname>


<Lastname>runtime.users.ldap.lastnameAttr</Lastname>


<Email mandatory="false">runtime.users.ldap.emailAttr</Email>

</extension>

runtime.groups

This feature contains only the interaction for handling groups

Extensions:

org.ametys.runtime.plugins.core.Groups

This interaction allow to handle groups (read or read/write)

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.Groups" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.groups">

<Static>

<LabelKey>PLUGINS_CORE_GROUPS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_GROUPS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/groups/icon_small.gif</Small>


<Medium>img/groups/icon_medium.gif</Medium>


<Large>img/groups/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="groups/view.html"/>

</Action>


<Right>Runtime_Rights_Group_Handle</Right>

</Static>

</extension>

runtime.groups.rights

This feature brings the rights needed to manage groups

Extensions:

runtime.use.rights.groups

Define the right for handling groups

Extension point extended:
org.ametys.runtime.plugins.core.right.RightsExtensionPoint

Configuration:


<extension point="org.ametys.runtime.plugins.core.right.RightsExtensionPoint" id="runtime.use.rights.groups">

<right id="Runtime_Rights_Group_Handle">

<label>PLUGINS_CORE_GROUPS_RIGHTS_HANDLE_LABEL</label>


<description>PLUGINS_CORE_GROUPS_RIGHTS_HANDLE_DESCRIPTION</description>


<category>PLUGINS_CORE_USERANDRIGHTS_CATEGORY</category>

</right>

</extension>

runtime.groups.impl.empty

This features defines an 'empty' groups to avoid group handling.

Extensions:

org.ametys.runtime.plugins.core.group.Empty

Associated java class:
org.ametys.runtime.plugins.core.group.EmptyGroupsManager

Extension point extended:
org.ametys.runtime.group.GroupsManager

Configuration:


<extension point="org.ametys.runtime.group.GroupsManager" id="org.ametys.runtime.plugins.core.group.Empty" class="org.ametys.runtime.plugins.core.group.EmptyGroupsManager" logger="org.ametys.runtime.plugins.core.group.empty"/>

runtime.groups.impl.jdbc

This features defines the base jdbc implementation of users (based on core database pool)

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.group.ModifiableJdbcCore

Associated java class:
org.ametys.runtime.plugins.core.group.jdbc.ModifiableJdbcGroupsManager

Extension point extended:
org.ametys.runtime.group.GroupsManager

Configuration:


<extension point="org.ametys.runtime.group.GroupsManager" id="org.ametys.runtime.plugins.core.group.ModifiableJdbcCore" class="org.ametys.runtime.plugins.core.group.jdbc.ModifiableJdbcGroupsManager" logger="org.ametys.runtime.plugins.core.group.jdbc">

<pool>runtime.datasource.core.jdbc.pool</pool>


<list>

<table>Groups</table>


<id>Id</id>


<label>Label</label>

</list>


<composition>

<table>Groups_Users</table>


<group>Group_Id</group>


<user>Login</user>

</composition>

</extension>

runtime.groups.impl.ldap.groupDriven

This features defines the base ldap implementation of groups where the group information is handle by the group object

Use shared configuration parameters:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.member, runtime.users.ldap.peopleDN, runtime.users.ldap.loginAttr

Extensions:

org.ametys.runtime.plugins.core.group.GroupDrivenLdap

Associated java class:
org.ametys.runtime.plugins.core.group.ldap.GroupDrivenLdapGroupsManager

Extension point extended:
org.ametys.runtime.group.GroupsManager

Configuration:


<extension point="org.ametys.runtime.group.GroupsManager" id="org.ametys.runtime.plugins.core.group.GroupDrivenLdap" class="org.ametys.runtime.plugins.core.group.ldap.GroupDrivenLdapGroupsManager" logger="org.ametys.runtime.plugins.core.group.groupdriven">

<BaseUrl>runtime.datasource.core.ldap.baseUrl</BaseUrl>


<UseSSL>runtime.datasource.core.ldap.useSSL</UseSSL>


<BaseDN>runtime.datasource.core.ldap.baseDN</BaseDN>


<AuthenticationMethod>runtime.datasource.core.ldap.authMethod</AuthenticationMethod>


<AdminDN>runtime.datasource.core.ldap.adminDN</AdminDN>


<AdminPassword>runtime.datasource.core.ldap.adminPasswd</AdminPassword>


<RelativeDN>runtime.groups.ldap.groupDN</RelativeDN>


<Filter>runtime.groups.ldap.filter</Filter>


<SearchScope>runtime.groups.ldap.scope</SearchScope>


<Id>runtime.groups.ldap.id</Id>


<Description>runtime.groups.ldap.description</Description>


<Member>runtime.groups.ldap.member</Member>


<UsersRelativeDN>runtime.users.ldap.peopleDN</UsersRelativeDN>


<Login>runtime.users.ldap.loginAttr</Login>

</extension>

runtime.groups.impl.ldap.usersDriven

This features defines the base ldap implementation of groups where the group information is handle by the user object

Use shared configuration parameters:
runtime.datasource.core.ldap.baseUrl, runtime.datasource.core.ldap.useSSL, runtime.datasource.core.ldap.baseDN, runtime.datasource.core.ldap.authMethod, runtime.datasource.core.ldap.adminDN, runtime.datasource.core.ldap.adminPasswd, runtime.groups.ldap.groupDN, runtime.groups.ldap.filter, runtime.groups.ldap.scope, runtime.groups.ldap.id, runtime.groups.ldap.description, runtime.groups.ldap.memberof, runtime.users.ldap.peopleDN, runtime.users.ldap.baseFilter, runtime.users.ldap.scope, runtime.users.ldap.loginAttr

Extensions:

org.ametys.runtime.plugins.core.group.UsersDrivenLdap

Associated java class:
org.ametys.runtime.plugins.core.group.ldap.UserDrivenLdapGroupsManager

Extension point extended:
org.ametys.runtime.group.GroupsManager

Configuration:


<extension point="org.ametys.runtime.group.GroupsManager" id="org.ametys.runtime.plugins.core.group.UsersDrivenLdap" class="org.ametys.runtime.plugins.core.group.ldap.UserDrivenLdapGroupsManager" logger="org.ametys.runtime.plugins.core.group.usersdriven">

<BaseUrl>runtime.datasource.core.ldap.baseUrl</BaseUrl>


<UseSSL>runtime.datasource.core.ldap.useSSL</UseSSL>


<BaseDN>runtime.datasource.core.ldap.baseDN</BaseDN>


<AuthenticationMethod>runtime.datasource.core.ldap.authMethod</AuthenticationMethod>


<AdminDN>runtime.datasource.core.ldap.adminDN</AdminDN>


<AdminPassword>runtime.datasource.core.ldap.adminPasswd</AdminPassword>


<RelativeDN>runtime.groups.ldap.groupDN</RelativeDN>


<Filter>runtime.groups.ldap.filter</Filter>


<SearchScope>runtime.groups.ldap.scope</SearchScope>


<Id>runtime.groups.ldap.id</Id>


<Description>runtime.groups.ldap.description</Description>


<MemberOf>runtime.groups.ldap.memberof</MemberOf>


<UsersRelativeDN>runtime.users.ldap.peopleDN</UsersRelativeDN>


<UsersFilter>runtime.users.ldap.baseFilter</UsersFilter>


<UsersSearchScope>runtime.users.ldap.scope</UsersSearchScope>


<UsersLogin>runtime.users.ldap.loginAttr</UsersLogin>

</extension>

runtime.rights

This feature contains interactions to handle rights based on profiles

Extensions:

org.ametys.runtime.plugins.core.right.Profiles

This extensions display the profile screen

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.right.Profiles" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.rights.profiled.profile">

<Static>

<LabelKey>PLUGINS_CORE_RIGHTS_PROFILES_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_RIGHTS_PROFILES_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/rights/profiles/icon_small.gif</Small>


<Medium>img/rights/profiles/icon_medium.gif</Medium>


<Large>img/rights/profiles/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="rights/profiles/view.html"/>

</Action>


<Right>Runtime_Rights_Rights_Profile_Handle</Right>

</Static>

</extension>

org.ametys.runtime.plugins.core.right.Assign

This extensions display the core affectation screen for rights

Associated java class:
org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory

Extension point extended:
org.ametys.runtime.ui.item.UIItemManager

Configuration:


<extension point="org.ametys.runtime.ui.item.UIItemManager" id="org.ametys.runtime.plugins.core.right.Assign" class="org.ametys.runtime.plugins.core.ui.item.StaticUIItemFactory" logger="org.ametys.runtime.plugins.core.ui.rights.profiled.right">

<Static>

<LabelKey>PLUGINS_CORE_RIGHTS_LABEL</LabelKey>


<DescriptionKey>PLUGINS_CORE_RIGHTS_DESCRIPTION</DescriptionKey>


<Icons>

<Small>img/rights/icon_small.gif</Small>


<Medium>img/rights/icon_medium.gif</Medium>


<Large>img/rights/icon_large.gif</Large>

</Icons>


<Action type="url">

<Url value="rights/view.html"/>

</Action>


<Right>Runtime_Rights_Rights_Handle</Right>

</Static>

</extension>

runtime.rights.rights

This feature declares rights for handling rights screens

Extensions:

runtime.use.rights.profile

Defines rights for handling profile and handling rights

Extension point extended:
org.ametys.runtime.plugins.core.right.RightsExtensionPoint

Configuration:


<extension point="org.ametys.runtime.plugins.core.right.RightsExtensionPoint" id="runtime.use.rights.profile">

<right id="Runtime_Rights_Rights_Profile_Handle">

<label>PLUGINS_CORE_PROFILE_RIGHTS_HANDLE_LABEL</label>


<description>PLUGINS_CORE_PROFILE_RIGHTS_HANDLE_DESCRIPTION</description>


<category>PLUGINS_CORE_USERANDRIGHTS_CATEGORY</category>

</right>


<right id="Runtime_Rights_Rights_Handle">

<label>PLUGINS_CORE_RIGHTS_HANDLE_LABEL</label>


<description>PLUGINS_CORE_RIGHTS_HANDLE_DESCRIPTION</description>


<category>PLUGINS_CORE_USERANDRIGHTS_CATEGORY</category>

</right>

</extension>

runtime.rights.impl.basic

This feature declares the basic rights manager that always anwers OK

Extensions:

org.ametys.runtime.plugins.core.right.Basic

Associated java class:
org.ametys.runtime.plugins.core.right.BasicRightsManager

Extension point extended:
org.ametys.runtime.right.RightsManager

Configuration:


<extension point="org.ametys.runtime.right.RightsManager" id="org.ametys.runtime.plugins.core.right.Basic" class="org.ametys.runtime.plugins.core.right.BasicRightsManager" logger="org.ametys.runtime.plugins.core.right.basic"/>

runtime.rights.impl.profil

This feature declares the profile based rights manager.
This manager use the core database pool. A profile is a set of atomic rights.

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.right.DefaultProfileBased

See javadoc.
The configuration is handled in /WEB-INF/param/rights.xml.
The database pool is runtime.datasource.core.jdbc.pool

Associated java class:
org.ametys.runtime.plugins.core.right.profile.DefaultProfileBasedRightsManager

Extension point extended:
org.ametys.runtime.right.RightsManager

Configuration:


<extension point="org.ametys.runtime.right.RightsManager" id="org.ametys.runtime.plugins.core.right.DefaultProfileBased" class="org.ametys.runtime.plugins.core.right.profile.DefaultProfileBasedRightsManager" logger="org.ametys.runtime.plugins.core.right.profil">

<rights config="/WEB-INF/param/rights.xml"/>


<pool>runtime.datasource.core.jdbc.pool</pool>

</extension>

runtime.rights.impl.hierarchicalProfil

The same as runtime.rights.impl.profil but where rights are inherited in contexts : having the right on '/foo' gives the right on '/foo/subfoo'

See also:
runtime.rights.impl.profil

Depends on:
runtime.datasource.core

Extensions:

org.ametys.runtime.plugins.core.right.HierarchicalProfileBased

Associated java class:
org.ametys.runtime.plugins.core.right.profile.HierarchicalProfileBasedRightsManager

Extension point extended:
org.ametys.runtime.right.RightsManager

Configuration:


<extension point="org.ametys.runtime.right.RightsManager" id="org.ametys.runtime.plugins.core.right.HierarchicalProfileBased" class="org.ametys.runtime.plugins.core.right.profile.HierarchicalProfileBasedRightsManager" logger="org.ametys.runtime.plugins.core.right.hierarchicalprofil">

<rights config="/WEB-INF/param/rights.xml"/>


<pool>runtime.datasource.core.jdbc.pool</pool>

</extension>

runtime.exception.impl.default

This feature has the default behavior on errors that display the embeded error pages.

Extensions:

org.ametys.runtime.plugins.core.exception.Default

Associated java class:
org.ametys.runtime.exception.DefaultExceptionHandler

Extension point extended:
org.ametys.runtime.exception.ExceptionHandler

Configuration:


<extension point="org.ametys.runtime.exception.ExceptionHandler" id="org.ametys.runtime.plugins.core.exception.Default" class="org.ametys.runtime.exception.DefaultExceptionHandler" logger="org.ametys.runtime.exception.default"/>

runtime.authentication.impl.defined

This feature defines a simple credential provider as it always answer that 'anonymous' is connected

Extensions:

org.ametys.runtime.plugins.core.authentication.Defined

See javadoc.
Configured so user is always 'anonymous'

Associated java class:
org.ametys.runtime.plugins.core.authentication.DefinedCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.Defined" class="org.ametys.runtime.plugins.core.authentication.DefinedCredentialsProvider" logger="org.ametys.runtime.authentication.defined">

<user>anonymous</user>

</extension>

runtime.authentication.impl.basic

This feature defines the 'basic' credential provider (i.e. where the credential is requested to the user by the navigator - the incomming values are not trusted)

Use shared configuration parameters:
runtime.authentication.basic.realm

Extensions:

org.ametys.runtime.plugins.core.authentication.Basic

Associated java class:
org.ametys.runtime.authentication.BasicCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.Basic" class="org.ametys.runtime.authentication.BasicCredentialsProvider" logger="org.ametys.runtime.authentication.basic"/>

runtime.authentication.impl.remote

This feature defines the 'remote' credential provider (i.e. where the credential is automatically setted and trusted by environment in the REMOTE_USER variable)

Use shared configuration parameters:
runtime.authentication.remote.realm

Extensions:

org.ametys.runtime.plugins.core.authentication.Remote

Associated java class:
org.ametys.runtime.plugins.core.authentication.RemoteUserCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.Remote" class="org.ametys.runtime.plugins.core.authentication.RemoteUserCredentialsProvider" logger="org.ametys.runtime.plugins.core.authentication.remote"/>

runtime.authentication.impl.jcifs

This feature defines the windows NT credential provider.
Use its extension to automatically get the login of the user connected on the NT domain : user is authenticated externally and trusted by the NT environment.

Use shared configuration parameters:
runtime.authentication.remote.realm, runtime.authentication.jcifs.production, runtime.authentication.jcifs.clientDomain, runtime.authentication.jcifs.netBios, runtime.authentication.jcifs.domainController

Extensions:

org.ametys.runtime.plugins.core.authentication.Jcifs

Associated java class:
org.ametys.runtime.plugins.core.authentication.JcifsCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.Jcifs" class="org.ametys.runtime.plugins.core.authentication.JcifsCredentialsProvider" logger="org.ametys.runtime.plugins.core.authentication.jcifs"/>

runtime.authentication.impl.cas

This feature defines the 'cas' credential provider (i.e. user is authenticated externally and trusted by a CAS Server)

Use shared configuration parameters:
runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

Extensions:

org.ametys.runtime.plugins.core.authentication.CAS

Associated java class:
org.ametys.runtime.plugins.core.authentication.CASCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.CAS" class="org.ametys.runtime.plugins.core.authentication.CASCredentialsProvider" logger="org.ametys.runtime.plugins.core.authentication.cas"/>

runtime.authentication.impl.cas.gateway

The same as runtime.authentication.impl.cas but where CAS is configured to be used as a gateway :
An already authenticated user is trusted but a new one can also connect !
To give the user the oppotunity to enter its credentials you will have to manually redirect to the CAS login page.

Use shared configuration parameters:
runtime.authentication.cas.serverUrl, runtime.authentication.cas.authorizedProxy

Extensions:

org.ametys.runtime.plugins.core.authentication.GatewayCAS

Associated java class:
org.ametys.runtime.plugins.core.authentication.CASCredentialsProvider

Extension point extended:
org.ametys.runtime.authentication.CredentialsProvider

Configuration:


<extension point="org.ametys.runtime.authentication.CredentialsProvider" id="org.ametys.runtime.plugins.core.authentication.GatewayCAS" class="org.ametys.runtime.plugins.core.authentication.CASCredentialsProvider" logger="org.ametys.runtime.plugins.core.authentication.casgateway">

<gateway>true</gateway>

</extension>

runtime.request.impl.default

The default request handler... doing nothing

Extensions:

org.ametys.runtime.plugins.core.request.Default

Associated java class:
org.ametys.runtime.request.DefaultInitRequestHandler

Extension point extended:
org.ametys.runtime.request.InitRequestHandler

Configuration:


<extension point="org.ametys.runtime.request.InitRequestHandler" id="org.ametys.runtime.plugins.core.request.Default" class="org.ametys.runtime.request.DefaultInitRequestHandler" logger="org.ametys.runtime.request.default"/>