Package com.vmware.nsx_policy.model

Class IdentitySourceLdapServer

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class IdentitySourceLdapServer
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Information about a single LDAP server.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vmware.vapi.data.StructValue __dynamicStructureFields  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 IdentitySourceLdapServer _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 IdentitySourceLdapServer _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 getBindIdentity()
      A username used to authenticate to the directory when admnistering roles in NSX.
      java.util.List<java.lang.String> getCertificates()
      If using LDAPS or STARTTLS, provide the X.509 certificate of the LDAP server in PEM format.
      java.lang.Boolean getEnabled()
      Allows the LDAP server to be enabled or disabled.
      java.lang.String getPassword()
      A password used when authenticating to the directory.
      java.lang.String getUrl()
      The URL for the LDAP server.
      java.lang.Boolean getUseStarttls()
      If set to true, Use the StartTLS extended operation to upgrade the connection to TLS before sending any sensitive information.
      int hashCode()  
      void setBindIdentity​(java.lang.String bindIdentity)
      A username used to authenticate to the directory when admnistering roles in NSX.
      void 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.
      void setEnabled​(java.lang.Boolean enabled)
      Allows the LDAP server to be enabled or disabled.
      void setPassword​(java.lang.String password)
      A password used when authenticating to the directory.
      void setUrl​(java.lang.String url)
      The URL for the LDAP server.
      void 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.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • IdentitySourceLdapServer

        public IdentitySourceLdapServer()
        Default constructor.

      • IdentitySourceLdapServer

        protected IdentitySourceLdapServer​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getBindIdentity

        public java.lang.String getBindIdentity()
        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).
        Returns:
        The current value of the property.

      • setBindIdentity

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

      • getCertificates

        public java.util.List<java.lang.String> getCertificates()
        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.
        Returns:
        The current value of the property.

      • setCertificates

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

      • getEnabled

        public java.lang.Boolean getEnabled()
        Allows the LDAP server to be enabled or disabled. When disabled, this LDAP server will not be used to authenticate users.
        Returns:
        The current value of the property.

      • setEnabled

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

      • getPassword

        public java.lang.String getPassword()
        A password used when authenticating to the directory.
        Returns:
        The current value of the property.

      • setPassword

        public void setPassword​(java.lang.String password)
        A password used when authenticating to the directory.
        Parameters:
        password - New value for the property.

      • getUrl

        public java.lang.String getUrl()
        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.
        Returns:
        The current value of the property.

      • setUrl

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

      • getUseStarttls

        public java.lang.Boolean getUseStarttls()
        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.
        Returns:
        The current value of the property.

      • setUseStarttls

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

      • _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 IdentitySourceLdapServer _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 IdentitySourceLdapServer _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.