DefaultLDAPImpl (Digital Object Identifier Server 1.0.5 API)

java.lang.Object
- fr.cnes.doi.plugin.AbstractAuthenticationPluginHelper
- - fr.cnes.doi.plugin.impl.db.DefaultLDAPImpl

All Implemented Interfaces:

IAuthenticationDBHelper, PluginConfiguration, PluginMetadata
```
public final class DefaultLDAPImpl
extends AbstractAuthenticationPluginHelper
```
Implementation of the LDAP.

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`AUTHOR` Plugin author.
`private Map<String,String>`	`conf` Configuration file.
`private boolean`	`configured` Status of the plugin configuration.
`private static String`	`DESCRIPTION` Plugin description.
`static String`	`LDAP_ATTR_FULLNAME` Attributes name in LDAP for fullname.
`static String`	`LDAP_ATTR_MAIL` Attributes name in LDAP for mail.
`static String`	`LDAP_ATTR_USERNAME` Attributes name in LDAP for username.
`static String`	`LDAP_DOI_ADMIN` LDAP username who is the administrator of the DOI server
`static String`	`LDAP_PROJECT` LDAP project
`static String`	`LDAP_PWD` LDAP pwd
`static String`	`LDAP_SEARCH_GROUP` Specifies the filter expression to get the group.
`static String`	`LDAP_SEARCH_USER` Specifies the filter expression to get the users.
`static String`	`LDAP_URL` LDAP url
`static String`	`LDAP_USER` LDAP user
`private static String`	`LICENSE` Plugin license.
`private static org.apache.logging.log4j.Logger`	`LOGGER` Logger.
`private String`	`NAME` Plugin name.
`private static String`	`OWNER` Plugin owner.
`private static String`	`VERSION` Plugin version.

Constructor Summary

Constructors
Constructor and Description

DefaultLDAPImpl()

Constructors
Constructor and Description
`DefaultLDAPImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`authenticateUser(String login, String password)` Authenticates an user via the authentication service.
`List<AuthSystemUser>`	`getAllDOIProjectMembers(InitialLdapContext context)` Search on LDAP all users which are in the group Consts.LDAP_PROJECT.
`String`	`getAuthor()` Returns the author of the plugin.
`private InitialLdapContext`	`getContext()` Init LDAP context.
`String`	`getDescription()` Returns the description of the plugin
`String`	`getDOIAdmin()` Returns the user from the authentication access, which will be the administrator of DOI server.
`List<AuthSystemUser>`	`getDOIProjectMembers()` Returns the authentication members.
`private List<AuthSystemUser>`	`getLdapUsers(DirContext context, String gidNumber)` Search on LDAP all users which are in the group Consts.LDAP_PROJECT in a LDAP group
`String`	`getLicense()` Returns the license of the plugin.
`String`	`getName()` Returns the name of the plugin.
`String`	`getOwner()` Returns the owner of the plugin.
`String`	`getVersion()` Returns the version of the plugin.
`void`	`initConnection()` Inits the connection
`boolean`	`isConfigured()` Checks if the plugin is already configured
`private boolean`	`isLdapConfigured()` Returns true when the LDAP context is well configured.
`static boolean`	`isPassword(String key)` Checks if the keyword is a password.
`void`	`release()` Release the plugin.
`void`	`setConfiguration(Object configuration)` Sets the configuration.
`StringBuilder`	`validate()` Validates the parameters in the configuration file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LDAP_URL
```
public static final String LDAP_URL
```
    LDAP url
    
    See Also:
    
    Constant Field Values
  - LDAP_USER
```
public static final String LDAP_USER
```
    LDAP user
    
    See Also:
    
    Constant Field Values
  - LDAP_PWD
```
public static final String LDAP_PWD
```
    LDAP pwd
    
    See Also:
    
    Constant Field Values
  - LDAP_PROJECT
```
public static final String LDAP_PROJECT
```
    LDAP project
    
    See Also:
    
    Constant Field Values
  - LDAP_DOI_ADMIN
```
public static final String LDAP_DOI_ADMIN
```
    LDAP username who is the administrator of the DOI server
    
    See Also:
    
    Constant Field Values
  - LDAP_SEARCH_GROUP
```
public static final String LDAP_SEARCH_GROUP
```
    Specifies the filter expression to get the group.
    
    See Also:
    
    Constant Field Values
  - LDAP_SEARCH_USER
```
public static final String LDAP_SEARCH_USER
```
    Specifies the filter expression to get the users.
    
    See Also:
    
    Constant Field Values
  - LDAP_ATTR_USERNAME
```
public static final String LDAP_ATTR_USERNAME
```
    Attributes name in LDAP for username.
    
    See Also:
    
    Constant Field Values
  - LDAP_ATTR_MAIL
```
public static final String LDAP_ATTR_MAIL
```
    Attributes name in LDAP for mail.
    
    See Also:
    
    Constant Field Values
  - LDAP_ATTR_FULLNAME
```
public static final String LDAP_ATTR_FULLNAME
```
    Attributes name in LDAP for fullname.
    
    See Also:
    
    Constant Field Values
  - LOGGER
```
private static final org.apache.logging.log4j.Logger LOGGER
```
    Logger.
  - DESCRIPTION
```
private static final String DESCRIPTION
```
    Plugin description.
    
    See Also:
    
    Constant Field Values
  - VERSION
```
private static final String VERSION
```
    Plugin version.
    
    See Also:
    
    Constant Field Values
  - OWNER
```
private static final String OWNER
```
    Plugin owner.
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
private static final String AUTHOR
```
    Plugin author.
    
    See Also:
    
    Constant Field Values
  - LICENSE
