com.vmware.nsx_global_policy.model

Class ALBLdapDirectorySettings

java.lang.Object

com.vmware.nsx_global_policy.model.ALBLdapDirectorySettings

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class ALBLdapDirectorySettings
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

Advanced load balancer LdapDirectorySettings object

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ALBLdapDirectorySettings.Builder Builder class for ALBLdapDirectorySettings.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	GROUP_SEARCH_SCOPE_BASE
static java.lang.String	GROUP_SEARCH_SCOPE_ONE
static java.lang.String	GROUP_SEARCH_SCOPE_SUBTREE
static java.lang.String	USER_SEARCH_SCOPE_BASE
static java.lang.String	USER_SEARCH_SCOPE_ONE
static java.lang.String	USER_SEARCH_SCOPE_SUBTREE

Constructor Summary

Constructors

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

Method Summary

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 ALBLdapDirectorySettings	_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 ALBLdapDirectorySettings	_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	getAdminBindDn() LDAP Admin User DN.
java.lang.String	getGroupFilter() Group filter is used to identify groups during search.
java.lang.String	getGroupMemberAttribute() LDAP group attribute that identifies each of the group members.
java.lang.Boolean	getGroupMemberIsFullDn() Group member entries contain full DNs instead of just user id attribute values.
java.lang.String	getGroupSearchDn() LDAP group search DN is the root of search for a given group in the LDAP directory.
java.lang.String	getGroupSearchScope() Possible values are: GROUP_SEARCH_SCOPE_BASE GROUP_SEARCH_SCOPE_ONE GROUP_SEARCH_SCOPE_SUBTREE LDAP group search scope defines how deep to search for the group starting from the group search DN.
java.lang.Boolean	getIgnoreReferrals() During user or group search, ignore searching referrals.
java.lang.String	getPassword() LDAP Admin User Password.
java.util.List<java.lang.String>	getUserAttributes() LDAP user attributes to fetch on a successful user bind.
java.lang.String	getUserIdAttribute() LDAP user id attribute is the login attribute that uniquely identifies a single user record.
java.lang.String	getUserSearchDn() LDAP user search DN is the root of search for a given user in the LDAP directory.
java.lang.String	getUserSearchScope() Possible values are: USER_SEARCH_SCOPE_BASE USER_SEARCH_SCOPE_ONE USER_SEARCH_SCOPE_SUBTREE LDAP user search scope defines how deep to search for the user starting from user search DN.
int	hashCode()
void	setAdminBindDn(java.lang.String adminBindDn) LDAP Admin User DN.
void	setGroupFilter(java.lang.String groupFilter) Group filter is used to identify groups during search.
void	setGroupMemberAttribute(java.lang.String groupMemberAttribute) LDAP group attribute that identifies each of the group members.
void	setGroupMemberIsFullDn(java.lang.Boolean groupMemberIsFullDn) Group member entries contain full DNs instead of just user id attribute values.
void	setGroupSearchDn(java.lang.String groupSearchDn) LDAP group search DN is the root of search for a given group in the LDAP directory.
void	setGroupSearchScope(java.lang.String groupSearchScope) Possible values are: GROUP_SEARCH_SCOPE_BASE GROUP_SEARCH_SCOPE_ONE GROUP_SEARCH_SCOPE_SUBTREE LDAP group search scope defines how deep to search for the group starting from the group search DN.
void	setIgnoreReferrals(java.lang.Boolean ignoreReferrals) During user or group search, ignore searching referrals.
void	setPassword(java.lang.String password) LDAP Admin User Password.
void	setUserAttributes(java.util.List<java.lang.String> userAttributes) LDAP user attributes to fetch on a successful user bind.
void	setUserIdAttribute(java.lang.String userIdAttribute) LDAP user id attribute is the login attribute that uniquely identifies a single user record.
void	setUserSearchDn(java.lang.String userSearchDn) LDAP user search DN is the root of search for a given user in the LDAP directory.
void	setUserSearchScope(java.lang.String userSearchScope) Possible values are: USER_SEARCH_SCOPE_BASE USER_SEARCH_SCOPE_ONE USER_SEARCH_SCOPE_SUBTREE LDAP user search scope defines how deep to search for the user starting from user search DN.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GROUP_SEARCH_SCOPE_BASE

