org.apache.ambari.server.security.authorization

Class LdapServerProperties

java.lang.Object

org.apache.ambari.server.security.authorization.LdapServerProperties

public class LdapServerProperties
extends Object

Describes LDAP Server connection parameters

Constructor Summary

Constructors

Constructor and Description
LdapServerProperties()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAdminGroupMappingMemberAttr()
String	getAdminGroupMappingRules()
String	getBaseDN()
String	getDnAttribute()
String	getGroupBase()
String	getGroupMembershipAttr()
String	getGroupNamingAttr()
String	getGroupObjectClass()
String	getGroupSearchFilter()
List<String>	getLdapUrls()
String	getManagerDn()
String	getManagerPassword()
String	getPrimaryUrl()
String	getReferralMethod()
String	getSecondaryUrl()
String	getSyncGroupMemberFilter()
String	getSyncGroupMemberReplacePattern()
String	getSyncUserMemberFilter()
String	getSyncUserMemberReplacePattern()
String	getUserBase()
String	getUsernameAttribute()
String	getUserObjectClass()
String	getUserSearchBase()
String	getUserSearchFilter(boolean useAlternateUserSearchFilter) Returns the LDAP filter to search users by.
int	hashCode()
boolean	isAlternateUserSearchFilterEnabled()
boolean	isAnonymousBind()
boolean	isDisableEndpointIdentification()
boolean	isForceUsernameToLowercase() Gets whether the username retrieved from the LDAP server during authentication is to be forced to all lowercase characters before assigning to the authenticated user.
boolean	isGroupMappingEnabled()
boolean	isPaginationEnabled()
boolean	isUseSsl()
protected String	resolveUserSearchFilterPlaceHolders(String filter) Resolves known placeholders found within the given ldap user search ldap filter
void	setAdminGroupMappingMemberAttr(String adminGroupMappingMemberAttr)
void	setAdminGroupMappingRules(String adminGroupMappingRules)
void	setAlternateUserSearchFilter(String alternateUserSearchFilter)
void	setAlternateUserSearchFilterEnabled(boolean alternateUserSearchFilterEnabled)
void	setAnonymousBind(boolean anonymousBind)
void	setBaseDN(String baseDN)
void	setDisableEndpointIdentification(boolean disableEndpointIdentification)
void	setDnAttribute(String dnAttribute)
void	setForceUsernameToLowercase(boolean forceUsernameToLowercase) Sets whether the username retrieved from the LDAP server during authentication is to be forced to all lowercase characters before assigning to the authenticated user.
void	setGroupBase(String groupBase)
void	setGroupMappingEnabled(boolean groupMappingEnabled)
void	setGroupMembershipAttr(String groupMembershipAttr)
void	setGroupNamingAttr(String groupNamingAttr)
void	setGroupObjectClass(String groupObjectClass)
void	setGroupSearchFilter(String groupSearchFilter)
void	setManagerDn(String managerDn)
void	setManagerPassword(String managerPassword)
void	setPaginationEnabled(boolean paginationEnabled)
void	setPrimaryUrl(String primaryUrl)
void	setReferralMethod(String referralMethod)
void	setSecondaryUrl(String secondaryUrl)
void	setSyncGroupMemberFilter(String syncGroupMemberFilter)
void	setSyncGroupMemberReplacePattern(String syncGroupMemberReplacePattern)
void	setSyncUserMemberFilter(String syncUserMemberFilter)
void	setSyncUserMemberReplacePattern(String syncUserMemberReplacePattern)
void	setUserBase(String userBase)
void	setUsernameAttribute(String usernameAttribute)
void	setUserObjectClass(String userObjectClass)
void	setUserSearchBase(String userSearchBase)
void	setUserSearchFilter(String userSearchFilter)
void	setUseSsl(boolean useSsl)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LdapServerProperties

public LdapServerProperties()

Method Detail

getLdapUrls

public List<String> getLdapUrls()

getPrimaryUrl

public String getPrimaryUrl()

setPrimaryUrl

public void setPrimaryUrl(String primaryUrl)

getSecondaryUrl

public String getSecondaryUrl()

setSecondaryUrl

public void setSecondaryUrl(String secondaryUrl)

isUseSsl

public boolean isUseSsl()

setUseSsl

public void setUseSsl(boolean useSsl)

isAnonymousBind

public boolean isAnonymousBind()

setAnonymousBind

public void setAnonymousBind(boolean anonymousBind)

getManagerDn

public String getManagerDn()

setManagerDn

public void setManagerDn(String managerDn)

getManagerPassword

public String getManagerPassword()

setManagerPassword

public void setManagerPassword(String managerPassword)

getBaseDN

public String getBaseDN()

setBaseDN

public void setBaseDN(String baseDN)

getUserSearchBase

public String getUserSearchBase()

setUserSearchBase

public void setUserSearchBase(String userSearchBase)

