com.solidfire.element.api

Class EnableLdapAuthenticationRequest

Object

EnableLdapAuthenticationRequest

All Implemented Interfaces:

Serializable

public class EnableLdapAuthenticationRequest
extends Object
implements Serializable

EnableLdapAuthenticationRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnableLdapAuthenticationRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
EnableLdapAuthenticationRequest()
EnableLdapAuthenticationRequest(Optional<String> authType, Optional<String> groupSearchBaseDN, Optional<String> groupSearchCustomFilter, Optional<String> groupSearchType, Optional<String> searchBindDN, Optional<String> searchBindPassword, String[] serverURIs, Optional<String> userDNTemplate, Optional<String> userSearchBaseDN, Optional<String> userSearchFilter)

Method Summary

Methods

Modifier and Type	Method and Description
EnableLdapAuthenticationRequest.Builder	asBuilder()
static EnableLdapAuthenticationRequest.Builder	builder()
boolean	equals(Object o)
Optional<String>	getAuthType() Identifies which user authentcation method will be used.
Optional<String>	getGroupSearchBaseDN() The base DN of the tree to start the group search (will do a subtree search from here).
Optional<String>	getGroupSearchCustomFilter() REQUIRED for CustomFilter For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups.
Optional<String>	getGroupSearchType() Controls the default group search filter used, can be one of the following: NoGroups: No group support.
Optional<String>	getSearchBindDN() REQUIRED for SearchAndBind A fully qualified DN to log in with to perform an LDAP search for the user (needs read access to the LDAP directory).
Optional<String>	getSearchBindPassword() REQUIRED for SearchAndBind The password for the searchBindDN account used for searching.
String[]	getServerURIs() A list of LDAP server URIs (examples: "ldap://1.2.3.4" and ldaps://1.2.3.4:123")
Optional<String>	getUserDNTemplate() REQUIRED for DirectBind A string that is used to form a fully qualified user DN.
Optional<String>	getUserSearchBaseDN() REQUIRED for SearchAndBind The base DN of the tree used to start the search (will do a subtree search from here).
Optional<String>	getUserSearchFilter() REQUIRED for SearchAndBind.
int	hashCode()
void	setAuthType(Optional<String> authType)
void	setGroupSearchBaseDN(Optional<String> groupSearchBaseDN)
void	setGroupSearchCustomFilter(Optional<String> groupSearchCustomFilter)
void	setGroupSearchType(Optional<String> groupSearchType)
void	setSearchBindDN(Optional<String> searchBindDN)
void	setSearchBindPassword(Optional<String> searchBindPassword)
void	setServerURIs(String[] serverURIs)
void	setUserDNTemplate(Optional<String> userDNTemplate)
void	setUserSearchBaseDN(Optional<String> userSearchBaseDN)
void	setUserSearchFilter(Optional<String> userSearchFilter)
Map<String,Object>	toMap()
String	toString()

Methods inherited from class Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

EnableLdapAuthenticationRequest

@Since(value="7.0")
public EnableLdapAuthenticationRequest()

EnableLdapAuthenticationRequest

@Since(value="7.0")
public EnableLdapAuthenticationRequest(Optional<String> authType,
                                          Optional<String> groupSearchBaseDN,
                                          Optional<String> groupSearchCustomFilter,
                                          Optional<String> groupSearchType,
                                          Optional<String> searchBindDN,
                                          Optional<String> searchBindPassword,
                                          String[] serverURIs,
                                          Optional<String> userDNTemplate,
                                          Optional<String> userSearchBaseDN,
                                          Optional<String> userSearchFilter)

Method Detail

getAuthType

public Optional<String> getAuthType()

Identifies which user authentcation method will be used. Must be one of the following: DirectBind SearchAndBind (default)

setAuthType

public void setAuthType(Optional<String> authType)

getGroupSearchBaseDN

public Optional<String> getGroupSearchBaseDN()

The base DN of the tree to start the group search (will do a subtree search from here).

setGroupSearchBaseDN

public void setGroupSearchBaseDN(Optional<String> groupSearchBaseDN)

getGroupSearchCustomFilter

public Optional<String> getGroupSearchCustomFilter()

REQUIRED for CustomFilter For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a user's groups. The string can have placeholder text of %USERNAME% and %USERDN% to be replaced with their username and full userDN as needed.

setGroupSearchCustomFilter

public void setGroupSearchCustomFilter(Optional<String> groupSearchCustomFilter)

getGroupSearchType

public Optional<String> getGroupSearchType()

Controls the default group search filter used, can be one of the following: NoGroups: No group support. ActiveDirectory: (default) Nested membership of all of a user's AD groups. MemberDN: MemberDN style groups (single-level).

setGroupSearchType

public void setGroupSearchType(Optional<String> groupSearchType)

getSearchBindDN

public Optional<String> getSearchBindDN()

REQUIRED for SearchAndBind A fully qualified DN to log in with to perform an LDAP search for the user (needs read access to the LDAP directory).

setSearchBindDN

public void setSearchBindDN(Optional<String> searchBindDN)

getSearchBindPassword

public Optional<String> getSearchBindPassword()

REQUIRED for SearchAndBind The password for the searchBindDN account used for searching.

setSearchBindPassword

public void setSearchBindPassword(Optional<String> searchBindPassword)

getServerURIs

public String[] getServerURIs()

A list of LDAP server URIs (examples: "ldap://1.2.3.4" and ldaps://1.2.3.4:123")

setServerURIs

public void setServerURIs(String[] serverURIs)

getUserDNTemplate

public Optional<String> getUserDNTemplate()

REQUIRED for DirectBind A string that is used to form a fully qualified user DN. The string should have the placeholder text "%USERNAME%" which will be replaced with the username of the authenticating user.

setUserDNTemplate

public void setUserDNTemplate(Optional<String> userDNTemplate)

getUserSearchBaseDN

public Optional<String> getUserSearchBaseDN()

REQUIRED for SearchAndBind The base DN of the tree used to start the search (will do a subtree search from here).

setUserSearchBaseDN

public void setUserSearchBaseDN(Optional<String> userSearchBaseDN)

getUserSearchFilter

public Optional<String> getUserSearchFilter()

REQUIRED for SearchAndBind. The LDAP filter to use. The string should have the placeholder text "%USERNAME%" which will be replaced with the username of the authenticating user. Example: (&(objectClass=person) (sAMAccountName=%USERNAME%)) will use the sAMAccountName field in Active Directory to match the nusername entered at cluster login.

setUserSearchFilter

public void setUserSearchFilter(Optional<String> userSearchFilter)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toMap

public Map<String,Object> toMap()

toString

public String toString()

Overrides:

toString in class Object

builder

public static EnableLdapAuthenticationRequest.Builder builder()

asBuilder

public final EnableLdapAuthenticationRequest.Builder asBuilder()