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
```
The metadata of the LDAP server used to authenticate and authorize connections to the broker.

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()` Fully qualified domain name of the LDAP server.
`String`	`getRoleBase()` Fully qualified name of the directory to search for a user’s 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 search criteria for groups.
`Boolean`	`getRoleSearchSubtree()` The directory search scope for the role.
`String`	`getServiceAccountPassword()` Service account password.
`String`	`getServiceAccountUsername()` Service account username.
`String`	`getUserBase()` Fully qualified name of the directory where you want to search for users.
`String`	`getUserRoleName()` Specifies the name of the LDAP attribute for the user group membership.
`String`	`getUserSearchMatching()` The search criteria for users.
`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)` Fully qualified domain name of the LDAP server.
`void`	`setRoleBase(String roleBase)` Fully qualified name of the directory to search for a user’s 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 search criteria for groups.
`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)` Fully qualified name of the directory where you want to search for users.
`void`	`setUserRoleName(String userRoleName)` Specifies the name of the LDAP attribute for the user group membership.
`void`	`setUserSearchMatching(String userSearchMatching)` The search criteria for users.
`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)` Fully qualified domain name of the LDAP server.
`LdapServerMetadataInput`	`withHosts(String... hosts)` Fully qualified domain name of the LDAP server.
`LdapServerMetadataInput`	`withRoleBase(String roleBase)` Fully qualified name of the directory to search for a user’s 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 search criteria for groups.
`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)` Fully qualified name of the directory where you want to search for users.
`LdapServerMetadataInput`	`withUserRoleName(String userRoleName)` Specifies the name of the LDAP attribute for the user group membership.
`LdapServerMetadataInput`	`withUserSearchMatching(String userSearchMatching)` The search criteria for users.
`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()
```
    Fully qualified domain name of the LDAP server. Optional failover server.
    
    Returns:
    
    Fully qualified domain name of the LDAP server. Optional failover server.
  - setHosts
```
public void setHosts(Collection<String> hosts)
```
    Fully qualified domain name of the LDAP server. Optional failover server.
    
    Parameters:
    
    hosts - Fully qualified domain name of the LDAP server. Optional failover server.
  - withHosts
```
public LdapServerMetadataInput withHosts(String... hosts)
```
    Fully qualified domain name of the LDAP server. 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 - Fully qualified domain name of the LDAP server. 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)
```
    Fully qualified domain name of the LDAP server. Optional failover server.
    
    Parameters:
    
    hosts - Fully qualified domain name of the LDAP server. Optional failover server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleBase
```
public void setRoleBase(String roleBase)
```
    Fully qualified name of the directory to search for a user’s groups.
    
    Parameters:
    
    roleBase - Fully qualified name of the directory to search for a user’s groups.
  - getRoleBase
```
public String getRoleBase()
```
    Fully qualified name of the directory to search for a user’s groups.
    
    Returns:
    
    Fully qualified name of the directory to search for a user’s groups.
  - withRoleBase
```
public LdapServerMetadataInput withRoleBase(String roleBase)
```
    Fully qualified name of the directory to search for a user’s groups.
    
    Parameters:
    
    roleBase - Fully qualified name of the directory to search for a user’s groups.
    
    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 search criteria for groups.
    
    Parameters:
    
    roleSearchMatching - The search criteria for groups.
  - getRoleSearchMatching
```
public String getRoleSearchMatching()
```
    The search criteria for groups.
    
    Returns:
    
    The search criteria for groups.
  - withRoleSearchMatching
```
public LdapServerMetadataInput withRoleSearchMatching(String roleSearchMatching)
```
    The search criteria for groups.
    
    Parameters:
    
    roleSearchMatching - The search criteria for groups.
    
    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 sub-tree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
  - getRoleSearchSubtree
```
public Boolean getRoleSearchSubtree()
```
    The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
    
    Returns:
    
    The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
  - withRoleSearchSubtree
```
public LdapServerMetadataInput withRoleSearchSubtree(Boolean roleSearchSubtree)
```
    The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
    
    Parameters:
    
    roleSearchSubtree - The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
    
    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 sub-tree.
    
    Returns:
    
    The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
  - setServiceAccountPassword
```
public void setServiceAccountPassword(String serviceAccountPassword)
```
    Service account password.
    
    Parameters:
    
    serviceAccountPassword - Service account password.
  - getServiceAccountPassword
```
public String getServiceAccountPassword()
```
    Service account password.
    
    Returns:
    
    Service account password.
  - withServiceAccountPassword
```
public LdapServerMetadataInput withServiceAccountPassword(String serviceAccountPassword)
```
    Service account password.
    
    Parameters:
    
    serviceAccountPassword - Service account password.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceAccountUsername
```
public void setServiceAccountUsername(String serviceAccountUsername)
```
    Service account username.
    
    Parameters:
    
    serviceAccountUsername - Service account username.
  - getServiceAccountUsername
```
public String getServiceAccountUsername()
```
    Service account username.
    
    Returns:
    
    Service account username.
  - withServiceAccountUsername
```
public LdapServerMetadataInput withServiceAccountUsername(String serviceAccountUsername)
```
    Service account username.
    
    Parameters:
    
    serviceAccountUsername - Service account username.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserBase
```
public void setUserBase(String userBase)
```
    Fully qualified name of the directory where you want to search for users.
    
    Parameters:
    
    userBase - Fully qualified name of the directory where you want to search for users.
  - getUserBase
```
public String getUserBase()
```
    Fully qualified name of the directory where you want to search for users.
    
    Returns:
    
    Fully qualified name of the directory where you want to search for users.
  - withUserBase
```
public LdapServerMetadataInput withUserBase(String userBase)
```
    Fully qualified name of the directory where you want to search for users.
    
    Parameters:
    
    userBase - Fully qualified name of the directory where you want to search for users.
    
    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 search criteria for users.
    
    Parameters:
    
    userSearchMatching - The search criteria for users.
  - getUserSearchMatching
```
public String getUserSearchMatching()
```
    The search criteria for users.
    
    Returns:
    
    The search criteria for users.
  - withUserSearchMatching
```
public LdapServerMetadataInput withUserSearchMatching(String userSearchMatching)
```
    The search criteria for users.
    
    Parameters:
    
    userSearchMatching - The search criteria for users.
    
    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 sub-tree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
  - getUserSearchSubtree
```
public Boolean getUserSearchSubtree()
```
    The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
    
    Returns:
    
    The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
  - withUserSearchSubtree
```
public LdapServerMetadataInput withUserSearchSubtree(Boolean userSearchSubtree)
```
    The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
    
    Parameters:
    
    userSearchSubtree - The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
    
    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 sub-tree.
    
    Returns:
    
    The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
  - 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.

Did this page help you?

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