Package io.mosip.authentication.core.spi.indauth.match

Interface MatchType

public interface MatchType

Base interface for the match type.

Author:

Loganathan Sekar, Dinesh Karuppiah.T

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MatchType.Category	The Category Enum

Method Summary

Modifier and Type	Method	Description
Optional<MatchingStrategy>	getAllowedMatchingStrategy(MatchingStrategyType matchStrategyType)	Gets the allowed matching strategy for the MatchingStrategyType value.
MatchType.Category	getCategory()	Get the category of this MatchType.
BiFunction<Map<String,String>,Map<String,Object>,Map<String,String>>	getEntityInfoMapper()	Gets the Entity info mapper function.
Function<RequestDTO,Map<String,List<IdentityInfoDTO>>>	getIdentityInfoFunction()	Get the Identity Info Function.
default List<IdentityInfoDTO>	getIdentityInfoList(RequestDTO identity)	Get the IdentityInfoDTO list out of the identity block for this MatchType.
IdMapping	getIdMapping()	Gets the IDMapping.
default Function<AuthRequestDTO,Map<String,String>>	getReqestInfoFunction()	Get the Identity Info Function.
default boolean	hasIdEntityInfo()	Flag to fetch Identity Info.
default boolean	hasRequestEntityInfo()	Flag to fetch Request Entity Info.
default boolean	isDynamic()
default boolean	isMultiLanguage()	Flag to check MultiLanguage.
default boolean	isMultiLanguage(String propName, Map<String,List<IdentityInfoDTO>> identityEntity, MappingConfig mappingConfig)
default boolean	isPropMultiLang(String propName, MappingConfig cfg)	Check if the mapped property is of multi-language type.
default Map<String,Map.Entry<String,List<IdentityInfoDTO>>>	mapEntityInfo(Map<String,List<IdentityInfoDTO>> idEntity, IdInfoFetcher idInfoHelper)	To fetch Map Entity Info.
static <T> Set<T>	setOf(T... items)	Returns the set of given matching strategies.

Method Detail

getIdMapping

IdMapping getIdMapping()

Gets the IDMapping.

Returns:

ID Mapping

getAllowedMatchingStrategy

Optional<MatchingStrategy> getAllowedMatchingStrategy(MatchingStrategyType matchStrategyType)

Gets the allowed matching strategy for the MatchingStrategyType value.

Parameters:

matchStrategyType - the match strategy type

Returns:

the allowed matching strategy

getIdentityInfoFunction

Function<RequestDTO,Map<String,List<IdentityInfoDTO>>> getIdentityInfoFunction()

Get the Identity Info Function.

Returns:

the Identity Info Function

getReqestInfoFunction

default Function<AuthRequestDTO,Map<String,String>> getReqestInfoFunction()

Get the Identity Info Function.

Returns:

the reqest info function

getIdentityInfoList

default List<IdentityInfoDTO> getIdentityInfoList(RequestDTO identity)

Get the IdentityInfoDTO list out of the identity block for this MatchType.

Parameters:

identity - the IdentityDTO

Returns:

the list of IdentityInfoDTO

getEntityInfoMapper

BiFunction<Map<String,String>,Map<String,Object>,Map<String,String>> getEntityInfoMapper()

Gets the Entity info mapper function.

Returns:

the Entity info mapper function

getCategory

MatchType.Category getCategory()

Get the category of this MatchType.

Returns:

the category

hasIdEntityInfo

default boolean hasIdEntityInfo()

Flag to fetch Identity Info.

Returns:

boolean value true or false

hasRequestEntityInfo

default boolean hasRequestEntityInfo()

Flag to fetch Request Entity Info.

Returns:

the flag

isMultiLanguage

default boolean isMultiLanguage()

Flag to check MultiLanguage.

Returns:

the flag

isMultiLanguage

default boolean isMultiLanguage(String propName,
                                Map<String,List<IdentityInfoDTO>> identityEntity,
                                MappingConfig mappingConfig)

setOf

static <T> Set<T> setOf(T... items)

Returns the set of given matching strategies.

Parameters:

items - the matching strategies

Returns:

the sets the

mapEntityInfo

default Map<String,Map.Entry<String,List<IdentityInfoDTO>>> mapEntityInfo(Map<String,List<IdentityInfoDTO>> idEntity,
                                                                                      IdInfoFetcher idInfoHelper)
                                                                               throws IdAuthenticationBusinessException

To fetch Map Entity Info.

Parameters:

idEntity - the id entity

idInfoHelper - the id info helper

Returns:

the map

Throws:

IdAuthenticationBusinessException - the id authentication business exception

isPropMultiLang

default boolean isPropMultiLang(String propName,
                                MappingConfig cfg)

Check if the mapped property is of multi-language type.

Parameters:

propName - mapped property name

cfg - mapping

Returns:

true, if is prop multi lang

isDynamic

default boolean isDynamic()