Package com.unboundid.ldap.sdk
Class DIGESTMD5BindRequestProperties
- java.lang.Object
-
- com.unboundid.ldap.sdk.DIGESTMD5BindRequestProperties
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class DIGESTMD5BindRequestProperties extends java.lang.Object implements java.io.Serializable
This class provides a data structure that may be used to hold a number of properties that may be used during processing for a SASL DIGEST-MD5 bind operation.- See Also:
- Serialized Form
-
-
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.
-
-
-
Constructor Detail
-
DIGESTMD5BindRequestProperties
public DIGESTMD5BindRequestProperties(@NotNull java.lang.String authenticationID, @Nullable 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 benull
.password
- The password for the DIGEST-MD5 bind request. It may benull
if anonymous authentication is to be performed.
-
DIGESTMD5BindRequestProperties
public DIGESTMD5BindRequestProperties(@NotNull java.lang.String authenticationID, @Nullable 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 benull
.password
- The password for the DIGEST-MD5 bind request. It may benull
if anonymous authentication is to be performed.
-
DIGESTMD5BindRequestProperties
public DIGESTMD5BindRequestProperties(@NotNull java.lang.String authenticationID, @Nullable 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 benull
.password
- The password for the DIGEST-MD5 bind request. It may benull
if anonymous authentication is to be performed.
-
-
Method Detail
-
getAuthenticationID
@NotNull 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(@NotNull java.lang.String authenticationID)
Specifies the authentication ID for the DIGEST-MD5 bind request. It must not benull
, 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 benull
.
-
getAuthorizationID
@Nullable 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(@Nullable java.lang.String authorizationID)
Specifies the authorization ID for the DIGEST-MD5 bind request. It may benull
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
@NotNull 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(@NotNull java.lang.String password)
Specifies the password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.- Parameters:
password
- The password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.
-
setPassword
public void setPassword(@NotNull byte[] password)
Specifies the password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.- Parameters:
password
- The password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.
-
setPassword
public void setPassword(@Nullable ASN1OctetString password)
Specifies the password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.- Parameters:
password
- The password for the DIGEST-MD5 bind request. It may benull
or empty when authenticating as the anonymous user.
-
getRealm
@Nullable 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(@Nullable java.lang.String realm)
Specifies the realm for the DIGEST-MD5 bind request. It may benull
if no realm should be included in the bind request.- Parameters:
realm
- The realm for the DIGEST-MD5 bind request. It may benull
if no realm should be included in the bind request.
-
getAllowedQoP
@NotNull public 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.- 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(@Nullable 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 isnull
or empty, then a list containing only theSASLQualityOfProtection.AUTH
quality of protection value will be used.
-
setAllowedQoP
public void setAllowedQoP(@Nullable 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 isnull
or empty, then a list containing only theSASLQualityOfProtection.AUTH
quality of protection value will be used.
-
toString
@NotNull public java.lang.String toString()
Retrieves a string representation of the DIGEST-MD5 bind request properties.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the DIGEST-MD5 bind request properties.
-
-