org.apache.ambari.server.ldap.service

Interface LdapConfigurationService

All Known Implementing Classes:

DefaultLdapConfigurationService

public interface LdapConfigurationService

Collection of operations for validating ldap configuration. It's intended to decouple implementations using different libraries.

Method Summary

Modifier and Type	Method and Description
void	checkConnection(AmbariLdapConfiguration configuration) Tests the connection based on the provided configuration.
Set<String>	checkGroupAttributes(String userDn, AmbariLdapConfiguration ambariLdapConfiguration) Checks whether the group related LDAP attributes in the configuration are correct.
String	checkUserAttributes(String testUserName, String testPassword, AmbariLdapConfiguration configuration) Implements LDAP user related configuration settings validation logic.

Method Detail

checkConnection

void checkConnection(AmbariLdapConfiguration configuration)
              throws AmbariLdapException

Tests the connection based on the provided configuration.

Parameters:

configuration - the ambari ldap configuration instance

Throws:

AmbariLdapException - if the connection is not possible

checkUserAttributes

String checkUserAttributes(String testUserName,
                           String testPassword,
                           AmbariLdapConfiguration configuration)
                    throws AmbariLdapException

Implements LDAP user related configuration settings validation logic. Implementers communicate with the LDAP server (search, bind) to validate attributes in the provided configuration instance

Parameters:

testUserName - the test username

testPassword - the test password

configuration - the available ldap configuration

Returns:

The DN of the found user entry

Throws:

org.apache.ambari.server.AmbariException - if the connection couldn't be estabilisheds

AmbariLdapException

checkGroupAttributes

Set<String> checkGroupAttributes(String userDn,
                                 AmbariLdapConfiguration ambariLdapConfiguration)
                          throws AmbariLdapException

Checks whether the group related LDAP attributes in the configuration are correct.

Parameters:

userDn -

ambariLdapConfiguration -

Returns:

Throws:

AmbariLdapException