LdapProbeError (Java SDK for NSX Global Policy API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LdapProbeError
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Detail about one error encountered during a probe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LdapProbeError.Builder
Builder class for LdapProbeError.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ERROR_TYPE_BASE_DN_NOT_FOUND`
`static java.lang.String`	`ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN`
`static java.lang.String`	`ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED`
`static java.lang.String`	`ERROR_TYPE_BIND_DN_INVALID`
`static java.lang.String`	`ERROR_TYPE_BIND_EXCEPTION`
`static java.lang.String`	`ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR`
`static java.lang.String`	`ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR`
`static java.lang.String`	`ERROR_TYPE_CONNECTION_REFUSED`
`static java.lang.String`	`ERROR_TYPE_CONNECTION_TIMEOUT`
`static java.lang.String`	`ERROR_TYPE_GENERAL_ERROR`
`static java.lang.String`	`ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE`
`static java.lang.String`	`ERROR_TYPE_INVALID_CREDENTIALS`
`static java.lang.String`	`ERROR_TYPE_LDAP_SERVER_DISABLED`
`static java.lang.String`	`ERROR_TYPE_NO_ROUTE_TO_HOST`
`static java.lang.String`	`ERROR_TYPE_PORT_UNREACHABLE`
`static java.lang.String`	`ERROR_TYPE_SSL_HANDSHAKE_ERROR`
`static java.lang.String`	`ERROR_TYPE_STARTTLS_FAILED`
`static java.lang.String`	`ERROR_TYPE_UNKNOWN_HOST`

Constructor Summary

Constructors
Modifier Constructor and Description

LdapProbeError()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`LdapProbeError()` Default constructor.
`protected`	`LdapProbeError(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 LdapProbeError`	`_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 LdapProbeError`	`_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`	`getErrorType()` Possible values are: `ERROR_TYPE_BASE_DN_NOT_FOUND` `ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED` `ERROR_TYPE_BIND_DN_INVALID` `ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR` `ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR` `ERROR_TYPE_CONNECTION_REFUSED` `ERROR_TYPE_CONNECTION_TIMEOUT` `ERROR_TYPE_GENERAL_ERROR` `ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE` `ERROR_TYPE_INVALID_CREDENTIALS` `ERROR_TYPE_SSL_HANDSHAKE_ERROR` `ERROR_TYPE_STARTTLS_FAILED` `ERROR_TYPE_UNKNOWN_HOST` `ERROR_TYPE_NO_ROUTE_TO_HOST` `ERROR_TYPE_BIND_EXCEPTION` `ERROR_TYPE_PORT_UNREACHABLE` `ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN` `ERROR_TYPE_LDAP_SERVER_DISABLED` The cause of the error.
`int`	`hashCode()`
`void`	`setErrorType(java.lang.String errorType)` Possible values are: `ERROR_TYPE_BASE_DN_NOT_FOUND` `ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED` `ERROR_TYPE_BIND_DN_INVALID` `ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR` `ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR` `ERROR_TYPE_CONNECTION_REFUSED` `ERROR_TYPE_CONNECTION_TIMEOUT` `ERROR_TYPE_GENERAL_ERROR` `ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE` `ERROR_TYPE_INVALID_CREDENTIALS` `ERROR_TYPE_SSL_HANDSHAKE_ERROR` `ERROR_TYPE_STARTTLS_FAILED` `ERROR_TYPE_UNKNOWN_HOST` `ERROR_TYPE_NO_ROUTE_TO_HOST` `ERROR_TYPE_BIND_EXCEPTION` `ERROR_TYPE_PORT_UNREACHABLE` `ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN` `ERROR_TYPE_LDAP_SERVER_DISABLED` The cause of the error.
`java.lang.String`	`toString()`

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

- Field Detail
  - ERROR_TYPE_BASE_DN_NOT_FOUND
```
public static final java.lang.String ERROR_TYPE_BASE_DN_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED
```
public static final java.lang.String ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_BIND_DN_INVALID
```
public static final java.lang.String ERROR_TYPE_BIND_DN_INVALID
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR
```
public static final java.lang.String ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR
```
public static final java.lang.String ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_CONNECTION_REFUSED
```
public static final java.lang.String ERROR_TYPE_CONNECTION_REFUSED
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_CONNECTION_TIMEOUT
```
public static final java.lang.String ERROR_TYPE_CONNECTION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_GENERAL_ERROR
```
public static final java.lang.String ERROR_TYPE_GENERAL_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE
```
public static final java.lang.String ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_INVALID_CREDENTIALS
```
public static final java.lang.String ERROR_TYPE_INVALID_CREDENTIALS
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_SSL_HANDSHAKE_ERROR
```
public static final java.lang.String ERROR_TYPE_SSL_HANDSHAKE_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_STARTTLS_FAILED
```
public static final java.lang.String ERROR_TYPE_STARTTLS_FAILED
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_UNKNOWN_HOST
```
public static final java.lang.String ERROR_TYPE_UNKNOWN_HOST
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_NO_ROUTE_TO_HOST
```
public static final java.lang.String ERROR_TYPE_NO_ROUTE_TO_HOST
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_BIND_EXCEPTION
```
public static final java.lang.String ERROR_TYPE_BIND_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_PORT_UNREACHABLE
```
public static final java.lang.String ERROR_TYPE_PORT_UNREACHABLE
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN
```
public static final java.lang.String ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_LDAP_SERVER_DISABLED
```
public static final java.lang.String ERROR_TYPE_LDAP_SERVER_DISABLED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LdapProbeError
```
public LdapProbeError()
```
    Default constructor.
  - LdapProbeError
```
protected LdapProbeError(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getErrorType
```
public java.lang.String getErrorType()
```
    Possible values are:
    The cause of the error. BASE_DN_NOT_FOUND: The configured base DN does not exist on the LDAP server or is not readable. BIND_DN_AND_PASSWORD_REQUIRED: This server is configured to require a bind DN and password. Please add these to your LDAP server configuration. BIND_DN_INVALID: The bind DN or username provided is not valid on the LDAP server. Check that the bind DN is correct. This error may also indicate that the base DN in your configuration is incorrect. CERTIFICATE_HOSTNAME_MISMATCH_ERROR: The hostname configured for the LDAP server does not match the hostname in the server's certificate subject or alternative subject names. Be sure that the hostname you configure in NSX Manager matches one of those names. CERTIFICATE_MISMATCH_ERROR: The certificate presented by the LDAP server did not match the certificate in the configuration on the NSX Manager. CONNECTION_REFUSED: The connection was refused when contacting the LDAP server. Ensure that the LDAP server is running and that you are using the correct ip/hostname. CONNECTION_TIMEOUT: The connection timed out when contacting the LDAP server. Check the hostname/ip and any firewalls between the NSX Manager and the LDAP server. GENERAL_ERROR: An undetermined error occurred. INVALID_CONFIGURED_CERTIFICATE: The certificate configured for this LDAP server is invalid and could not be decoded. Check that the PEM-formatted certificate you provided is correct. INVALID_CREDENTIALS: The username and/or password are incorrect. SSL_HANDSHAKE_ERROR: An error occurred while establishing a secure connection with the LDAP server. Check that the LDAP server's certificate is correct, and that it is using an SSL/TLS cipher suite that is compatible with the NSX Manager. This error can also occur if the hostname you have configured for the LDAP server does not match any of the hostnames in the Subject Alternative Name records in the server certificate. STARTTLS_FAILED: Unable to use StartTLS to upgrade the connection to use TLS. Ensure that the LDAP server supports TLS and if not, use LDAP or LDAPS as the protocol. UNKNOWN_HOST: The hostname of the LDAP server could not be resolved. NO_ROUTE_TO_HOST: There is no network route to the host. BIND_EXCEPTION: A socket to the remote host could not be opened. PORT_UNREACHABLE: The LDAP port is not open on the remote host. BASE_DN_NOT_WITHIN_DOMAIN: For Active Directory, the base DN is not a subtree of the Domain Component tree corresponding to the LDAP domain. For example, if the domain is \"example.com\", the baseDN should be \"dc=example, dc=com\" or a subtree like \"ou=Users,dc=example,dc=com\". LDAP_SERVER_DISABLED: The LDAP server is marked as disabled in the NSX configuration and will not be used.
    Returns:
    
    The current value of the property.
  - setErrorType
```
public void setErrorType(java.lang.String errorType)
```
    Possible values are:
    The cause of the error. BASE_DN_NOT_FOUND: The configured base DN does not exist on the LDAP server or is not readable. BIND_DN_AND_PASSWORD_REQUIRED: This server is configured to require a bind DN and password. Please add these to your LDAP server configuration. BIND_DN_INVALID: The bind DN or username provided is not valid on the LDAP server. Check that the bind DN is correct. This error may also indicate that the base DN in your configuration is incorrect. CERTIFICATE_HOSTNAME_MISMATCH_ERROR: The hostname configured for the LDAP server does not match the hostname in the server's certificate subject or alternative subject names. Be sure that the hostname you configure in NSX Manager matches one of those names. CERTIFICATE_MISMATCH_ERROR: The certificate presented by the LDAP server did not match the certificate in the configuration on the NSX Manager. CONNECTION_REFUSED: The connection was refused when contacting the LDAP server. Ensure that the LDAP server is running and that you are using the correct ip/hostname. CONNECTION_TIMEOUT: The connection timed out when contacting the LDAP server. Check the hostname/ip and any firewalls between the NSX Manager and the LDAP server. GENERAL_ERROR: An undetermined error occurred. INVALID_CONFIGURED_CERTIFICATE: The certificate configured for this LDAP server is invalid and could not be decoded. Check that the PEM-formatted certificate you provided is correct. INVALID_CREDENTIALS: The username and/or password are incorrect. SSL_HANDSHAKE_ERROR: An error occurred while establishing a secure connection with the LDAP server. Check that the LDAP server's certificate is correct, and that it is using an SSL/TLS cipher suite that is compatible with the NSX Manager. This error can also occur if the hostname you have configured for the LDAP server does not match any of the hostnames in the Subject Alternative Name records in the server certificate. STARTTLS_FAILED: Unable to use StartTLS to upgrade the connection to use TLS. Ensure that the LDAP server supports TLS and if not, use LDAP or LDAPS as the protocol. UNKNOWN_HOST: The hostname of the LDAP server could not be resolved. NO_ROUTE_TO_HOST: There is no network route to the host. BIND_EXCEPTION: A socket to the remote host could not be opened. PORT_UNREACHABLE: The LDAP port is not open on the remote host. BASE_DN_NOT_WITHIN_DOMAIN: For Active Directory, the base DN is not a subtree of the Domain Component tree corresponding to the LDAP domain. For example, if the domain is \"example.com\", the baseDN should be \"dc=example, dc=com\" or a subtree like \"ou=Users,dc=example,dc=com\". LDAP_SERVER_DISABLED: The LDAP server is marked as disabled in the NSX configuration and will not be used.
    Parameters:
    
    errorType - 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 LdapProbeError _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 LdapProbeError _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LdapProbeError

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_TYPE_BASE_DN_NOT_FOUND

ERROR_TYPE_BIND_DN_AND_PASSWORD_REQUIRED

ERROR_TYPE_BIND_DN_INVALID

ERROR_TYPE_CERTIFICATE_HOSTNAME_MISMATCH_ERROR

ERROR_TYPE_CERTIFICATE_MISMATCH_ERROR

ERROR_TYPE_CONNECTION_REFUSED

ERROR_TYPE_CONNECTION_TIMEOUT

ERROR_TYPE_GENERAL_ERROR

ERROR_TYPE_INVALID_CONFIGURED_CERTIFICATE

ERROR_TYPE_INVALID_CREDENTIALS

ERROR_TYPE_SSL_HANDSHAKE_ERROR

ERROR_TYPE_STARTTLS_FAILED

ERROR_TYPE_UNKNOWN_HOST

ERROR_TYPE_NO_ROUTE_TO_HOST

ERROR_TYPE_BIND_EXCEPTION

ERROR_TYPE_PORT_UNREACHABLE

ERROR_TYPE_BASE_DN_NOT_WITHIN_DOMAIN

ERROR_TYPE_LDAP_SERVER_DISABLED

__dynamicStructureFields

Constructor Detail

LdapProbeError

LdapProbeError

Method Detail

getErrorType

setErrorType

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2