com.vmware.nsx_policy.model

Class IdentitySourceLdapServer.Builder

java.lang.Object

com.vmware.nsx_policy.model.IdentitySourceLdapServer.Builder

Enclosing class:

IdentitySourceLdapServer

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

Builder class for IdentitySourceLdapServer.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IdentitySourceLdapServer	build()
IdentitySourceLdapServer.Builder	setBindIdentity(java.lang.String bindIdentity) A username used to authenticate to the directory when admnistering roles in NSX.
IdentitySourceLdapServer.Builder	setCertificates(java.util.List<java.lang.String> certificates) If using LDAPS or STARTTLS, provide the X.509 certificate of the LDAP server in PEM format.
IdentitySourceLdapServer.Builder	setEnabled(java.lang.Boolean enabled) Allows the LDAP server to be enabled or disabled.
IdentitySourceLdapServer.Builder	setPassword(java.lang.String password) A password used when authenticating to the directory.
IdentitySourceLdapServer.Builder	setUrl(java.lang.String url) The URL for the LDAP server.
IdentitySourceLdapServer.Builder	setUseStarttls(java.lang.Boolean useStarttls) If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information.

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 IdentitySourceLdapServer.

Method Detail

setBindIdentity

public IdentitySourceLdapServer.Builder setBindIdentity(java.lang.String bindIdentity)

A username used to authenticate to the directory when admnistering roles in NSX. This user should have privileges to search the LDAP directory for groups and users. This user is also used in some cases (OpenLDAP) to look up an NSX user's distinguished name based on their NSX login name. If omitted, NSX will authenticate to the LDAP server using an LDAP anonymous bind operation. For Active Directory, provide a userPrincipalName (e.g. administrator@airius.com) or the full distinguished nane. For OpenLDAP, provide the distinguished name of the user (e.g. uid=admin, cn=airius, dc=com).

Parameters:

bindIdentity - New value for the property.

setCertificates

public IdentitySourceLdapServer.Builder setCertificates(java.util.List<java.lang.String> certificates)

If using LDAPS or STARTTLS, provide the X.509 certificate of the LDAP server in PEM format. This property is not required when connecting without TLS encryption and is ignored in that case.

Parameters:

certificates - New value for the property.

setEnabled

public IdentitySourceLdapServer.Builder setEnabled(java.lang.Boolean enabled)

Allows the LDAP server to be enabled or disabled. When disabled, this LDAP server will not be used to authenticate users.

Parameters:

enabled - New value for the property.

setPassword

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

A password used when authenticating to the directory.

Parameters:

password - New value for the property.

setUrl

public IdentitySourceLdapServer.Builder setUrl(java.lang.String url)

The URL for the LDAP server. Supported URL schemes are LDAP and LDAPS. Either a hostname or an IP address may be given, and the port number is optional and defaults to 389 for the LDAP scheme and 636 for the LDAPS scheme.

Parameters:

url - New value for the property.

setUseStarttls

public IdentitySourceLdapServer.Builder setUseStarttls(java.lang.Boolean useStarttls)

If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information. The LDAP server must support the StartTLS extended operation in order for this protocol to operate correctly. This option is ignored if the URL scheme is LDAPS.

Parameters:

useStarttls - New value for the property.

build

public IdentitySourceLdapServer build()