de.hybris.platform.cockpit.security

Class AuthenticationExceptionToLabelConverter

java.lang.Object

de.hybris.platform.cockpit.security.AuthenticationExceptionToLabelConverter

All Implemented Interfaces:

Converter<AuthenticationException,Label>

public class AuthenticationExceptionToLabelConverter
extends java.lang.Object
implements Converter<AuthenticationException,Label>

Converts the AuthenticationException to a localized label key to be displayed on the login form. Use configurable authenticationExceptionMessageMapping to match labels with authentication exception class.

Constructor Summary

Constructors

Constructor and Description
AuthenticationExceptionToLabelConverter()

Method Summary

Modifier and Type	Method and Description
Label	convert(AuthenticationException source) Converts the source object, creating a new instance of the destination type
Label	convert(AuthenticationException source, Label prototype) Convert the source object by filling the prototype
protected java.util.Map<java.lang.Class,java.lang.String>	getAuthenticationExceptionMessageMapping()
protected java.lang.String	getDefaultLabel()
protected java.util.List<java.lang.Class>	getWarningExceptions()
void	setAuthenticationExceptionMessageMapping(java.util.Map<java.lang.Class,java.lang.String> authenticationExceptionMessageMapping)
void	setDefaultLabel(java.lang.String defaultLabel)
void	setWarningExceptions(java.util.List<java.lang.Class> warningExceptions)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.servicelayer.dto.converter.Converter

convertAll, convertAllIgnoreExceptions, getLogger

Constructor Detail

AuthenticationExceptionToLabelConverter

public AuthenticationExceptionToLabelConverter()

Method Detail

convert

public Label convert(AuthenticationException source)
              throws ConversionException

Description copied from interface: Converter

Converts the source object, creating a new instance of the destination type

Specified by:

convert in interface Converter<AuthenticationException,Label>

Parameters:

source - the source object

Returns:

the converted object

Throws:

ConversionException - if an error occurs

getDefaultLabel

protected java.lang.String getDefaultLabel()

convert

public Label convert(AuthenticationException source,
                     Label prototype)
              throws ConversionException

Description copied from interface: Converter

Convert the source object by filling the prototype

Specified by:

convert in interface Converter<AuthenticationException,Label>

Parameters:

source - the source object

prototype - the prototype to fill

Returns:

the converted object, identical to the prototype

Throws:

ConversionException - if an error occurs

getAuthenticationExceptionMessageMapping

protected java.util.Map<java.lang.Class,java.lang.String> getAuthenticationExceptionMessageMapping()

Returns:

the authenticationExceptionMessageMapping

setAuthenticationExceptionMessageMapping

public void setAuthenticationExceptionMessageMapping(java.util.Map<java.lang.Class,java.lang.String> authenticationExceptionMessageMapping)

Parameters:

authenticationExceptionMessageMapping - the authenticationExceptionMessageMapping to set

setDefaultLabel

public void setDefaultLabel(java.lang.String defaultLabel)

Parameters:

defaultLabel - the defaultLabel to set

getWarningExceptions

protected java.util.List<java.lang.Class> getWarningExceptions()

Returns:

the warningExceptions

setWarningExceptions

public void setWarningExceptions(java.util.List<java.lang.Class> warningExceptions)

Parameters:

warningExceptions - the warningExceptions to set