|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DigestMD5SASLMechanismHandlerCfgClient
A client-side interface for reading and modifying Digest MD5 SASL Mechanism Handler settings.
The DIGEST-MD5 SASL mechanism is used to perform all processing related to SASL DIGEST-MD5 authentication.
Method Summary | |
---|---|
ManagedObjectDefinition<? extends DigestMD5SASLMechanismHandlerCfgClient,? extends DigestMD5SASLMechanismHandlerCfg> |
definition()
Get the configuration definition associated with this Digest MD5 SASL Mechanism Handler. |
java.lang.String |
getIdentityMapper()
Gets the "identity-mapper" property. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.lang.String |
getRealm()
Gets the "realm" property. |
java.lang.String |
getServerFqdn()
Gets the "server-fqdn" property. |
void |
setIdentityMapper(java.lang.String value)
Sets the "identity-mapper" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setRealm(java.lang.String value)
Sets the "realm" property. |
void |
setServerFqdn(java.lang.String value)
Sets the "server-fqdn" property. |
Methods inherited from interface org.opends.server.admin.std.client.SASLMechanismHandlerCfgClient |
---|
isEnabled, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends DigestMD5SASLMechanismHandlerCfgClient,? extends DigestMD5SASLMechanismHandlerCfg> definition()
definition
in interface ConfigurationClient
definition
in interface SASLMechanismHandlerCfgClient
java.lang.String getIdentityMapper()
Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.
void setIdentityMapper(java.lang.String value) throws IllegalPropertyValueException
Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.
value
- The value of the "identity-mapper" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
getJavaClass
in interface SASLMechanismHandlerCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
setJavaClass
in interface SASLMechanismHandlerCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getRealm()
Specifies the realm that is to be used by the server for DIGEST-MD5 authentication.
If this value is not provided, then the server defaults to use a set of realm names that correspond to the defined suffixes.
void setRealm(java.lang.String value) throws IllegalPropertyValueException
Specifies the realm that is to be used by the server for DIGEST-MD5 authentication.
If this value is not provided, then the server defaults to use a set of realm names that correspond to the defined suffixes.
value
- The value of the "realm" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getServerFqdn()
Specifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.
If this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.
void setServerFqdn(java.lang.String value) throws IllegalPropertyValueException
Specifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.
If this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.
value
- The value of the "server-fqdn" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |