Package de.hybris.platform.servicelayer.user.impl

Class DefaulPasswordEncoderService

java.lang.Object

de.hybris.platform.servicelayer.user.impl.DefaulPasswordEncoderService

All Implemented Interfaces:

PasswordEncoderService

Direct Known Subclasses:

LDAPPasswordEncoderService

public class DefaulPasswordEncoderService
extends java.lang.Object
implements PasswordEncoderService

Default implementation.

Constructor Summary

Constructors

Constructor	Description
DefaulPasswordEncoderService()

Method Summary

Modifier and Type	Method	Description
java.lang.String	decode(UserModel user)	Tries to decodes from the given user the encoded password based on the encoding set to the user.
java.lang.String	encode(UserModel user, java.lang.String plainTextPassword, java.lang.String passwordEncoding)	Encodes the given plainTextPassword with the corresponding PasswordEncoder (based on the passwordEncoding) and returns it.
java.util.Collection<java.lang.String>	getSupportedEncodings()
boolean	isSupportedEncoding(java.lang.String encoding)	Checks if the given password encoding is supported.
boolean	isValid(UserModel user, java.lang.String plainPassword)	Checks if the encoded password (stored in the user) matches the given plain text password.
boolean	isValid(UserModel user, java.lang.String encoding, java.lang.String encodedPassword)
void	setEncoderFactory(PasswordEncoderFactory encoderFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaulPasswordEncoderService

public DefaulPasswordEncoderService()

Method Detail

encode

public java.lang.String encode(UserModel user,
                               java.lang.String plainTextPassword,
                               java.lang.String passwordEncoding)
                        throws PasswordEncoderNotFoundException

Description copied from interface: PasswordEncoderService

Encodes the given plainTextPassword with the corresponding PasswordEncoder (based on the passwordEncoding) and returns it. The user can be used as 'salt' in the implementation of the PasswordEncoders

Specified by:

encode in interface PasswordEncoderService

Parameters:

user - can be used as 'salt'. See MD5PasswordEncoder

plainTextPassword - the plain password

passwordEncoding - based on this encoding the correct PasswordEncoder is used

Returns:

the encoded password

Throws:

PasswordEncoderNotFoundException - if for the given passwordEncoding no PasswordEncoder is known

decode

public java.lang.String decode(UserModel user)
                        throws PasswordEncoderNotFoundException,
                               CannotDecodePasswordException

Description copied from interface: PasswordEncoderService

Tries to decodes from the given user the encoded password based on the encoding set to the user.

see UserModel.getEncodedPassword() and UserModel.getPasswordEncoding()

Specified by:

decode in interface PasswordEncoderService

Parameters:

user - contains the encoded password and the encoding

Returns:

the password in plain text if possible

Throws:

PasswordEncoderNotFoundException - if for the given passwordEncoding no PasswordEncoder is known in the system

CannotDecodePasswordException - if the encoded password cannot be decoded, see MD5PasswordEncoder

isSupportedEncoding

public boolean isSupportedEncoding(java.lang.String encoding)

Description copied from interface: PasswordEncoderService

Checks if the given password encoding is supported.

Specified by:

isSupportedEncoding in interface PasswordEncoderService

Parameters:

encoding - the password encoding

Returns:

true if the given encoding is supported, false otherwise.

See Also:

PasswordEncoderConstants.DEFAULT_ENCODING

isValid

public boolean isValid(UserModel user,
                       java.lang.String plainPassword)

Description copied from interface: PasswordEncoderService

Checks if the encoded password (stored in the user) matches the given plain text password. For this the plain password will be encoded and compared with the user's encoded password.

Specified by:

isValid in interface PasswordEncoderService

Parameters:

user - the user contains the encoded password and the (password) encoding

plainPassword - the plain text password

Returns:

true if the encoded passwords matches, false otherwise

isValid

public boolean isValid(UserModel user,
                       java.lang.String encoding,
                       java.lang.String encodedPassword)

getSupportedEncodings

public java.util.Collection<java.lang.String> getSupportedEncodings()

Specified by:

getSupportedEncodings in interface PasswordEncoderService

Returns:

a collection with the supported encodings of this system.

setEncoderFactory

public void setEncoderFactory(PasswordEncoderFactory encoderFactory)