```
private static final String LICENSE
```
    Plugin license.
    
    See Also:
    
    Constant Field Values
  - NAME
```
private final String NAME
```
    Plugin name.
  - conf
```
private Map<String,String> conf
```
    Configuration file.
  - configured
```
private boolean configured
```
    Status of the plugin configuration.
- Constructor Detail
  - DefaultLDAPImpl
```
public DefaultLDAPImpl()
```
- Method Detail
  - setConfiguration
```
public void setConfiguration(Object configuration)
```
    Sets the configuration.
    
    Parameters:
    
    configuration - configuration parameters
  - initConnection
```
public void initConnection()
                    throws DoiRuntimeException
```
    Inits the connection
    
    Throws:
    
    DoiRuntimeException - When an connection error happens
  - getDOIProjectMembers
```
public List<AuthSystemUser> getDOIProjectMembers()
                                          throws AuthenticationAccessException
```
    Returns the authentication members.
    
    Returns:
    
    the authentication members
    
    Throws:
    
    AuthenticationAccessException - When a problem occurs
  - isLdapConfigured
```
private boolean isLdapConfigured()
```
    Returns true when the LDAP context is well configured.
    
    Returns:
    
    true when the LDAP context is well configured otherwise false
  - getContext
```
private InitialLdapContext getContext()
                               throws NamingException
```
    Init LDAP context.
    
    Returns:
    
    the context or null when a LDAP configuration is missing
    
    Throws:
    
    NamingException - Unable to connect to Ldap
  - authenticateUser
```
public boolean authenticateUser(String login,
                                String password)
```
    Authenticates an user via the authentication service.
    
    Parameters:
    
    login - login
    
    password - password
    
    Returns:
    
    True when the user is authenticated otherwise False.
  - getAllDOIProjectMembers
```
public List<AuthSystemUser> getAllDOIProjectMembers(InitialLdapContext context)
                                             throws AuthenticationAccessException
```
    Search on LDAP all users which are in the group Consts.LDAP_PROJECT.
    
    Parameters:
    
    context - context
    
    Returns:
    
    all LDAP users which are in the group Consts.LDAP_PROJECT
    
    Throws:
    
    AuthenticationAccessException - Exception
  - getLdapUsers
```
private List<AuthSystemUser> getLdapUsers(DirContext context,
                                          String gidNumber)
                                   throws NamingException
```
    Search on LDAP all users which are in the group Consts.LDAP_PROJECT in a LDAP group
    
    Parameters:
    
    context - context
    
    gidNumber - LDAP group ID
    
    Returns:
    
    all LDAP users which are in the group Consts.LDAP_PROJECT for a specific LDAP group
    
    Throws:
    
    NamingException - Exception
  - getName
```
public String getName()
```
    Returns the name of the plugin.
    
    Returns:
    
    the name
  - getDescription
```
public String getDescription()
```
    Returns the description of the plugin
    
    Returns:
    
    description
  - getVersion
```
public String getVersion()
```
    Returns the version of the plugin.
    
    Returns:
    
    the version
  - getAuthor
```
public String getAuthor()
```
    Returns the author of the plugin.
    
    Returns:
    
    the author
  - getOwner
```
public String getOwner()
```
    Returns the owner of the plugin.
    
    Returns:
    
    the owner
  - getLicense
```
public String getLicense()
```
    Returns the license of the plugin.
    
    Returns:
    
    the license
  - getDOIAdmin
```
public String getDOIAdmin()
```
    Returns the user from the authentication access, which will be the administrator of DOI server.
    
    Returns:
    
    the administrator
  - validate
```
public StringBuilder validate()
```
    Validates the parameters in the configuration file.
    
    Returns:
    
    the error messages.
  - isPassword
```
public static boolean isPassword(String key)
```
    Checks if the keyword is a password.
    
    Parameters:
    
    key - keyword to check
    
    Returns:
    
    True when the keyword is a password otherwise False
  - release
```
public void release()
```
    Release the plugin.
  - isConfigured
```
public boolean isConfigured()
```
    Checks if the plugin is already configured
    
    Returns:
    
    True when the plugin is already configured otherwise false

Class DefaultLDAPImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LDAP_URL

LDAP_USER

LDAP_PWD

LDAP_PROJECT

LDAP_DOI_ADMIN

LDAP_SEARCH_GROUP

LDAP_SEARCH_USER

LDAP_ATTR_USERNAME

LDAP_ATTR_MAIL

LDAP_ATTR_FULLNAME

LOGGER

DESCRIPTION

VERSION

OWNER

AUTHOR

LICENSE

NAME

conf

configured

Constructor Detail

DefaultLDAPImpl

Method Detail

setConfiguration

initConnection

getDOIProjectMembers

isLdapConfigured

getContext

authenticateUser

getAllDOIProjectMembers

getLdapUsers

getName

getDescription

getVersion

getAuthor

getOwner

getLicense

getDOIAdmin

validate

isPassword

release

isConfigured