public static final java.lang.String GROUP_SEARCH_SCOPE_BASE

See Also:

Constant Field Values

GROUP_SEARCH_SCOPE_ONE

public static final java.lang.String GROUP_SEARCH_SCOPE_ONE

See Also:

Constant Field Values

GROUP_SEARCH_SCOPE_SUBTREE

public static final java.lang.String GROUP_SEARCH_SCOPE_SUBTREE

See Also:

Constant Field Values

USER_SEARCH_SCOPE_BASE

public static final java.lang.String USER_SEARCH_SCOPE_BASE

See Also:

Constant Field Values

USER_SEARCH_SCOPE_ONE

public static final java.lang.String USER_SEARCH_SCOPE_ONE

See Also:

Constant Field Values

USER_SEARCH_SCOPE_SUBTREE

public static final java.lang.String USER_SEARCH_SCOPE_SUBTREE

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

ALBLdapDirectorySettings

public ALBLdapDirectorySettings()

Default constructor.

ALBLdapDirectorySettings

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

Method Detail

getAdminBindDn

public java.lang.String getAdminBindDn()

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

Returns:

The current value of the property.

setAdminBindDn

public void 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.

getGroupFilter

public java.lang.String getGroupFilter()

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

Returns:

The current value of the property.

setGroupFilter

public void 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.

getGroupMemberAttribute

public java.lang.String getGroupMemberAttribute()

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.

Returns:

The current value of the property.

setGroupMemberAttribute

public void 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.

getGroupMemberIsFullDn

public java.lang.Boolean getGroupMemberIsFullDn()

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.

Returns:

The current value of the property.

setGroupMemberIsFullDn

public void 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.

getGroupSearchDn

public java.lang.String getGroupSearchDn()

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.

Returns:

The current value of the property.

setGroupSearchDn

public void 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.

getGroupSearchScope

public java.lang.String getGroupSearchScope()

Possible values are:

• GROUP_SEARCH_SCOPE_BASE
• GROUP_SEARCH_SCOPE_ONE
• 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.

Returns:

The current value of the property.

setGroupSearchScope

public void setGroupSearchScope(java.lang.String groupSearchScope)

Possible values are:

• GROUP_SEARCH_SCOPE_BASE
• GROUP_SEARCH_SCOPE_ONE
• 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.

getIgnoreReferrals

public java.lang.Boolean getIgnoreReferrals()

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

Returns:

The current value of the property.

setIgnoreReferrals

public void 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.

getPassword

public java.lang.String getPassword()

LDAP Admin User Password.

Returns:

The current value of the property.

setPassword

public void setPassword(java.lang.String password)

LDAP Admin User Password.

Parameters:

password - New value for the property.

getUserAttributes

public java.util.List<java.lang.String> getUserAttributes()

LDAP user attributes to fetch on a successful user bind.

Returns:

The current value of the property.

setUserAttributes

public void 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.

getUserIdAttribute

public java.lang.String getUserIdAttribute()

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

Returns:

The current value of the property.

setUserIdAttribute

public void 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.

getUserSearchDn

public java.lang.String getUserSearchDn()

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.

Returns:

The current value of the property.

setUserSearchDn

public void 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.

getUserSearchScope

public java.lang.String getUserSearchScope()

Possible values are:

• USER_SEARCH_SCOPE_BASE
• USER_SEARCH_SCOPE_ONE
• 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.

Returns:

The current value of the property.

setUserSearchScope

public void setUserSearchScope(java.lang.String userSearchScope)

Possible values are:

• USER_SEARCH_SCOPE_BASE
• USER_SEARCH_SCOPE_ONE
• 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.

_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 ALBLdapDirectorySettings _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 ALBLdapDirectorySettings _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.