getUserSearchFilter

public String getUserSearchFilter(boolean useAlternateUserSearchFilter)

Returns the LDAP filter to search users by.

Parameters:

useAlternateUserSearchFilter - if true than return LDAP filter that expects user name in User Principal Name format to filter users constructed from org.apache.ambari.server.configuration.Configuration#LDAP_ALT_USER_SEARCH_FILTER. Otherwise the filter is constructed from org.apache.ambari.server.configuration.Configuration#LDAP_USER_SEARCH_FILTER

Returns:

the LDAP filter string

getUsernameAttribute

public String getUsernameAttribute()

setUsernameAttribute

public void setUsernameAttribute(String usernameAttribute)

setForceUsernameToLowercase

public void setForceUsernameToLowercase(boolean forceUsernameToLowercase)

Sets whether the username retrieved from the LDAP server during authentication is to be forced to all lowercase characters before assigning to the authenticated user.

Parameters:

forceUsernameToLowercase - true to force the username to be lowercase; false to leave as it was when retrieved from the LDAP server

isForceUsernameToLowercase

public boolean isForceUsernameToLowercase()

Gets whether the username retrieved from the LDAP server during authentication is to be forced to all lowercase characters before assigning to the authenticated user.

Returns:

true to force the username to be lowercase; false to leave as it was when retrieved from the LDAP server

getGroupBase

public String getGroupBase()

setGroupBase

public void setGroupBase(String groupBase)

getGroupObjectClass

public String getGroupObjectClass()

setGroupObjectClass

public void setGroupObjectClass(String groupObjectClass)

getGroupMembershipAttr

public String getGroupMembershipAttr()

setGroupMembershipAttr

public void setGroupMembershipAttr(String groupMembershipAttr)

getGroupNamingAttr

public String getGroupNamingAttr()

setGroupNamingAttr

public void setGroupNamingAttr(String groupNamingAttr)

getAdminGroupMappingRules

public String getAdminGroupMappingRules()

setAdminGroupMappingRules

public void setAdminGroupMappingRules(String adminGroupMappingRules)

getGroupSearchFilter

public String getGroupSearchFilter()

setGroupSearchFilter

public void setGroupSearchFilter(String groupSearchFilter)

setUserSearchFilter

public void setUserSearchFilter(String userSearchFilter)

setAlternateUserSearchFilterEnabled

public void setAlternateUserSearchFilterEnabled(boolean alternateUserSearchFilterEnabled)

isAlternateUserSearchFilterEnabled

public boolean isAlternateUserSearchFilterEnabled()

setAlternateUserSearchFilter

public void setAlternateUserSearchFilter(String alternateUserSearchFilter)

isGroupMappingEnabled

public boolean isGroupMappingEnabled()

setGroupMappingEnabled

public void setGroupMappingEnabled(boolean groupMappingEnabled)

setUserBase

public void setUserBase(String userBase)

setUserObjectClass

public void setUserObjectClass(String userObjectClass)

getUserBase

public String getUserBase()

getUserObjectClass

public String getUserObjectClass()

getDnAttribute

public String getDnAttribute()

setDnAttribute

public void setDnAttribute(String dnAttribute)

setReferralMethod

public void setReferralMethod(String referralMethod)

getReferralMethod

public String getReferralMethod()

isDisableEndpointIdentification

public boolean isDisableEndpointIdentification()

setDisableEndpointIdentification

public void setDisableEndpointIdentification(boolean disableEndpointIdentification)

isPaginationEnabled

public boolean isPaginationEnabled()

setPaginationEnabled

public void setPaginationEnabled(boolean paginationEnabled)

getSyncGroupMemberReplacePattern

public String getSyncGroupMemberReplacePattern()

setSyncGroupMemberReplacePattern

public void setSyncGroupMemberReplacePattern(String syncGroupMemberReplacePattern)

getSyncUserMemberReplacePattern

public String getSyncUserMemberReplacePattern()

setSyncUserMemberReplacePattern

public void setSyncUserMemberReplacePattern(String syncUserMemberReplacePattern)

getSyncUserMemberFilter

public String getSyncUserMemberFilter()

setSyncUserMemberFilter

public void setSyncUserMemberFilter(String syncUserMemberFilter)

getSyncGroupMemberFilter

public String getSyncGroupMemberFilter()

setSyncGroupMemberFilter

public void setSyncGroupMemberFilter(String syncGroupMemberFilter)

getAdminGroupMappingMemberAttr

public String getAdminGroupMappingMemberAttr()

setAdminGroupMappingMemberAttr

public void setAdminGroupMappingMemberAttr(String adminGroupMappingMemberAttr)

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

resolveUserSearchFilterPlaceHolders

protected String resolveUserSearchFilterPlaceHolders(String filter)

Resolves known placeholders found within the given ldap user search ldap filter

Parameters:

filter -

Returns:

returns the filter with the resolved placeholders.