com.atlassian.crowd.directory.ldap.credential

Class EncryptingCredentialEncoder

java.lang.Object

com.atlassian.crowd.directory.ldap.credential.EncryptingCredentialEncoder

All Implemented Interfaces:

LDAPCredentialEncoder, LDAPCredentialEncoder.LDAPCredentialToStringEncoder

public class EncryptingCredentialEncoder
extends Object
implements LDAPCredentialEncoder.LDAPCredentialToStringEncoder

Translates a clear-text password into an encrypted one if it isn't already encrypted, using the encryption method specified by the directory settings.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.crowd.directory.ldap.credential.LDAPCredentialEncoder

LDAPCredentialEncoder.LDAPCredentialToByteArrayEncoder, LDAPCredentialEncoder.LDAPCredentialToStringEncoder

Constructor Summary

Constructors

Constructor and Description
EncryptingCredentialEncoder(PasswordEncoderFactory passwordEncoderFactory, String encryptionAlgorithm)

Method Summary

Modifier and Type	Method and Description
String	encodeCredential(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.
String	getEncryptionAlgorithm()
PasswordEncoderFactory	getPasswordEncoderFactory()
boolean	supportsSettingEncryptedPasswords()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncryptingCredentialEncoder

public EncryptingCredentialEncoder(PasswordEncoderFactory passwordEncoderFactory,
                                   String encryptionAlgorithm)

Method Detail

encodeCredential

public String encodeCredential(PasswordCredential passwordCredential)
                        throws InvalidCredentialException

Description copied from interface: LDAPCredentialEncoder

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. Return type MUST be either String or byte[].

Specified by:

encodeCredential in interface LDAPCredentialEncoder

Specified by:

encodeCredential in interface LDAPCredentialEncoder.LDAPCredentialToStringEncoder

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 if PasswordCredential.isEncryptedCredential() returns true (although it may still encode the credential to the format required by the directory). The value of PasswordCredential.getCredential() is also guaranteed to be non-null.

Returns:

String instead of Object

Throws:

PasswordEncoderNotFoundException - (runtime exception) if the encoder for the specified encryption method cannot be found

InvalidCredentialException - If the password could not be encoded.

See Also:

LDAPCredentialEncoder.encodeCredential(com.atlassian.crowd.embedded.api.PasswordCredential)

supportsSettingEncryptedPasswords

public boolean supportsSettingEncryptedPasswords()

Specified by:

supportsSettingEncryptedPasswords in interface LDAPCredentialEncoder

Returns:

true if the LDAP directory supports client-side encryption of passwords.

getPasswordEncoderFactory

public PasswordEncoderFactory getPasswordEncoderFactory()

getEncryptionAlgorithm

public String getEncryptionAlgorithm()