LDAPProperties (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.authentication.LDAPProperties

```
@PublicAPI
public class LDAPProperties
extends Object
```
LDAPProperties contains all LDAP configuration properties. You must use provided methods in order to get these properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FALLBACK_GROUP_MEMBERSHIP` group fall back property, check user group membership group file if user is not found in corresponding LDAP group.
`static String`	`FALLBACK_TENANT_MEMBERSHIP` tenant fall back property, check user tenant membership tenant file if user is not found in LDAP or if tenant LDAP attribute is not defined.
`static String`	`FALLBACK_USER_AUTH` fall back property, check user/password and group in files if user is not found in LDAP.
`static String`	`LDAP_AUTHENTICATION_METHOD` authentication method used to connect to LDAP : none, simple or a SASL method
`static String`	`LDAP_BIND_LOGIN` login name used to perform ldap's binding
`static String`	`LDAP_BIND_PASSWD` password used to perform ldap's binding
`static String`	`LDAP_CONNECTION_POOLING` boolean defining whether the LDAP service provider has to use connection pooling or not
`static String`	`LDAP_GROUP_FILTER` Retrieves the group the user dn belongs to `pa.ldap.group.filter=(&(objectclass=groupOfUniqueNames)(uniqueMember=%s))` the `%s` parameter is the user dn.
`static String`	`LDAP_GROUPNAME_ATTR` the attribute in the group entry that matches the jaas' group name
`static String`	`LDAP_GROUPS_SUBTREE` path in the LDAP tree groups containing
`static String`	`LDAP_GROUPSEARCH_USE_UID` use member uid in group search
`static String`	`LDAP_KEYSTORE_PASSWD` password for the keystore defined by pa.ldap.keystore.path
`static String`	`LDAP_KEYSTORE_PATH` path of the java keystore file used by LDAP module for SSL/TLS authentication
`static String`	`LDAP_START_TLS` enable starttls negociation
`static String`	`LDAP_START_TLS_ANY_CERTIFICATE`
`static String`	`LDAP_START_TLS_ANY_HOSTNAME`
`static String`	`LDAP_TENANT_ATTR` the attribute in the user entry that defines the tenant If not defined, no tenant will be associated with the user, or tenant will be defined using the fallback method
`static String`	`LDAP_TRUSTSTORE_PASSWD` password for the truststore defined by pa.ldap.truststore.path
`static String`	`LDAP_TRUSTSTORE_PATH` path of the java truststore file used by LDAP module for SSL/TLS authentication
`static String`	`LDAP_URL` URL of a ldap used for authentication
`static String`	`LDAP_USER_FILTER` Filter that allows to find the user dn given its scheduler login `pa.ldap.user.filter=(&(objectclass=inetOrgPerson)(uid=%s))` the `%s` parameter is the login used during the scheduler authentication process
`static String`	`LDAP_USERS_SUBTREE` path in the LDAP tree users containing

Constructor Summary

Constructors
Constructor and Description

LDAPProperties(String propertiesFileName)
Create a new instance of LDAPProperties

Constructors
Constructor and Description
`LDAPProperties(String propertiesFileName)` Create a new instance of LDAPProperties

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getProperty(String key)` Retrieves the value of the property
`String`	`getProperty(String key, String defaultValue)` Retrieves the value of the property

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
```
    URL of a ldap used for authentication
    
    See Also:
    
    Constant Field Values
  - LDAP_USERS_SUBTREE
```
public static final String LDAP_USERS_SUBTREE
```
    path in the LDAP tree users containing
    
    See Also:
    
    Constant Field Values
  - LDAP_GROUPS_SUBTREE
```
public static final String LDAP_GROUPS_SUBTREE
```
    path in the LDAP tree groups containing
    
    See Also:
    
    Constant Field Values
  - LDAP_USER_FILTER
```
public static final String LDAP_USER_FILTER
```
    Filter that allows to find the user dn given its scheduler login pa.ldap.user.filter=(&(objectclass=inetOrgPerson)(uid=%s)) the %s parameter is the login used during the scheduler authentication process
    
    See Also:
    
    Constant Field Values
  - LDAP_GROUP_FILTER
```
public static final String LDAP_GROUP_FILTER
```
    Retrieves the group the user dn belongs to pa.ldap.group.filter=(&(objectclass=groupOfUniqueNames)(uniqueMember=%s)) the %s parameter is the user dn.
    
    See Also:
    
    Constant Field Values
  - LDAP_GROUPSEARCH_USE_UID
```
public static final String LDAP_GROUPSEARCH_USE_UID
```
    use member uid in group search
    
    See Also:
    
    Constant Field Values
  - LDAP_GROUPNAME_ATTR
```
public static final String LDAP_GROUPNAME_ATTR
```
    the attribute in the group entry that matches the jaas' group name
    
    See Also:
    
    Constant Field Values
  - LDAP_TENANT_ATTR
```
public static final String LDAP_TENANT_ATTR
```
    the attribute in the user entry that defines the tenant If not defined, no tenant will be associated with the user, or tenant will be defined using the fallback method
    
    See Also:
    
    Constant Field Values
  - LDAP_AUTHENTICATION_METHOD
```
public static final String LDAP_AUTHENTICATION_METHOD
```
    authentication method used to connect to LDAP : none, simple or a SASL method
    
    See Also:
    
    Constant Field Values
  - LDAP_START_TLS
```
public static final String LDAP_START_TLS
```
    enable starttls negociation
    
    See Also:
    
    Constant Field Values
  - LDAP_START_TLS_ANY_CERTIFICATE
```
public static final String LDAP_START_TLS_ANY_CERTIFICATE
```
    See Also:
    
    Constant Field Values
  - LDAP_START_TLS_ANY_HOSTNAME
```
public static final String LDAP_START_TLS_ANY_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - LDAP_BIND_LOGIN
```
public static final String LDAP_BIND_LOGIN
```
    login name used to perform ldap's binding
    
    See Also:
    
    Constant Field Values
  - LDAP_BIND_PASSWD
```
public static final String LDAP_BIND_PASSWD
```
    password used to perform ldap's binding
    
    See Also:
    
    Constant Field Values
  - LDAP_KEYSTORE_PATH
```
public static final String LDAP_KEYSTORE_PATH
```
    path of the java keystore file used by LDAP module for SSL/TLS authentication
    
    See Also:
    
    Constant Field Values
  - LDAP_TRUSTSTORE_PATH
```
public static final String LDAP_TRUSTSTORE_PATH
```
    path of the java truststore file used by LDAP module for SSL/TLS authentication
    
    See Also:
    
    Constant Field Values
  - LDAP_KEYSTORE_PASSWD
```
public static final String LDAP_KEYSTORE_PASSWD
```
    password for the keystore defined by pa.ldap.keystore.path
    
    See Also:
    
    Constant Field Values
  - LDAP_TRUSTSTORE_PASSWD
```
public static final String LDAP_TRUSTSTORE_PASSWD
```
    password for the truststore defined by pa.ldap.truststore.path
    
    See Also:
    
    Constant Field Values
  - LDAP_CONNECTION_POOLING
```
public static final String LDAP_CONNECTION_POOLING
```
    boolean defining whether the LDAP service provider has to use connection pooling or not
    
    See Also:
    
    Constant Field Values
  - FALLBACK_USER_AUTH
```
public static final String FALLBACK_USER_AUTH
```
    fall back property, check user/password and group in files if user is not found in LDAP. true or false
    
    See Also:
    
    Constant Field Values
  - FALLBACK_GROUP_MEMBERSHIP
```
public static final String FALLBACK_GROUP_MEMBERSHIP
```
    group fall back property, check user group membership group file if user is not found in corresponding LDAP group. true or false
    
    See Also:
    
    Constant Field Values
  - FALLBACK_TENANT_MEMBERSHIP
```
public static final String FALLBACK_TENANT_MEMBERSHIP
```
    tenant fall back property, check user tenant membership tenant file if user is not found in LDAP or if tenant LDAP attribute is not defined. true or false
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LDAPProperties
```
public LDAPProperties(String propertiesFileName)
```
    Create a new instance of LDAPProperties
    
    Parameters:
    
    propertiesFileName - properties file name
- Method Detail
  - getProperty
```
public String getProperty(String key)
```
    Retrieves the value of the property
    
    Parameters:
    
    key - property name
    
    Returns:
    
    property value
  - getProperty
```
public String getProperty(String key,
                          String defaultValue)
```
    Retrieves the value of the property
    
    Parameters:
    
    key - property name
    
    defaultValue - default value
    
    Returns:
    
    property value

Class LDAPProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LDAP_URL

LDAP_USERS_SUBTREE

LDAP_GROUPS_SUBTREE

LDAP_USER_FILTER

LDAP_GROUP_FILTER

LDAP_GROUPSEARCH_USE_UID

LDAP_GROUPNAME_ATTR

LDAP_TENANT_ATTR

LDAP_AUTHENTICATION_METHOD

LDAP_START_TLS

LDAP_START_TLS_ANY_CERTIFICATE

LDAP_START_TLS_ANY_HOSTNAME

LDAP_BIND_LOGIN

LDAP_BIND_PASSWD

LDAP_KEYSTORE_PATH

LDAP_TRUSTSTORE_PATH

LDAP_KEYSTORE_PASSWD

LDAP_TRUSTSTORE_PASSWD

LDAP_CONNECTION_POOLING

FALLBACK_USER_AUTH

FALLBACK_GROUP_MEMBERSHIP

FALLBACK_TENANT_MEMBERSHIP

Constructor Detail

LDAPProperties

Method Detail

getProperty

getProperty