Class LdapServerMetadataInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LdapServerMetadataInput.Builder,
LdapServerMetadataInput>
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasHosts()
For responses, this returns true if the service returned a value for the Hosts property.hosts()
Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.final String
roleBase()
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.final String
roleName()
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.final String
The LDAP search filter used to find roles within the roleBase.final Boolean
The directory search scope for the role.static Class
<? extends LdapServerMetadataInput.Builder> final String
Service account password.final String
Service account username.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userBase()
Select a particular subtree of the directory information tree (DIT) to search for user entries.final String
Specifies the name of the LDAP attribute for the user group membership.final String
The LDAP search filter used to find users within the userBase.final Boolean
The directory search scope for the user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasHosts
public final boolean hasHosts()For responses, this returns true if the service returned a value for the Hosts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
hosts
Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasHosts()
method.- Returns:
- Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
-
roleBase
The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
- Returns:
- The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.
-
roleName
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
- Returns:
- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
-
roleSearchMatching
The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
- Returns:
- The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.
-
roleSearchSubtree
The directory search scope for the role. If set to true, scope is to search the entire subtree.
- Returns:
- The directory search scope for the role. If set to true, scope is to search the entire subtree.
-
serviceAccountPassword
Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
- Returns:
- Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
-
serviceAccountUsername
Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
- Returns:
- Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.
-
userBase
Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
- Returns:
- Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
-
userRoleName
Specifies the name of the LDAP attribute for the user group membership.
- Returns:
- Specifies the name of the LDAP attribute for the user group membership.
-
userSearchMatching
The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
- Returns:
- The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
-
userSearchSubtree
The directory search scope for the user. If set to true, scope is to search the entire subtree.
- Returns:
- The directory search scope for the user. If set to true, scope is to search the entire subtree.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LdapServerMetadataInput.Builder,
LdapServerMetadataInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-