com.solidfire.element.api

Class LdapConfiguration

java.lang.Object

com.solidfire.element.api.LdapConfiguration

All Implemented Interfaces:

java.io.Serializable

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

LdapConfiguration LDAP Configuration object returns information about the LDAP configuration on SolidFire storage. LDAP information is returned with the API method GetLdapConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LdapConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
LdapConfiguration()
LdapConfiguration(java.lang.String authType, java.lang.Boolean enabled, java.lang.String groupSearchBaseDN, java.lang.String groupSearchCustomFilter, java.lang.String groupSearchType, java.lang.String searchBindDN, java.lang.String[] serverURIs, java.lang.String userDNTemplate, java.lang.String userSearchBaseDN, java.lang.String userSearchFilter)

Method Summary

Modifier and Type	Method and Description
LdapConfiguration.Builder	asBuilder()
static LdapConfiguration.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.String	getAuthType() Identifies which user authentcation method will be used.
java.lang.Boolean	getEnabled() Identifies whether or not the system is enabled for LDAP.
java.lang.String	getGroupSearchBaseDN() The base DN of the tree to start the group search (will do a subtree search from here).
java.lang.String	getGroupSearchCustomFilter() The custom search filter used.
java.lang.String	getGroupSearchType() Controls the default group search filter used, can be one of the following: NoGroups: No group support.
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).
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")
java.lang.String	getUserDNTemplate() A string that is used to form a fully qualified user DN.
java.lang.String	getUserSearchBaseDN() The base DN of the tree used to start the search (will do a subtree search from here).
java.lang.String	getUserSearchFilter() The LDAP filter used.
int	hashCode()
void	setAuthType(java.lang.String authType)
void	setEnabled(java.lang.Boolean enabled)
void	setGroupSearchBaseDN(java.lang.String groupSearchBaseDN)
void	setGroupSearchCustomFilter(java.lang.String groupSearchCustomFilter)
void	setGroupSearchType(java.lang.String groupSearchType)
void	setSearchBindDN(java.lang.String searchBindDN)
void	setServerURIs(java.lang.String[] serverURIs)
void	setUserDNTemplate(java.lang.String userDNTemplate)
void	setUserSearchBaseDN(java.lang.String userSearchBaseDN)
void	setUserSearchFilter(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

LdapConfiguration

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

LdapConfiguration

@Since(value="7.0")
public LdapConfiguration(java.lang.String authType,
                                             java.lang.Boolean enabled,
                                             java.lang.String groupSearchBaseDN,
                                             java.lang.String groupSearchCustomFilter,
                                             java.lang.String groupSearchType,
                                             java.lang.String searchBindDN,
                                             java.lang.String[] serverURIs,
                                             java.lang.String userDNTemplate,
                                             java.lang.String userSearchBaseDN,
                                             java.lang.String userSearchFilter)

Method Detail

getAuthType

public java.lang.String getAuthType()

Identifies which user authentcation method will be used. Valid values: DirectBind SearchAndBind

setAuthType

public void setAuthType(java.lang.String authType)

getEnabled

public java.lang.Boolean getEnabled()

Identifies whether or not the system is enabled for LDAP. Valid values: true false

setEnabled

public void setEnabled(java.lang.Boolean enabled)

getGroupSearchBaseDN

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

getGroupSearchCustomFilter

public java.lang.String getGroupSearchCustomFilter()

The custom search filter used.

setGroupSearchCustomFilter

public void setGroupSearchCustomFilter(java.lang.String groupSearchCustomFilter)

getGroupSearchType

public java.lang.String getGroupSearchType()

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

setGroupSearchType

public void setGroupSearchType(java.lang.String groupSearchType)

getSearchBindDN

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

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

A string that is used to form a fully qualified user DN.

setUserDNTemplate

public void setUserDNTemplate(java.lang.String userDNTemplate)

getUserSearchBaseDN

public java.lang.String getUserSearchBaseDN()

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

setUserSearchBaseDN

public void setUserSearchBaseDN(java.lang.String userSearchBaseDN)

getUserSearchFilter

public java.lang.String getUserSearchFilter()

The LDAP filter used.

setUserSearchFilter

public void setUserSearchFilter(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 LdapConfiguration.Builder builder()

asBuilder

public final LdapConfiguration.Builder asBuilder()