org.apache.ambari.server.ldap.service

Interface LdapFacade

All Known Implementing Classes:

AmbariLdapFacade

public interface LdapFacade

The contract defining all the operations required by the application when communicating with an arbitrary LDAP server. This interface is intended to decouple LDAP specific details from the application.

Any operation that requires interaction with an LDAP server from within Ambari should go through this interface. (LDAP)

Method Summary

Modifier and Type	Method and Description
void	checkConnection(AmbariLdapConfiguration ambariLdapConfiguration) Tests the connection to the LDAP server based on the provided configuration.
Set<String>	checkLdapAttributes(Map<String,Object> parameters, AmbariLdapConfiguration ambariLdapConfiguration) Checks user and group related LDAP configuration attributes in the configuration object with the help of the provided parameters
AmbariLdapConfiguration	detectAttributes(AmbariLdapConfiguration ambariLdapConfiguration) Runs the user and group attribute detection algorithms.

Method Detail

checkConnection

void checkConnection(AmbariLdapConfiguration ambariLdapConfiguration)
              throws AmbariLdapException

Tests the connection to the LDAP server based on the provided configuration.

Parameters:

ambariLdapConfiguration - the available ldap related configuration

Throws:

AmbariLdapException - if the connection fails or other problems occur during the operation

detectAttributes

AmbariLdapConfiguration detectAttributes(AmbariLdapConfiguration ambariLdapConfiguration)
                                  throws AmbariLdapException

Runs the user and group attribute detection algorithms. The method is not intended to be used as a configuration factory, the returned instance may not be suitable for use.

Parameters:

ambariLdapConfiguration - partially filled configuration instance to be extended with detected properties

Returns:

a configuration instance, with properties filled with potentially correct values

Throws:

AmbariLdapException - if the attribute detection fails

checkLdapAttributes

Set<String> checkLdapAttributes(Map<String,Object> parameters,
                                AmbariLdapConfiguration ambariLdapConfiguration)
                         throws AmbariLdapException

Checks user and group related LDAP configuration attributes in the configuration object with the help of the provided parameters

Parameters:

parameters - a map of property name and value pairs holding information to facilitate checking the attributes

ambariLdapConfiguration - configuration instance with available attributes

Returns:

the set of groups assigned to the test user

Throws:

AmbariLdapException - if the attribute checking fails