Interface LDAPCredentialEncoder.LDAPCredentialToStringEncoder
- All Superinterfaces:
LDAPCredentialEncoder
- All Known Implementing Classes:
EncryptingCredentialEncoder,EnforceUnencryptedCredentialEncoder
- Enclosing interface:
- LDAPCredentialEncoder
public static interface LDAPCredentialEncoder.LDAPCredentialToStringEncoder
extends LDAPCredentialEncoder
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.atlassian.crowd.directory.ldap.credential.LDAPCredentialEncoder
LDAPCredentialEncoder.LDAPCredentialToByteArrayEncoder, LDAPCredentialEncoder.LDAPCredentialToStringEncoder -
Method Summary
Modifier and TypeMethodDescriptionencodeCredential(PasswordCredential passwordCredential) Given an plain-text password, encodes/encrypts it according to the settings required by the particular directory connector which this encoder is intended to be used with.Methods inherited from interface com.atlassian.crowd.directory.ldap.credential.LDAPCredentialEncoder
supportsSettingEncryptedPasswords
-
Method Details
-
encodeCredential
Description copied from interface:LDAPCredentialEncoderGiven an plain-text password, encodes/encrypts it according to the settings required by the particular directory connector which this encoder is intended to be used with. Return type MUST be either String or byte[].- Specified by:
encodeCredentialin interfaceLDAPCredentialEncoder- Parameters:
passwordCredential- The password credential to be encoded, guanteed to be non-null. If the subclass supports encrypting the given passwordCredential, it should NOT do so ifPasswordCredential.isEncryptedCredential()returnstrue(although it may still encode the credential to the format required by the directory). The value ofPasswordCredential.getCredential()is also guaranteed to be non-null.- Returns:
- String instead of Object
- Throws:
InvalidCredentialException- If the password could not be encoded.- See Also:
-