org.pac4j.core.profile

Class AttributesDefinition

java.lang.Object

org.pac4j.core.profile.AttributesDefinition

public class AttributesDefinition
extends Object

This class is the definition of the attributes of a profile.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	allAttributesNames
protected Map<String,AttributeConverter<? extends Object>>	attributesConverters
protected List<String>	otherAttributesNames
protected List<String>	principalAttributesNames

Constructor Summary

Constructors

Constructor and Description
AttributesDefinition()

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(String name, AttributeConverter<? extends Object> converter) Add an attribute as a primary one and its converter to this attributes definition.
protected void	addAttribute(String name, AttributeConverter<? extends Object> converter, boolean principal) Add an attribute, its primary aspect and its converter to this attributes definition.
Object	convert(String name, Object value) Convert an attribute into the right type.
List<String>	getAllAttributes() Return all the attributes names.
List<String>	getOtherAttributes() Return the other attributes names.
List<String>	getPrincipalAttributes() Return the principal attributes names.

Methods inherited from class java.lang.Object

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

Field Detail

allAttributesNames

protected List<String> allAttributesNames

principalAttributesNames

protected List<String> principalAttributesNames

otherAttributesNames

protected List<String> otherAttributesNames

attributesConverters

protected Map<String,AttributeConverter<? extends Object>> attributesConverters

Constructor Detail

AttributesDefinition

public AttributesDefinition()

Method Detail

getAllAttributes

public List<String> getAllAttributes()

Return all the attributes names.

Returns:

all the attributes names

getPrincipalAttributes

public List<String> getPrincipalAttributes()

Return the principal attributes names.

Returns:

the principal attributes names

getOtherAttributes

public List<String> getOtherAttributes()

Return the other attributes names.

Returns:

the other attributes names

addAttribute

protected void addAttribute(String name,
                            AttributeConverter<? extends Object> converter)

Add an attribute as a primary one and its converter to this attributes definition.

Parameters:

name - name of the attribute

converter - converter

addAttribute

protected void addAttribute(String name,
                            AttributeConverter<? extends Object> converter,
                            boolean principal)

Add an attribute, its primary aspect and its converter to this attributes definition.

Parameters:

name - name of the attribute

converter - converter

principal - whether the attribute is principal

convert

public Object convert(String name,
                      Object value)

Convert an attribute into the right type. If no converter exists for this attribute name, the attribute is returned or null, depending on the ProfileHelper.enforceProfileDefinition setting.

Parameters:

name - name of the attribute

value - value of the attribute

Returns:

the converted attribute or null if no converter exists for this attribute name