Class DIGESTMD5BindRequestProperties

    • Constructor Summary

      Constructors 
      Constructor Description
      DIGESTMD5BindRequestProperties​(java.lang.String authenticationID, byte[] password)
      Creates a new set of DIGEST-MD5 bind request properties with the provided information.
      DIGESTMD5BindRequestProperties​(java.lang.String authenticationID, ASN1OctetString password)
      Creates a new set of DIGEST-MD5 bind request properties with the provided information.
      DIGESTMD5BindRequestProperties​(java.lang.String authenticationID, java.lang.String password)
      Creates a new set of DIGEST-MD5 bind request properties with the provided information.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<SASLQualityOfProtection> getAllowedQoP()
      Retrieves the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
      java.lang.String getAuthenticationID()
      Retrieves the authentication ID for the DIGEST-MD5 bind request.
      java.lang.String getAuthorizationID()
      Retrieves the authorization ID for the DIGEST-MD5 bind request.
      ASN1OctetString getPassword()
      Retrieves the password for the DIGEST-MD5 bind request.
      java.lang.String getRealm()
      Retrieves the realm for the DIGEST-MD5 bind request.
      void setAllowedQoP​(SASLQualityOfProtection... allowedQoP)
      Specifies the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
      void setAllowedQoP​(java.util.List<SASLQualityOfProtection> allowedQoP)
      Specifies the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
      void setAuthenticationID​(java.lang.String authenticationID)
      Specifies the authentication ID for the DIGEST-MD5 bind request.
      void setAuthorizationID​(java.lang.String authorizationID)
      Specifies the authorization ID for the DIGEST-MD5 bind request.
      void setPassword​(byte[] password)
      Specifies the password for the DIGEST-MD5 bind request.
      void setPassword​(ASN1OctetString password)
      Specifies the password for the DIGEST-MD5 bind request.
      void setPassword​(java.lang.String password)
      Specifies the password for the DIGEST-MD5 bind request.
      void setRealm​(java.lang.String realm)
      Specifies the realm for the DIGEST-MD5 bind request.
      java.lang.String toString()
      Retrieves a string representation of the DIGEST-MD5 bind request properties.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of the DIGEST-MD5 bind request properties to the provided buffer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DIGESTMD5BindRequestProperties

        public DIGESTMD5BindRequestProperties​(java.lang.String authenticationID,
                                              java.lang.String password)
        Creates a new set of DIGEST-MD5 bind request properties with the provided information.
        Parameters:
        authenticationID - The authentication ID for the DIGEST-MD5 bind request. It must not be null.
        password - The password for the DIGEST-MD5 bind request. It may be null if anonymous authentication is to be performed.
      • DIGESTMD5BindRequestProperties

        public DIGESTMD5BindRequestProperties​(java.lang.String authenticationID,
                                              byte[] password)
        Creates a new set of DIGEST-MD5 bind request properties with the provided information.
        Parameters:
        authenticationID - The authentication ID for the DIGEST-MD5 bind request. It must not be null.
        password - The password for the DIGEST-MD5 bind request. It may be null if anonymous authentication is to be performed.
      • DIGESTMD5BindRequestProperties

        public DIGESTMD5BindRequestProperties​(java.lang.String authenticationID,
                                              ASN1OctetString password)
        Creates a new set of DIGEST-MD5 bind request properties with the provided information.
        Parameters:
        authenticationID - The authentication ID for the DIGEST-MD5 bind request. It must not be null.
        password - The password for the DIGEST-MD5 bind request. It may be null if anonymous authentication is to be performed.
    • Method Detail

      • getAuthenticationID

        public java.lang.String getAuthenticationID()
        Retrieves the authentication ID for the DIGEST-MD5 bind request.
        Returns:
        The authentication ID for the DIGEST-MD5 bind request.
      • setAuthenticationID

        public void setAuthenticationID​(java.lang.String authenticationID)
        Specifies the authentication ID for the DIGEST-MD5 bind request. It must not be null, and should generally start with "dn:" followed by the full DN for the target user (or just "dn:" for anonymous), or "u:" followed by the username for the target user.
        Parameters:
        authenticationID - The authentication ID for the DIGEST-MD5 bind request. It must not be null.
      • getAuthorizationID

        public java.lang.String getAuthorizationID()
        Retrieves the authorization ID for the DIGEST-MD5 bind request.
        Returns:
        The authorization ID for the DIGEST-MD5 bind request, or null if no authorization ID should be included in the bind request.
      • setAuthorizationID

        public void setAuthorizationID​(java.lang.String authorizationID)
        Specifies the authorization ID for the DIGEST-MD5 bind request. It may be null if not alternate authorization identity is needed. If provided, the authorization ID should generally start with "dn:" followed by the full DN for the target user (or just "dn:" for anonymous), or "u:" followed by the username for the target user.
        Parameters:
        authorizationID - The authorization ID for the DIGEST-MD5 bind request.
      • getPassword

        public ASN1OctetString getPassword()
        Retrieves the password for the DIGEST-MD5 bind request.
        Returns:
        The password for the DIGEST-MD5 bind request.
      • setPassword

        public void setPassword​(java.lang.String password)
        Specifies the password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
        Parameters:
        password - The password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
      • setPassword

        public void setPassword​(byte[] password)
        Specifies the password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
        Parameters:
        password - The password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
      • setPassword

        public void setPassword​(ASN1OctetString password)
        Specifies the password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
        Parameters:
        password - The password for the DIGEST-MD5 bind request. It may be null or empty when authenticating as the anonymous user.
      • getRealm

        public java.lang.String getRealm()
        Retrieves the realm for the DIGEST-MD5 bind request.
        Returns:
        The realm for the DIGEST-MD5 bind request, or null if no realm should be included in the bind request.
      • setRealm

        public void setRealm​(java.lang.String realm)
        Specifies the realm for the DIGEST-MD5 bind request. It may be null if no realm should be included in the bind request.
        Parameters:
        realm - The realm for the DIGEST-MD5 bind request. It may be null if no realm should be included in the bind request.
      • getAllowedQoP

        public java.util.List<SASLQualityOfProtectiongetAllowedQoP()
        Retrieves the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
        Returns:
        The list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
      • setAllowedQoP

        public void setAllowedQoP​(java.util.List<SASLQualityOfProtection> allowedQoP)
        Specifies the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
        Parameters:
        allowedQoP - The list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred. If this is null or empty, then a list containing only the SASLQualityOfProtection.AUTH quality of protection value will be used.
      • setAllowedQoP

        public void setAllowedQoP​(SASLQualityOfProtection... allowedQoP)
        Specifies the list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred.
        Parameters:
        allowedQoP - The list of allowed qualities of protection that may be used for communication that occurs on the connection after the authentication has completed, in order from most preferred to least preferred. If this is null or empty, then a list containing only the SASLQualityOfProtection.AUTH quality of protection value will be used.
      • toString

        public java.lang.String toString()
        Retrieves a string representation of the DIGEST-MD5 bind request properties.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of the DIGEST-MD5 bind request properties.
      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of the DIGEST-MD5 bind request properties to the provided buffer.
        Parameters:
        buffer - The buffer to which the information should be appended.