com.atlassian.crowd.directory.ldap.credential

Class EnforceUnencryptedCredentialEncoder

java.lang.Object

com.atlassian.crowd.directory.ldap.credential.EnforceUnencryptedCredentialEncoder

All Implemented Interfaces:

LDAPCredentialEncoder, LDAPCredentialEncoder.LDAPCredentialToStringEncoder

public class EnforceUnencryptedCredentialEncoder
extends Object
implements LDAPCredentialEncoder.LDAPCredentialToStringEncoder

An encoder which passes a non-encrypted PasswordCredential's credential through untouched, but throws an exception for every already-encrypted (i.e. when PasswordCredential.isEncryptedCredential() returns true). The exception is PasswordCredential.NONE, in which case it generates a random password and returns that instead.

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
EnforceUnencryptedCredentialEncoder(PasswordHelper passwordHelper)

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.
PasswordHelper	getPasswordHelper()
boolean	supportsSettingEncryptedPasswords()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnforceUnencryptedCredentialEncoder

public EnforceUnencryptedCredentialEncoder(PasswordHelper passwordHelper)

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:

InvalidCredentialException - if PasswordCredential.isEncryptedCredential() returns true AND the given passwordCredential is not equal to PasswordCredential.NONE

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.

getPasswordHelper

public PasswordHelper getPasswordHelper()