Share via

AuthenticationMethodLdapProperties Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.AuthenticationMethodLdapProperties

Implements

JsonSerializable<AuthenticationMethodLdapProperties>

public final class AuthenticationMethodLdapProperties
implements JsonSerializable<AuthenticationMethodLdapProperties>

Ldap authentication method properties. This feature is in preview.

Constructor Summary

Constructor Description
AuthenticationMethodLdapProperties()

Creates an instance of AuthenticationMethodLdapProperties class.

Method Summary

Modifier and Type Method and Description
Integer connectionTimeoutInMs()

Get the connectionTimeoutInMs property: Timeout for connecting to the LDAP server in miliseconds.
static AuthenticationMethodLdapProperties fromJson(JsonReader jsonReader)

Reads an instance of AuthenticationMethodLdapProperties from the JsonReader.
String searchBaseDistinguishedName()

Get the searchBaseDistinguishedName property: Distinguished name of the object to start the recursive search of users from.
String searchFilterTemplate()

Get the searchFilterTemplate property: Template to use for searching.
List<Certificate> serverCertificates()

Get the serverCertificates property: The serverCertificates property.
String serverHostname()

Get the serverHostname property: Hostname of the LDAP server.
Integer serverPort()

Get the serverPort property: Port of the LDAP server.
String serviceUserDistinguishedName()

Get the serviceUserDistinguishedName property: Distinguished name of the look up user account, who can look up user details on authentication.
String serviceUserPassword()

Get the serviceUserPassword property: Password of the look up user.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
AuthenticationMethodLdapProperties withConnectionTimeoutInMs(Integer connectionTimeoutInMs)

Set the connectionTimeoutInMs property: Timeout for connecting to the LDAP server in miliseconds.
AuthenticationMethodLdapProperties withSearchBaseDistinguishedName(String searchBaseDistinguishedName)

Set the searchBaseDistinguishedName property: Distinguished name of the object to start the recursive search of users from.
AuthenticationMethodLdapProperties withSearchFilterTemplate(String searchFilterTemplate)

Set the searchFilterTemplate property: Template to use for searching.
AuthenticationMethodLdapProperties withServerCertificates(List<Certificate> serverCertificates)

Set the serverCertificates property: The serverCertificates property.
AuthenticationMethodLdapProperties withServerHostname(String serverHostname)

Set the serverHostname property: Hostname of the LDAP server.
AuthenticationMethodLdapProperties withServerPort(Integer serverPort)

Set the serverPort property: Port of the LDAP server.
AuthenticationMethodLdapProperties withServiceUserDistinguishedName(String serviceUserDistinguishedName)

Set the serviceUserDistinguishedName property: Distinguished name of the look up user account, who can look up user details on authentication.
AuthenticationMethodLdapProperties withServiceUserPassword(String serviceUserPassword)

Set the serviceUserPassword property: Password of the look up user.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AuthenticationMethodLdapProperties

public AuthenticationMethodLdapProperties()

Creates an instance of AuthenticationMethodLdapProperties class.

Method Details

connectionTimeoutInMs

public Integer connectionTimeoutInMs()

Get the connectionTimeoutInMs property: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.

Returns:

the connectionTimeoutInMs value.

fromJson

public static AuthenticationMethodLdapProperties fromJson(JsonReader jsonReader)

Reads an instance of AuthenticationMethodLdapProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AuthenticationMethodLdapProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the AuthenticationMethodLdapProperties.

searchBaseDistinguishedName

public String searchBaseDistinguishedName()

Get the searchBaseDistinguishedName property: Distinguished name of the object to start the recursive search of users from.

Returns:

the searchBaseDistinguishedName value.

searchFilterTemplate

public String searchFilterTemplate()

Get the searchFilterTemplate property: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.

Returns:

the searchFilterTemplate value.

serverCertificates

public List serverCertificates()

Get the serverCertificates property: The serverCertificates property.

Returns:

the serverCertificates value.

serverHostname

public String serverHostname()

Get the serverHostname property: Hostname of the LDAP server.

Returns:

the serverHostname value.

serverPort

public Integer serverPort()

Get the serverPort property: Port of the LDAP server.

Returns:

the serverPort value.

serviceUserDistinguishedName

public String serviceUserDistinguishedName()

Get the serviceUserDistinguishedName property: Distinguished name of the look up user account, who can look up user details on authentication.

Returns:

the serviceUserDistinguishedName value.

serviceUserPassword

public String serviceUserPassword()

Get the serviceUserPassword property: Password of the look up user.

Returns:

the serviceUserPassword value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withConnectionTimeoutInMs

public AuthenticationMethodLdapProperties withConnectionTimeoutInMs(Integer connectionTimeoutInMs)

Set the connectionTimeoutInMs property: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.

Parameters:

connectionTimeoutInMs - the connectionTimeoutInMs value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withSearchBaseDistinguishedName

public AuthenticationMethodLdapProperties withSearchBaseDistinguishedName(String searchBaseDistinguishedName)

Set the searchBaseDistinguishedName property: Distinguished name of the object to start the recursive search of users from.

Parameters:

searchBaseDistinguishedName - the searchBaseDistinguishedName value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withSearchFilterTemplate

public AuthenticationMethodLdapProperties withSearchFilterTemplate(String searchFilterTemplate)

Set the searchFilterTemplate property: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.

Parameters:

searchFilterTemplate - the searchFilterTemplate value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withServerCertificates

public AuthenticationMethodLdapProperties withServerCertificates(List serverCertificates)

Set the serverCertificates property: The serverCertificates property.

Parameters:

serverCertificates - the serverCertificates value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withServerHostname

public AuthenticationMethodLdapProperties withServerHostname(String serverHostname)

Set the serverHostname property: Hostname of the LDAP server.

Parameters:

serverHostname - the serverHostname value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withServerPort

public AuthenticationMethodLdapProperties withServerPort(Integer serverPort)

Set the serverPort property: Port of the LDAP server.

Parameters:

serverPort - the serverPort value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withServiceUserDistinguishedName

public AuthenticationMethodLdapProperties withServiceUserDistinguishedName(String serviceUserDistinguishedName)

Set the serviceUserDistinguishedName property: Distinguished name of the look up user account, who can look up user details on authentication.

Parameters:

serviceUserDistinguishedName - the serviceUserDistinguishedName value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

withServiceUserPassword

public AuthenticationMethodLdapProperties withServiceUserPassword(String serviceUserPassword)

Set the serviceUserPassword property: Password of the look up user.

Parameters:

serviceUserPassword - the serviceUserPassword value to set.

Returns:

the AuthenticationMethodLdapProperties object itself.

Applies to