PasswordComplexityProperties (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.PasswordComplexityProperties

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class PasswordComplexityProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Configurable properties of password complexity requirement for the NSX node.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PasswordComplexityProperties.Builder
Builder class for PasswordComplexityProperties.

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

Field Summary

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PasswordComplexityProperties()` Default constructor.
`protected`	`PasswordComplexityProperties(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 PasswordComplexityProperties`	`_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 PasswordComplexityProperties`	`_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.Long`	`getDigits()` Number of digits (0..9) expected in user password.
`java.lang.String`	`getHashAlgorithm()` Possible values are: `HASH_ALGORITHM_SHA512` `HASH_ALGORITHM_SHA256` Sets hash/cryptographic algorithm type for new passwords.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.Long`	`getLowerChars()` Number of lower case characters (a..z) expected in user password.
`java.lang.Long`	`getMaximumPasswordLength()` Maximum number of characters allowed in password; user can not set their password of length greater than this parameter.
`java.lang.Long`	`getMaxRepeats()` Reject passwords which contain more than N same consecutive characters, like aaa or 7777.
`java.lang.Long`	`getMaxSequence()` Reject passwords which contain more than N monotonic character sequences.
`java.lang.Long`	`getMinimumPasswordLength()` Minimum number of characters expected in password; user can not set their password of length less than this parameter. NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above -
`java.lang.Long`	`getMinimumUniqueChars()` Number of character changes in the new password that differentiate it from the old password.
`java.lang.Long`	`getPasswordRemembrance()` Limit using a password that was used in past; users can not set the same password within the N generations.
`java.lang.Long`	`getRetryPrompt()` Prompt user at most N times before returning with error.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.Long`	`getSpecialChars()` Number of special characters (!@#$&*..) expected in user password.
`java.lang.Long`	`getUpperChars()` Number of upper case characters (A..Z) expected in user password.
`int`	`hashCode()`
`void`	`setDigits(java.lang.Long digits)` Number of digits (0..9) expected in user password.
`void`	`setHashAlgorithm(java.lang.String hashAlgorithm)` Possible values are: `HASH_ALGORITHM_SHA512` `HASH_ALGORITHM_SHA256` Sets hash/cryptographic algorithm type for new passwords.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setLowerChars(java.lang.Long lowerChars)` Number of lower case characters (a..z) expected in user password.
`void`	`setMaximumPasswordLength(java.lang.Long maximumPasswordLength)` Maximum number of characters allowed in password; user can not set their password of length greater than this parameter.
`void`	`setMaxRepeats(java.lang.Long maxRepeats)` Reject passwords which contain more than N same consecutive characters, like aaa or 7777.
`void`	`setMaxSequence(java.lang.Long maxSequence)` Reject passwords which contain more than N monotonic character sequences.
`void`	`setMinimumPasswordLength(java.lang.Long minimumPasswordLength)` Minimum number of characters expected in password; user can not set their password of length less than this parameter. NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above -
`void`	`setMinimumUniqueChars(java.lang.Long minimumUniqueChars)` Number of character changes in the new password that differentiate it from the old password.
`void`	`setPasswordRemembrance(java.lang.Long passwordRemembrance)` Limit using a password that was used in past; users can not set the same password within the N generations.
`void`	`setRetryPrompt(java.lang.Long retryPrompt)` Prompt user at most N times before returning with error.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSpecialChars(java.lang.Long specialChars)` Number of special characters (!@#$&*..) expected in user password.
`void`	`setUpperChars(java.lang.Long upperChars)` Number of upper case characters (A..Z) expected in user password.
`java.lang.String`	`toString()`

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

- Field Detail
  - HASH_ALGORITHM_SHA512
```
public static final java.lang.String HASH_ALGORITHM_SHA512
```
    See Also:
    
    Constant Field Values
  - HASH_ALGORITHM_SHA256
```
public static final java.lang.String HASH_ALGORITHM_SHA256
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - PasswordComplexityProperties
```
public PasswordComplexityProperties()
```
    Default constructor.
  - PasswordComplexityProperties
```
protected PasswordComplexityProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRetryPrompt
```
public java.lang.Long getRetryPrompt()
```
    Prompt user at most N times before returning with error. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRetryPrompt
```
public void setRetryPrompt(java.lang.Long retryPrompt)
```
    Prompt user at most N times before returning with error. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    retryPrompt - New value for the property.
  - getDigits
```
public java.lang.Long getDigits()
```
    Number of digits (0..9) expected in user password.
    N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.
    
    N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N digits.
    
    N = 0, policy will be not applicable.
    By default minimum 1 digit is required for a new password. format: int64
    
    Returns:
    
    The current value of the property.
  - setDigits
```
public void setDigits(java.lang.Long digits)
```
    Number of digits (0..9) expected in user password.
    N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.
    
    N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N digits.
    
    N = 0, policy will be not applicable.
    By default minimum 1 digit is required for a new password. format: int64
    
    Parameters:
    
    digits - New value for the property.
  - getHashAlgorithm
```
public java.lang.String getHashAlgorithm()
```
    Possible values are:
    - HASH_ALGORITHM_SHA512
    - HASH_ALGORITHM_SHA256
    Sets hash/cryptographic algorithm type for new passwords.
    Returns:
    
    The current value of the property.
  - setHashAlgorithm
```
public void setHashAlgorithm(java.lang.String hashAlgorithm)
```
    Possible values are:
    - HASH_ALGORITHM_SHA512
    - HASH_ALGORITHM_SHA256
    Sets hash/cryptographic algorithm type for new passwords.
    Parameters:
    
    hashAlgorithm - New value for the property.
  - getLowerChars
```
public java.lang.Long getLowerChars()
```
    Number of lower case characters (a..z) expected in user password.
    N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
    
    N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N lower case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 lower case character is required for a new password. format: int64
    
    Returns:
    
    The current value of the property.
  - setLowerChars
```
public void setLowerChars(java.lang.Long lowerChars)
```
    Number of lower case characters (a..z) expected in user password.
    N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
    
    N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N lower case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 lower case character is required for a new password. format: int64
    
    Parameters:
    
    lowerChars - New value for the property.
  - getMaxRepeats
```
public java.lang.Long getMaxRepeats()
```
    Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaxRepeats
```
public void setMaxRepeats(java.lang.Long maxRepeats)
```
    Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0. format: int64
    
    Parameters:
    
    maxRepeats - New value for the property.
  - getMaxSequence
```
public java.lang.Long getMaxSequence()
```
    Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaxSequence
```
public void setMaxSequence(java.lang.Long maxSequence)
```
    Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. format: int64
    
    Parameters:
    
    maxSequence - New value for the property.
  - getMaximumPasswordLength
```
public java.lang.Long getMaximumPasswordLength()
```
    Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters. format: int64
    
    Returns:
    
    The current value of the property.
  - setMaximumPasswordLength
```
public void setMaximumPasswordLength(java.lang.Long maximumPasswordLength)
```
    Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters. format: int64
    
    Parameters:
    
    maximumPasswordLength - New value for the property.
  - getMinimumPasswordLength
```
public java.lang.Long getMinimumPasswordLength()
```
    Minimum number of characters expected in password; user can not set their password of length less than this parameter.
    NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above -
    if existing appliance is configured with minimum_password_length less than current default value, then upgraded appliance will reset the configured setting back to recommended default; which can be explicitly modified back to original value or any other integer greater than or equal to supported minimum value.
    
    VMware recommends to set strong passwords for systems and appliances, further suggests to maintain strong minimum_password_length value. NSX resets this value to default and recommends to maintain upgraded default value or above for password complexity requirement.
    
    If any existing user passwords are set with length of less than newly configured minimum_password_length, then its recommended to reset the user passwords as per newly configured password complexity compliance.
    
    If existing minimum_password_length is greater than or equal to default value, which shall be retained as it is in newly upgraded appliance.
    By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed. format: int64
    
    Returns:
    
    The current value of the property.
  - setMinimumPasswordLength
```
public void setMinimumPasswordLength(java.lang.Long minimumPasswordLength)
```
    Minimum number of characters expected in password; user can not set their password of length less than this parameter.
    NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above -
    if existing appliance is configured with minimum_password_length less than current default value, then upgraded appliance will reset the configured setting back to recommended default; which can be explicitly modified back to original value or any other integer greater than or equal to supported minimum value.
    
    VMware recommends to set strong passwords for systems and appliances, further suggests to maintain strong minimum_password_length value. NSX resets this value to default and recommends to maintain upgraded default value or above for password complexity requirement.
    
    If any existing user passwords are set with length of less than newly configured minimum_password_length, then its recommended to reset the user passwords as per newly configured password complexity compliance.
    
    If existing minimum_password_length is greater than or equal to default value, which shall be retained as it is in newly upgraded appliance.
    By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed. format: int64
    
    Parameters:
    
    minimumPasswordLength - New value for the property.
  - getMinimumUniqueChars
```
public java.lang.Long getMinimumUniqueChars()
```
    Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. format: int64
    
    Returns:
    
    The current value of the property.
  - setMinimumUniqueChars
```
public void setMinimumUniqueChars(java.lang.Long minimumUniqueChars)
```
    Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. format: int64
    
    Parameters:
    
    minimumUniqueChars - New value for the property.
  - getPasswordRemembrance
```
public java.lang.Long getPasswordRemembrance()
```
    Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. format: int64
    
    Returns:
    
    The current value of the property.
  - setPasswordRemembrance
```
public void setPasswordRemembrance(java.lang.Long passwordRemembrance)
```
    Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. format: int64
    
    Parameters:
    
    passwordRemembrance - New value for the property.
  - getSpecialChars
```
public java.lang.Long getSpecialChars()
```
    Number of special characters (!@#$&*..) expected in user password.
    N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.
    
    N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N special case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 special character is required for a new password. format: int64
    
    Returns:
    
    The current value of the property.
  - setSpecialChars
```
public void setSpecialChars(java.lang.Long specialChars)
```
    Number of special characters (!@#$&*..) expected in user password.
    N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.
    
    N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N special case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 special character is required for a new password. format: int64
    
    Parameters:
    
    specialChars - New value for the property.
  - getUpperChars
```
public java.lang.Long getUpperChars()
```
    Number of upper case characters (A..Z) expected in user password.
    N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
    
    N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N upper case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 upper case character is required for a new password. format: int64
    
    Returns:
    
    The current value of the property.
  - setUpperChars
```
public void setUpperChars(java.lang.Long upperChars)
```
    Number of upper case characters (A..Z) expected in user password.
    N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
    
    N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum_password_length value upto N upper case characters.
    
    N = 0, policy will be not applicable.
    By default minimum 1 upper case character is required for a new password. format: int64
    
    Parameters:
    
    upperChars - 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 PasswordComplexityProperties _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 PasswordComplexityProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class PasswordComplexityProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HASH_ALGORITHM_SHA512

HASH_ALGORITHM_SHA256

__dynamicStructureFields

Constructor Detail

PasswordComplexityProperties

PasswordComplexityProperties

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRetryPrompt

setRetryPrompt

getDigits

setDigits

getHashAlgorithm

setHashAlgorithm

getLowerChars

setLowerChars

getMaxRepeats

setMaxRepeats

getMaxSequence

setMaxSequence

getMaximumPasswordLength

setMaximumPasswordLength

getMinimumPasswordLength

setMinimumPasswordLength

getMinimumUniqueChars

setMinimumUniqueChars

getPasswordRemembrance

setPasswordRemembrance

getSpecialChars

setSpecialChars

getUpperChars

setUpperChars

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2