com.solidfire.element.api

Class EnableLdapAuthenticationRequest

java.lang.Object

com.solidfire.element.api.EnableLdapAuthenticationRequest

All Implemented Interfaces:

java.io.Serializable

public class EnableLdapAuthenticationRequest
extends java.lang.Object
implements java.io.Serializable

EnableLdapAuthenticationRequest The EnableLdapAuthentication method enables you to configure an LDAP directory connection to use for LDAP authentication to a cluster. Users that are members of the LDAP directory can then log in to the storage system using their LDAP credentials.

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<java.lang.String> authType, Optional<java.lang.String> groupSearchBaseDN, Optional<java.lang.String> groupSearchCustomFilter, Optional<java.lang.String> groupSearchType, Optional<java.lang.String> searchBindDN, Optional<java.lang.String> searchBindPassword, java.lang.String[] serverURIs, Optional<java.lang.String> userDNTemplate, Optional<java.lang.String> userSearchBaseDN, Optional<java.lang.String> userSearchFilter)

Method Summary

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

Methods inherited from class java.lang.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<java.lang.String> authType,
                                                           Optional<java.lang.String> groupSearchBaseDN,
                                                           Optional<java.lang.String> groupSearchCustomFilter,
                                                           Optional<java.lang.String> groupSearchType,
                                                           Optional<java.lang.String> searchBindDN,
                                                           Optional<java.lang.String> searchBindPassword,
                                                           java.lang.String[] serverURIs,
                                                           Optional<java.lang.String> userDNTemplate,
                                                           Optional<java.lang.String> userSearchBaseDN,
                                                           Optional<java.lang.String> userSearchFilter)

Method Detail

getAuthType

public Optional<java.lang.String> getAuthType()

Identifies which user authentication method to use. Must be one of the following: DirectBind SearchAndBind

setAuthType

public void setAuthType(Optional<java.lang.String> authType)

getGroupSearchBaseDN

public Optional<java.lang.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<java.lang.String> groupSearchBaseDN)

getGroupSearchCustomFilter

public Optional<java.lang.String> getGroupSearchCustomFilter()

For use with the CustomFilter search type, an LDAP filter to use to return the DNs of a users 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<java.lang.String> groupSearchCustomFilter)

getGroupSearchType

public Optional<java.lang.String> getGroupSearchType()

Controls the default group search filter used, and must be one of the following: NoGroups: No group support. ActiveDirectory: Nested membership of all of a users AD groups. MemberDN: MemberDN style groups (single level).

setGroupSearchType

public void setGroupSearchType(Optional<java.lang.String> groupSearchType)

getSearchBindDN

public Optional<java.lang.String> getSearchBindDN()

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<java.lang.String> searchBindDN)

getSearchBindPassword

public Optional<java.lang.String> getSearchBindPassword()

The password for the searchBindDN account used for searching.

setSearchBindPassword

public void setSearchBindPassword(Optional<java.lang.String> searchBindPassword)

getServerURIs

public java.lang.String[] getServerURIs()

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

setServerURIs

public void setServerURIs(java.lang.String[] serverURIs)

getUserDNTemplate

public Optional<java.lang.String> getUserDNTemplate()

A string that is used to form a fully qualified user DN. The string should have the placeholder text %USERNAME%, which is replaced with the username of the authenticating user.

setUserDNTemplate

public void setUserDNTemplate(Optional<java.lang.String> userDNTemplate)

getUserSearchBaseDN

public Optional<java.lang.String> getUserSearchBaseDN()

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

setUserSearchBaseDN

public void setUserSearchBaseDN(Optional<java.lang.String> userSearchBaseDN)

getUserSearchFilter

public Optional<java.lang.String> getUserSearchFilter()

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

setUserSearchFilter

public void setUserSearchFilter(Optional<java.lang.String> userSearchFilter)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static EnableLdapAuthenticationRequest.Builder builder()

asBuilder

public final EnableLdapAuthenticationRequest.Builder asBuilder()