com.vmware.nsx_global_policy.model

Class ALBLdapDirectorySettings.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBLdapDirectorySettings.Builder

Enclosing class:

ALBLdapDirectorySettings

public static final class ALBLdapDirectorySettings.Builder
extends java.lang.Object

Builder class for ALBLdapDirectorySettings.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of ALBLdapDirectorySettings.

Method Summary

Modifier and Type	Method and Description
ALBLdapDirectorySettings	build()
ALBLdapDirectorySettings.Builder	setAdminBindDn(java.lang.String adminBindDn) LDAP Admin User DN.
ALBLdapDirectorySettings.Builder	setGroupFilter(java.lang.String groupFilter) Group filter is used to identify groups during search.
ALBLdapDirectorySettings.Builder	setGroupMemberAttribute(java.lang.String groupMemberAttribute) LDAP group attribute that identifies each of the group members.
ALBLdapDirectorySettings.Builder	setGroupMemberIsFullDn(java.lang.Boolean groupMemberIsFullDn) Group member entries contain full DNs instead of just user id attribute values.
ALBLdapDirectorySettings.Builder	setGroupSearchDn(java.lang.String groupSearchDn) LDAP group search DN is the root of search for a given group in the LDAP directory.
ALBLdapDirectorySettings.Builder	setGroupSearchScope(java.lang.String groupSearchScope) Possible values are: ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_BASE ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_ONE ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_SUBTREE LDAP group search scope defines how deep to search for the group starting from the group search DN.
ALBLdapDirectorySettings.Builder	setIgnoreReferrals(java.lang.Boolean ignoreReferrals) During user or group search, ignore searching referrals.
ALBLdapDirectorySettings.Builder	setPassword(java.lang.String password) LDAP Admin User Password.
ALBLdapDirectorySettings.Builder	setUserAttributes(java.util.List<java.lang.String> userAttributes) LDAP user attributes to fetch on a successful user bind.
ALBLdapDirectorySettings.Builder	setUserIdAttribute(java.lang.String userIdAttribute) LDAP user id attribute is the login attribute that uniquely identifies a single user record.
ALBLdapDirectorySettings.Builder	setUserSearchDn(java.lang.String userSearchDn) LDAP user search DN is the root of search for a given user in the LDAP directory.
ALBLdapDirectorySettings.Builder	setUserSearchScope(java.lang.String userSearchScope) Possible values are: ALBLdapDirectorySettings.USER_SEARCH_SCOPE_BASE ALBLdapDirectorySettings.USER_SEARCH_SCOPE_ONE ALBLdapDirectorySettings.USER_SEARCH_SCOPE_SUBTREE LDAP user search scope defines how deep to search for the user starting from user search DN.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of ALBLdapDirectorySettings.

Method Detail

setAdminBindDn

public ALBLdapDirectorySettings.Builder setAdminBindDn(java.lang.String adminBindDn)

LDAP Admin User DN. Administrator credentials are required to search for users under user search DN or groups under group search DN.

Parameters:

adminBindDn - New value for the property.

setGroupFilter

public ALBLdapDirectorySettings.Builder setGroupFilter(java.lang.String groupFilter)

Group filter is used to identify groups during search. Default value when not specified in API or module is interpreted by ALB Controller as (objectClass=(STAR)).

Parameters:

groupFilter - New value for the property.

setGroupMemberAttribute

public ALBLdapDirectorySettings.Builder setGroupMemberAttribute(java.lang.String groupMemberAttribute)

LDAP group attribute that identifies each of the group members. Default value when not specified in API or module is interpreted by ALB Controller as member.

Parameters:

groupMemberAttribute - New value for the property.

setGroupMemberIsFullDn

public ALBLdapDirectorySettings.Builder setGroupMemberIsFullDn(java.lang.Boolean groupMemberIsFullDn)

Group member entries contain full DNs instead of just user id attribute values. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

groupMemberIsFullDn - New value for the property.

setGroupSearchDn

public ALBLdapDirectorySettings.Builder setGroupSearchDn(java.lang.String groupSearchDn)

LDAP group search DN is the root of search for a given group in the LDAP directory. Only matching groups present in this LDAP directory sub-tree will be checked for user membership.

Parameters:

groupSearchDn - New value for the property.

setGroupSearchScope

public ALBLdapDirectorySettings.Builder setGroupSearchScope(java.lang.String groupSearchScope)

Possible values are:

• ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_BASE
• ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_ONE
• ALBLdapDirectorySettings.GROUP_SEARCH_SCOPE_SUBTREE

LDAP group search scope defines how deep to search for the group starting from the group search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Default value when not specified in API or module is interpreted by ALB Controller as AUTH_LDAP_SCOPE_SUBTREE.

Parameters:

groupSearchScope - New value for the property.

setIgnoreReferrals

public ALBLdapDirectorySettings.Builder setIgnoreReferrals(java.lang.Boolean ignoreReferrals)

During user or group search, ignore searching referrals. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

ignoreReferrals - New value for the property.

setPassword

public ALBLdapDirectorySettings.Builder setPassword(java.lang.String password)

LDAP Admin User Password.

Parameters:

password - New value for the property.

setUserAttributes

public ALBLdapDirectorySettings.Builder setUserAttributes(java.util.List<java.lang.String> userAttributes)

LDAP user attributes to fetch on a successful user bind.

Parameters:

userAttributes - New value for the property.

setUserIdAttribute

public ALBLdapDirectorySettings.Builder setUserIdAttribute(java.lang.String userIdAttribute)

LDAP user id attribute is the login attribute that uniquely identifies a single user record.

Parameters:

userIdAttribute - New value for the property.

setUserSearchDn

public ALBLdapDirectorySettings.Builder setUserSearchDn(java.lang.String userSearchDn)

LDAP user search DN is the root of search for a given user in the LDAP directory. Only user records present in this LDAP directory sub-tree will be validated.

Parameters:

userSearchDn - New value for the property.

setUserSearchScope

public ALBLdapDirectorySettings.Builder setUserSearchScope(java.lang.String userSearchScope)

Possible values are:

• ALBLdapDirectorySettings.USER_SEARCH_SCOPE_BASE
• ALBLdapDirectorySettings.USER_SEARCH_SCOPE_ONE
• ALBLdapDirectorySettings.USER_SEARCH_SCOPE_SUBTREE

LDAP user search scope defines how deep to search for the user starting from user search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Default value when not specified in API or module is interpreted by ALB Controller as AUTH_LDAP_SCOPE_ONE.

Parameters:

userSearchScope - New value for the property.

build

public ALBLdapDirectorySettings build()