Package org.forgerock.openig.alias

Interface ClassAliasResolver

All Known Implementing Classes:

AssertionClassAliasResolver, CoreClassAliasResolver, FapiClassAliasResolver, McpClassAliasResolver, OAuth2ClassAliasResolver, OpenAMClassAliasResolver, PingClassAliasResolver, SamlClassAliasResolver, UmaClassAliasResolver

public interface ClassAliasResolver

This interface has to be implemented by each Identity Gateway module that wants to register new class aliases. These aliases are resolved at configuration time (when the objects declared in the heap will be created). Multiple aliases can map to a single type.

Method Summary

Modifier and Type	Method	Description
Class<?>	resolve(String alias)	Returns the Class mapped to the given alias or null if the alias is unknown.
default Set<Class<? extends Heaplet>>	supportedTypes()	Returns the set of heaplet classes supported by this alias resolver.
static Set<Class<? extends Heaplet>>	supportedTypes(Map<String,Class<?>> aliases)	A helper method for implementations of this interface.

Method Details

resolve

Class<?> resolve(String alias)

Returns the Class mapped to the given alias or null if the alias is unknown.

Parameters:

alias - short name

Returns:

the Class mapped to the given alias or null if the alias is unknown.

supportedTypes

default Set<Class<? extends Heaplet>> supportedTypes()

Returns the set of heaplet classes supported by this alias resolver.

Returns:

a (possibly empty, never null) set of heaplet classes

See Also:

• TypeInfo
• NoTypeInfo

supportedTypes

static Set<Class<? extends Heaplet>> supportedTypes(Map<String,Class<?>> aliases)

A helper method for implementations of this interface. Returns the set of heaplet classes supported by this alias resolver, based on the values contained in the aliases Map.

Parameters:

aliases - a Map of aliases to classes

Returns:

the set of heaplet classes supported by this alias resolver, based on the values contained in the aliases Map.