LdapServerMetadataInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mq.model.LdapServerMetadataInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LdapServerMetadataInput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LdapServerMetadataInput()

Constructors
Constructor and Description
`LdapServerMetadataInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LdapServerMetadataInput`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getHosts()` Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.
`String`	`getRoleBase()` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`String`	`getRoleName()` Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
`String`	`getRoleSearchMatching()` The LDAP search filter used to find roles within the roleBase.
`Boolean`	`getRoleSearchSubtree()` The directory search scope for the role.
`String`	`getServiceAccountPassword()` Service account password.
`String`	`getServiceAccountUsername()` Service account username.
`String`	`getUserBase()` Select a particular subtree of the directory information tree (DIT) to search for user entries.
`String`	`getUserRoleName()` Specifies the name of the LDAP attribute for the user group membership.
`String`	`getUserSearchMatching()` The LDAP search filter used to find users within the userBase.
`Boolean`	`getUserSearchSubtree()` The directory search scope for the user.
`int`	`hashCode()`
`Boolean`	`isRoleSearchSubtree()` The directory search scope for the role.
`Boolean`	`isUserSearchSubtree()` The directory search scope for the user.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHosts(Collection<String> hosts)` Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.
`void`	`setRoleBase(String roleBase)` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`void`	`setRoleName(String roleName)` Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
`void`	`setRoleSearchMatching(String roleSearchMatching)` The LDAP search filter used to find roles within the roleBase.
`void`	`setRoleSearchSubtree(Boolean roleSearchSubtree)` The directory search scope for the role.
`void`	`setServiceAccountPassword(String serviceAccountPassword)` Service account password.
`void`	`setServiceAccountUsername(String serviceAccountUsername)` Service account username.
`void`	`setUserBase(String userBase)` Select a particular subtree of the directory information tree (DIT) to search for user entries.
`void`	`setUserRoleName(String userRoleName)` Specifies the name of the LDAP attribute for the user group membership.
`void`	`setUserSearchMatching(String userSearchMatching)` The LDAP search filter used to find users within the userBase.
`void`	`setUserSearchSubtree(Boolean userSearchSubtree)` The directory search scope for the user.
`String`	`toString()` Returns a string representation of this object.
`LdapServerMetadataInput`	`withHosts(Collection<String> hosts)` Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.
`LdapServerMetadataInput`	`withHosts(String... hosts)` Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory.
`LdapServerMetadataInput`	`withRoleBase(String roleBase)` The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
`LdapServerMetadataInput`	`withRoleName(String roleName)` Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
`LdapServerMetadataInput`	`withRoleSearchMatching(String roleSearchMatching)` The LDAP search filter used to find roles within the roleBase.
`LdapServerMetadataInput`	`withRoleSearchSubtree(Boolean roleSearchSubtree)` The directory search scope for the role.
`LdapServerMetadataInput`	`withServiceAccountPassword(String serviceAccountPassword)` Service account password.
`LdapServerMetadataInput`	`withServiceAccountUsername(String serviceAccountUsername)` Service account username.
`LdapServerMetadataInput`	`withUserBase(String userBase)` Select a particular subtree of the directory information tree (DIT) to search for user entries.
`LdapServerMetadataInput`	`withUserRoleName(String userRoleName)` Specifies the name of the LDAP attribute for the user group membership.
`LdapServerMetadataInput`	`withUserSearchMatching(String userSearchMatching)` The LDAP search filter used to find users within the userBase.
`LdapServerMetadataInput`	`withUserSearchSubtree(Boolean userSearchSubtree)` The directory search scope for the user.

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

- Constructor Detail
  - LdapServerMetadataInput
```
public LdapServerMetadataInput()
```
- Method Detail
  - getHosts
```
public List<String> getHosts()
```
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Returns:
    
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
  - setHosts
```
public void setHosts(Collection<String> hosts)
```
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
  - withHosts
```
public LdapServerMetadataInput withHosts(String... hosts)
```
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    NOTE: This method appends the values to the existing list (if any). Use setHosts(java.util.Collection) or withHosts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHosts
```
public LdapServerMetadataInput withHosts(Collection<String> hosts)
```
    Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Parameters:
    
    hosts - Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleBase
