Class LdapServerMetadataOutput

java.lang.Object
software.amazon.awssdk.services.mq.model.LdapServerMetadataOutput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LdapServerMetadataOutput.Builder,LdapServerMetadataOutput>
@Generated("software.amazon.awssdk:codegen") public final class LdapServerMetadataOutput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LdapServerMetadataOutput.Builder,LdapServerMetadataOutput>

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

See Also:

  • 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 the isEmpty() 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

      public final List<String> 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

      public final 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.

      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

      public final String 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

      public final 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.

      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

      public final Boolean 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.

    • serviceAccountUsername

      public final 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.

      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

      public final 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.

      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

      public final String 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

      public final 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.

      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

      public final Boolean 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

      public LdapServerMetadataOutput.Builder 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 interface ToCopyableBuilder<LdapServerMetadataOutput.Builder,LdapServerMetadataOutput>
      Returns:
      a builder for type T

    • builder

      public static LdapServerMetadataOutput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LdapServerMetadataOutput.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.