com.atlassian.crowd.directory.ldap.credential

Class ActiveDirectoryCredentialEncoder

java.lang.Object

com.atlassian.crowd.directory.ldap.credential.ActiveDirectoryCredentialEncoder

All Implemented Interfaces:

LDAPCredentialEncoder, LDAPCredentialEncoder.LDAPCredentialToByteArrayEncoder

public class ActiveDirectoryCredentialEncoder
extends Object
implements LDAPCredentialEncoder.LDAPCredentialToByteArrayEncoder

An encoder specifically for Microsoft Active Directory that first delegates to the provided base encoder and then converts the result of that to the byte[] format that Active Directory expects.

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
ActiveDirectoryCredentialEncoder(LDAPCredentialEncoder.LDAPCredentialToStringEncoder baseEncoder)

Method Summary

Modifier and Type	Method and Description
byte[]	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.
LDAPCredentialEncoder.LDAPCredentialToStringEncoder	getBaseEncoder()
boolean	supportsSettingEncryptedPasswords()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveDirectoryCredentialEncoder

public ActiveDirectoryCredentialEncoder(LDAPCredentialEncoder.LDAPCredentialToStringEncoder baseEncoder)

Method Detail

encodeCredential

public byte[] 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.LDAPCredentialToByteArrayEncoder

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:

byte[] instead of Object

Throws:

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.

getBaseEncoder

public LDAPCredentialEncoder.LDAPCredentialToStringEncoder getBaseEncoder()