ALBLdapAuthSettings (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBLdapAuthSettings

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBLdapAuthSettings
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer LdapAuthSettings object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBLdapAuthSettings.Builder
Builder class for ALBLdapAuthSettings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ALBLdapAuthSettings.Builder` Builder class for `ALBLdapAuthSettings`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`SECURITY_MODE_NONE`
`static java.lang.String`	`SECURITY_MODE_USE_LDAPS`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBLdapAuthSettings()
Default constructor.

protected ALBLdapAuthSettings(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ALBLdapAuthSettings()` Default constructor.
`protected`	`ALBLdapAuthSettings(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static ALBLdapAuthSettings`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static ALBLdapAuthSettings`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBaseDn()` The LDAP base DN.
`java.lang.Boolean`	`getBindAsAdministrator()` LDAP administrator credentials are used to search for users and group memberships.
`java.lang.String`	`getEmailAttribute()` LDAP attribute that refers to user email.
`java.lang.String`	`getFullNameAttribute()` LDAP attribute that refers to user's full name.
`java.lang.Long`	`getPort()` Query the LDAP servers on this port.
`java.lang.String`	`getSecurityMode()` Possible values are: `SECURITY_MODE_NONE` `SECURITY_MODE_USE_LDAPS` LDAP connection security mode.
`java.util.List<java.lang.String>`	`getServer()` LDAP server IP address or Hostname.
`ALBLdapDirectorySettings`	`getSettings()`
`ALBLdapUserBindSettings`	`getUserBind()`
`int`	`hashCode()`
`void`	`setBaseDn(java.lang.String baseDn)` The LDAP base DN.
`void`	`setBindAsAdministrator(java.lang.Boolean bindAsAdministrator)` LDAP administrator credentials are used to search for users and group memberships.
`void`	`setEmailAttribute(java.lang.String emailAttribute)` LDAP attribute that refers to user email.
`void`	`setFullNameAttribute(java.lang.String fullNameAttribute)` LDAP attribute that refers to user's full name.
`void`	`setPort(java.lang.Long port)` Query the LDAP servers on this port.
`void`	`setSecurityMode(java.lang.String securityMode)` Possible values are: `SECURITY_MODE_NONE` `SECURITY_MODE_USE_LDAPS` LDAP connection security mode.
`void`	`setServer(java.util.List<java.lang.String> server)` LDAP server IP address or Hostname.
`void`	`setSettings(ALBLdapDirectorySettings settings)`
`void`	`setUserBind(ALBLdapUserBindSettings userBind)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SECURITY_MODE_NONE
```
public static final java.lang.String SECURITY_MODE_NONE
```
    See Also:
    
    Constant Field Values
  - SECURITY_MODE_USE_LDAPS
```
public static final java.lang.String SECURITY_MODE_USE_LDAPS
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBLdapAuthSettings
```
public ALBLdapAuthSettings()
```
    Default constructor.
  - ALBLdapAuthSettings
```
protected ALBLdapAuthSettings(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getBaseDn
```
public java.lang.String getBaseDn()
```
    The LDAP base DN. For example, avinetworks.com would be DC=avinetworks,DC=com.
    
    Returns:
    
    The current value of the property.
  - setBaseDn
```
public void setBaseDn(java.lang.String baseDn)
```
    The LDAP base DN. For example, avinetworks.com would be DC=avinetworks,DC=com.
    
    Parameters:
    
    baseDn - New value for the property.
  - getBindAsAdministrator
```
public java.lang.Boolean getBindAsAdministrator()
```
    LDAP administrator credentials are used to search for users and group memberships. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setBindAsAdministrator
```
public void setBindAsAdministrator(java.lang.Boolean bindAsAdministrator)
```
    LDAP administrator credentials are used to search for users and group memberships. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    bindAsAdministrator - New value for the property.
  - getEmailAttribute
```
public java.lang.String getEmailAttribute()
```
    LDAP attribute that refers to user email. Default value when not specified in API or module is interpreted by ALB Controller as email.
    
    Returns:
    
    The current value of the property.
  - setEmailAttribute
```
public void setEmailAttribute(java.lang.String emailAttribute)
```
    LDAP attribute that refers to user email. Default value when not specified in API or module is interpreted by ALB Controller as email.
    
    Parameters:
    
    emailAttribute - New value for the property.
  - getFullNameAttribute
```
public java.lang.String getFullNameAttribute()
```
    LDAP attribute that refers to user's full name. Default value when not specified in API or module is interpreted by ALB Controller as name.
    
    Returns:
    
    The current value of the property.
  - setFullNameAttribute
```
public void setFullNameAttribute(java.lang.String fullNameAttribute)
```
    LDAP attribute that refers to user's full name. Default value when not specified in API or module is interpreted by ALB Controller as name.
    
    Parameters:
    
    fullNameAttribute - New value for the property.
  - getPort
```
public java.lang.Long getPort()
```
    Query the LDAP servers on this port. Default value when not specified in API or module is interpreted by ALB Controller as 389. format: int64
    
    Returns:
    
    The current value of the property.
  - setPort
```
public void setPort(java.lang.Long port)
```
    Query the LDAP servers on this port. Default value when not specified in API or module is interpreted by ALB Controller as 389. format: int64
    
    Parameters:
    
    port - New value for the property.
  - getSecurityMode
```
public java.lang.String getSecurityMode()
```
    Possible values are:
    - SECURITY_MODE_NONE
    - SECURITY_MODE_USE_LDAPS
    LDAP connection security mode. Enum options - AUTH_LDAP_SECURE_NONE, AUTH_LDAP_SECURE_USE_LDAPS.
    Returns:
    
    The current value of the property.
  - setSecurityMode
```
public void setSecurityMode(java.lang.String securityMode)
```
    Possible values are:
    - SECURITY_MODE_NONE
    - SECURITY_MODE_USE_LDAPS
    LDAP connection security mode. Enum options - AUTH_LDAP_SECURE_NONE, AUTH_LDAP_SECURE_USE_LDAPS.
    Parameters:
    
    securityMode - New value for the property.
  - getServer
```
public java.util.List<java.lang.String> getServer()
```
    LDAP server IP address or Hostname. Use IP address if an auth profile is used to configure Virtual Service. Minimum of 1 items required.
    
    Returns:
    
    The current value of the property.
  - setServer
```
public void setServer(java.util.List<java.lang.String> server)
```
    LDAP server IP address or Hostname. Use IP address if an auth profile is used to configure Virtual Service. Minimum of 1 items required.
    
    Parameters:
    
    server - New value for the property.
  - getSettings
```
public ALBLdapDirectorySettings getSettings()
```
    Returns:
    
    The current value of the property.
  - setSettings
```
public void setSettings(ALBLdapDirectorySettings settings)
```
    Parameters:
    
    settings - New value for the property.
  - getUserBind
```
public ALBLdapUserBindSettings getUserBind()
```
    Returns:
    
    The current value of the property.
  - setUserBind
```
public void setUserBind(ALBLdapUserBindSettings userBind)
```
    Parameters:
    
    userBind - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static ALBLdapAuthSettings _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static ALBLdapAuthSettings _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBLdapAuthSettings

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SECURITY_MODE_NONE

SECURITY_MODE_USE_LDAPS

__dynamicStructureFields

Constructor Detail

ALBLdapAuthSettings

ALBLdapAuthSettings

Method Detail

getBaseDn

setBaseDn

getBindAsAdministrator

setBindAsAdministrator

getEmailAttribute

setEmailAttribute

getFullNameAttribute

setFullNameAttribute

getPort

setPort

getSecurityMode

setSecurityMode

getServer

setServer

getSettings

setSettings

getUserBind

setUserBind

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2