```
public void setRoleBase(String 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.
    
    Parameters:
    
    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.
  - getRoleBase
```
public String getRoleBase()
```
    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.
  - withRoleBase
```
public LdapServerMetadataInput withRoleBase(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleName
```
public void setRoleName(String roleName)
```
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    
    Parameters:
    
    roleName - Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
  - getRoleName
```
public String getRoleName()
```
    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.
  - withRoleName
```
public LdapServerMetadataInput withRoleName(String roleName)
```
    Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    
    Parameters:
    
    roleName - Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleSearchMatching
```
public void setRoleSearchMatching(String 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.
    
    Parameters:
    
    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.
  - getRoleSearchMatching
```
public String getRoleSearchMatching()
```
    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.
  - withRoleSearchMatching
```
public LdapServerMetadataInput withRoleSearchMatching(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleSearchSubtree
```
public void setRoleSearchSubtree(Boolean roleSearchSubtree)
```
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
  - getRoleSearchSubtree
```
public Boolean getRoleSearchSubtree()
```
    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.
  - withRoleSearchSubtree
```
public LdapServerMetadataInput withRoleSearchSubtree(Boolean roleSearchSubtree)
```
    The directory search scope for the role. If set to true, scope is to search the entire subtree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, scope is to search the entire subtree.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRoleSearchSubtree
```
public Boolean isRoleSearchSubtree()
```
    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.
  - setServiceAccountPassword
```
public void setServiceAccountPassword(String 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.
    
    Parameters:
    
    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.
  - getServiceAccountPassword
```
public String getServiceAccountPassword()
```
    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.
  - withServiceAccountPassword
```
public LdapServerMetadataInput withServiceAccountPassword(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceAccountUsername
```
public void setServiceAccountUsername(String 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.
    
    Parameters:
    
    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.
  - getServiceAccountUsername
```
public String getServiceAccountUsername()
```
    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.
  - withServiceAccountUsername
```
public LdapServerMetadataInput withServiceAccountUsername(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserBase
```
public void setUserBase(String 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.
    
    Parameters:
    
    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.
  - getUserBase
```
public String getUserBase()
```
    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.
  - withUserBase
```
public LdapServerMetadataInput withUserBase(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserRoleName
```
public void setUserRoleName(String userRoleName)
```
    Specifies the name of the LDAP attribute for the user group membership.
    
    Parameters:
    
    userRoleName - Specifies the name of the LDAP attribute for the user group membership.
  - getUserRoleName
```
public String getUserRoleName()
```
    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.
  - withUserRoleName
```
public LdapServerMetadataInput withUserRoleName(String userRoleName)
```
    Specifies the name of the LDAP attribute for the user group membership.
    
    Parameters:
    
    userRoleName - Specifies the name of the LDAP attribute for the user group membership.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserSearchMatching
```
public void setUserSearchMatching(String 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.
    
    Parameters:
    
    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.
  - getUserSearchMatching
```
public String getUserSearchMatching()
```
    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.
  - withUserSearchMatching
```
public LdapServerMetadataInput withUserSearchMatching(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserSearchSubtree
```
public void setUserSearchSubtree(Boolean userSearchSubtree)
```
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
  - getUserSearchSubtree
```
public Boolean getUserSearchSubtree()
```
    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.
  - withUserSearchSubtree
```
public LdapServerMetadataInput withUserSearchSubtree(Boolean userSearchSubtree)
```
    The directory search scope for the user. If set to true, scope is to search the entire subtree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, scope is to search the entire subtree.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUserSearchSubtree
```
public Boolean isUserSearchSubtree()
```
    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.
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LdapServerMetadataInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class LdapServerMetadataInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LdapServerMetadataInput

Method Detail

getHosts

setHosts

withHosts

withHosts

setRoleBase

getRoleBase

withRoleBase

setRoleName

getRoleName

withRoleName

setRoleSearchMatching

getRoleSearchMatching

withRoleSearchMatching

setRoleSearchSubtree

getRoleSearchSubtree

withRoleSearchSubtree

isRoleSearchSubtree

setServiceAccountPassword

getServiceAccountPassword

withServiceAccountPassword

setServiceAccountUsername

getServiceAccountUsername

withServiceAccountUsername

setUserBase

getUserBase

withUserBase

setUserRoleName

getUserRoleName

withUserRoleName

setUserSearchMatching

getUserSearchMatching

withUserSearchMatching

setUserSearchSubtree

getUserSearchSubtree

withUserSearchSubtree

isUserSearchSubtree

toString

equals

hashCode

clone

marshall