Modifier and Type	Class and Description
public static enum	Profile.Feature
public static enum	Profile.ProfileName

Modifier and Type	Field and Description
private static Profile	CURRENT
private static final Set<String>	ESSENTIAL_FEATURES
private static volatile Map<String, TreeSet<Profile.Feature>>	FEATURES
private final Map<Profile.Feature, Boolean>	features
private static final Logger	logger
private final Profile.ProfileName	profileName

Access	Constructor and Description
private	Profile(Profile.ProfileName profileName, Map<Profile.Feature, Boolean> features)

Modifier and Type	Method and Description
public static Profile	configure(ProfileConfigResolver... resolvers)
public static Profile	defaults()
public Set<Profile.Feature>	getAllFeatures()
public static Set<String>	getAllUnversionedFeatureNames()
public Set<Profile.Feature>	getDeprecatedFeatures()
public static Set<String>	getDisableableUnversionedFeatureNames()
public Set<Profile.Feature>	getDisabledFeatures()
public Set<Profile.Feature>	getExperimentalFeatures()
private static ProfileConfigResolver.FeatureConfig	getFeatureConfig(String unversionedFeature, ProfileConfigResolver... resolvers)
public Set<Profile.Feature>	getFeatures(Profile.Feature.Type type)
public Map<Profile.Feature, Boolean>	getFeatures()
public static Set<Profile.Feature>	getFeatureVersions(String feature) Get all of the feature versions for the given feature.
public static Profile	getInstance()
public Profile.ProfileName	getName()
private static Map<String, TreeSet<Profile.Feature>>	getOrderedFeatures() Compute a map of unversioned feature keys to ordered sets (highest first) of features.
public Set<Profile.Feature>	Returns: all features of type "preview" or "preview_disabled_by_default" getPreviewFeatures()
public static Profile	init(Profile.ProfileName profileName, Map<Profile.Feature, Boolean> features)
private static boolean	isEnabledByDefault(Profile.ProfileName profile, Profile.Feature f)
public static boolean	isFeatureEnabled(Profile.Feature feature)
private void	logUnsupportedFeatures()
private void	logUnsupportedFeatures(Profile.Feature.Type type, Set<Profile.Feature> checkedFeatures, Logger.Level level)
private static void	verifyConfig(Map<Profile.Feature, Boolean> features)

CURRENT	back to summary
private static Profile CURRENT

ESSENTIAL_FEATURES	back to summary
private static final Set<String> ESSENTIAL_FEATURES

FEATURES	back to summary
private static volatile Map<String, TreeSet<Profile.Feature>> FEATURES

features	back to summary
private final Map<Profile.Feature, Boolean> features

logger	back to summary
private static final Logger logger

profileName	back to summary
private final Profile.ProfileName profileName

Profile	back to summary
private Profile(Profile.ProfileName profileName, Map<Profile.Feature, Boolean> features)

Method Detail

configure	back to summary
public static Profile configure(ProfileConfigResolver... resolvers)

defaults	back to summary
public static Profile defaults()

getAllFeatures	back to summary
public Set<Profile.Feature> getAllFeatures()

getAllUnversionedFeatureNames	back to summary
public static Set<String> getAllUnversionedFeatureNames()

getDeprecatedFeatures	back to summary
public Set<Profile.Feature> getDeprecatedFeatures()

getDisableableUnversionedFeatureNames	back to summary
public static Set<String> getDisableableUnversionedFeatureNames()

getDisabledFeatures	back to summary
public Set<Profile.Feature> getDisabledFeatures()

getExperimentalFeatures	back to summary
public Set<Profile.Feature> getExperimentalFeatures()

getFeatureConfig	back to summary
private static ProfileConfigResolver.FeatureConfig getFeatureConfig(String unversionedFeature, ProfileConfigResolver... resolvers)

getFeatures	back to summary
public Set<Profile.Feature> getFeatures(Profile.Feature.Type type)

getFeatures	back to summary
public Map<Profile.Feature, Boolean> getFeatures()

getFeatureVersions	back to summary
public static Set<Profile.Feature> getFeatureVersions(String feature) Get all of the feature versions for the given feature. They will be ordered by priority. If the feature does not exist an empty collection will be returned.

getFeatureVersions

back to summary

public static Set<Profile.Feature> getFeatureVersions(String feature)

Get all of the feature versions for the given feature. They will be ordered by priority.

If the feature does not exist an empty collection will be returned.

getInstance	back to summary
public static Profile getInstance()

getName	back to summary
public Profile.ProfileName getName()

getOrderedFeatures back to summary

getOrderedFeatures	back to summary
private static Map<String, TreeSet<Profile.Feature>> getOrderedFeatures() Compute a map of unversioned feature keys to ordered sets (highest first) of features. The priority order for features is: The highest default supported version The highest non-default supported version The highest deprecated version The highest preview version The highest experimental version Note the `Type` enum is ordered based upon priority.

private static Map<String, TreeSet<Profile.Feature>> getOrderedFeatures()

Compute a map of unversioned feature keys to ordered sets (highest first) of features. The priority order for features is:

The highest default supported version
The highest non-default supported version
The highest deprecated version
The highest preview version
The highest experimental version

getPreviewFeatures	back to summary
public Set<Profile.Feature> getPreviewFeatures() Returns:Set<Profile.Feature> all features of type "preview" or "preview_disabled_by_default"

init	back to summary
public static Profile init(Profile.ProfileName profileName, Map<Profile.Feature, Boolean> features)

isEnabledByDefault	back to summary
private static boolean isEnabledByDefault(Profile.ProfileName profile, Profile.Feature f)

isFeatureEnabled	back to summary
public static boolean isFeatureEnabled(Profile.Feature feature)

logUnsupportedFeatures	back to summary
private void logUnsupportedFeatures()

logUnsupportedFeatures	back to summary
private void logUnsupportedFeatures(Profile.Feature.Type type, Set<Profile.Feature> checkedFeatures, Logger.Level level)

verifyConfig	back to summary
private static void verifyConfig(Map<Profile.Feature, Boolean> features)

org.keycloak.common back to summary

public final Enum Profile.Feature

Class Inheritance

extends Enum<Profile.Feature>

java.lang.Object
java.lang.Enum
org.keycloak.common.Profile.Feature

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	Profile.Feature.Type

Field Summary

Modifier and Type	Field and Description
public static final Profile.Feature	ACCOUNT2 Deprecated
public static final Profile.Feature	ACCOUNT3
public static final Profile.Feature	ACCOUNT_API
public static final Profile.Feature	ADMIN2
public static final Profile.Feature	ADMIN_API
public static final Profile.Feature	ADMIN_FINE_GRAINED_AUTHZ
public static final Profile.Feature	AUTHORIZATION
public static final Profile.Feature	CIBA
public static final Profile.Feature	CLIENT_POLICIES
public static final Profile.Feature	CLIENT_SECRET_ROTATION
public static final Profile.Feature	CLIENT_TYPES
public static final Profile.Feature	DECLARATIVE_UI
private Set<Profile.Feature>	dependencies
public static final Profile.Feature	DEVICE_FLOW
public static final Profile.Feature	DOCKER
public static final Profile.Feature	DPOP
public static final Profile.Feature	DYNAMIC_SCOPES
public static final Profile.Feature	FIPS
public static final Profile.Feature	HOSTNAME_V1
public static final Profile.Feature	IMPERSONATION
public static final Profile.Feature	JS_ADAPTER
public static final Profile.Feature	KERBEROS
private final String	key
private final String	label
public static final Profile.Feature	LINKEDIN_OAUTH Deprecated
public static final Profile.Feature	LOGIN2
public static final Profile.Feature	MULTI_SITE
public static final Profile.Feature	OFFLINE_SESSION_PRELOADING
public static final Profile.Feature	OID4VC_VCI
public static final Profile.Feature	PAR
public static final Profile.Feature	RECOVERY_CODES
public static final Profile.Feature	SCRIPTS
public static final Profile.Feature	STEP_UP_AUTHENTICATION
public static final Profile.Feature	TOKEN_EXCHANGE
public static final Profile.Feature	TRANSIENT_USERS
private final Profile.Feature.Type	type
private final String	unversionedKey
public static final Profile.Feature	UPDATE_EMAIL
private int	version
public static final Profile.Feature	WEB_AUTHN

Constructor Summary

Access	Constructor and Description
private	Feature(String label, Profile.Feature.Type type, Profile.Feature... dependencies)
private	Feature(String label, Profile.Feature.Type type, int version, Profile.Feature... dependencies) allowNameKey should be false for new versioned features to disallow using a legacy name, like account2

Method Summary

Modifier and Type	Method and Description
public Set<Profile.Feature>	getDependencies()
public String	getKey() Get the key that uniquely identifies this feature, may be used by users if allowNameKey is true.
public String	getLabel()
public Profile.Feature.Type	getType()
public String	getUnversionedKey() Return the key without any versioning.
public int	getVersion()
public String	getVersionedKey() Return the key in the form key:v{version}
public static Profile.Feature	valueOf(String name)
public static Profile.Feature[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ACCOUNT2	back to summary
public static final Profile.Feature ACCOUNT2 Deprecated Annotations @Deprecated

ACCOUNT3	back to summary
public static final Profile.Feature ACCOUNT3

ACCOUNT_API	back to summary
public static final Profile.Feature ACCOUNT_API

ADMIN2	back to summary
public static final Profile.Feature ADMIN2

ADMIN_API	back to summary
public static final Profile.Feature ADMIN_API

ADMIN_FINE_GRAINED_AUTHZ	back to summary
public static final Profile.Feature ADMIN_FINE_GRAINED_AUTHZ

AUTHORIZATION	back to summary
public static final Profile.Feature AUTHORIZATION

CIBA	back to summary
public static final Profile.Feature CIBA

CLIENT_POLICIES	back to summary
public static final Profile.Feature CLIENT_POLICIES

CLIENT_SECRET_ROTATION	back to summary
public static final Profile.Feature CLIENT_SECRET_ROTATION

CLIENT_TYPES	back to summary
public static final Profile.Feature CLIENT_TYPES

DECLARATIVE_UI	back to summary
public static final Profile.Feature DECLARATIVE_UI

dependencies	back to summary
private Set<Profile.Feature> dependencies

DEVICE_FLOW	back to summary
public static final Profile.Feature DEVICE_FLOW

DOCKER	back to summary
public static final Profile.Feature DOCKER

DPOP	back to summary
public static final Profile.Feature DPOP

DYNAMIC_SCOPES	back to summary
public static final Profile.Feature DYNAMIC_SCOPES

FIPS	back to summary
public static final Profile.Feature FIPS

HOSTNAME_V1	back to summary
public static final Profile.Feature HOSTNAME_V1

IMPERSONATION	back to summary
public static final Profile.Feature IMPERSONATION

JS_ADAPTER	back to summary
public static final Profile.Feature JS_ADAPTER

KERBEROS	back to summary
public static final Profile.Feature KERBEROS

key	back to summary
private final String key

label	back to summary
private final String label

LINKEDIN_OAUTH	back to summary
public static final Profile.Feature LINKEDIN_OAUTH Deprecated Annotations @Deprecated

LOGIN2	back to summary
public static final Profile.Feature LOGIN2

MULTI_SITE	back to summary
public static final Profile.Feature MULTI_SITE

OFFLINE_SESSION_PRELOADING	back to summary
public static final Profile.Feature OFFLINE_SESSION_PRELOADING

OID4VC_VCI	back to summary
public static final Profile.Feature OID4VC_VCI

PAR	back to summary
public static final Profile.Feature PAR

RECOVERY_CODES	back to summary
public static final Profile.Feature RECOVERY_CODES

SCRIPTS	back to summary
public static final Profile.Feature SCRIPTS

STEP_UP_AUTHENTICATION	back to summary
public static final Profile.Feature STEP_UP_AUTHENTICATION

TOKEN_EXCHANGE	back to summary
public static final Profile.Feature TOKEN_EXCHANGE

TRANSIENT_USERS	back to summary
public static final Profile.Feature TRANSIENT_USERS

type	back to summary
private final Profile.Feature.Type type

unversionedKey	back to summary
private final String unversionedKey

UPDATE_EMAIL	back to summary
public static final Profile.Feature UPDATE_EMAIL

version	back to summary
private int version

WEB_AUTHN	back to summary
public static final Profile.Feature WEB_AUTHN

Constructor Detail

Feature	back to summary
private Feature(String label, Profile.Feature.Type type, Profile.Feature... dependencies)

Feature	back to summary
private Feature(String label, Profile.Feature.Type type, int version, Profile.Feature... dependencies) allowNameKey should be false for new versioned features to disallow using a legacy name, like account2

Method Detail

getDependencies	back to summary
public Set<Profile.Feature> getDependencies()

getKey back to summary

public String getKey()

Get the key that uniquely identifies this feature, may be used by users if allowNameKey is true.

getVersionedKey() should instead be shown to users where possible.

getLabel	back to summary
public String getLabel()

getType	back to summary
public Profile.Feature.Type getType()

getUnversionedKey	back to summary
public String getUnversionedKey() Return the key without any versioning. All features of the same type will share this key.

getVersion	back to summary
public int getVersion()

getVersionedKey	back to summary
public String getVersionedKey() Return the key in the form key:v{version}

valueOf	back to summary
public static Profile.Feature valueOf(String name)

values	back to summary
public static Profile.Feature[] values()

org.keycloak.common back to summary

public final Enum Profile.Feature.Type

Class Inheritance

extends Enum<Profile.Feature.Type>

java.lang.Object
java.lang.Enum
org.keycloak.common.Profile.Feature.Type

Field Summary

Modifier and Type	Field and Description
public static final Profile.Feature.Type	DEFAULT
public static final Profile.Feature.Type	DEPRECATED
public static final Profile.Feature.Type	DISABLED_BY_DEFAULT
public static final Profile.Feature.Type	EXPERIMENTAL
private final String	label
public static final Profile.Feature.Type	PREVIEW
public static final Profile.Feature.Type	PREVIEW_DISABLED_BY_DEFAULT

Constructor Summary

Access	Constructor and Description
private	Type(String label)

Method Summary

Modifier and Type	Method and Description
public String	getLabel()
public static Profile.Feature.Type	valueOf(String name)
public static Profile.Feature.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DEFAULT	back to summary
public static final Profile.Feature.Type DEFAULT

DEPRECATED	back to summary
public static final Profile.Feature.Type DEPRECATED

DISABLED_BY_DEFAULT	back to summary
public static final Profile.Feature.Type DISABLED_BY_DEFAULT

EXPERIMENTAL	back to summary
public static final Profile.Feature.Type EXPERIMENTAL

label	back to summary
private final String label

PREVIEW	back to summary
public static final Profile.Feature.Type PREVIEW

PREVIEW_DISABLED_BY_DEFAULT	back to summary
public static final Profile.Feature.Type PREVIEW_DISABLED_BY_DEFAULT

Constructor Detail

Type	back to summary
private Type(String label)

Method Detail

getLabel	back to summary
public String getLabel()

valueOf	back to summary
public static Profile.Feature.Type valueOf(String name)

values	back to summary
public static Profile.Feature.Type[] values()

public Class Profile

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Profile.Feature

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Profile.Feature.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Profile.ProfileName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final Profile.ProfileName	DEFAULT
public static final Profile.ProfileName	PREVIEW

Modifier and Type	Method and Description
public static Profile.ProfileName	valueOf(String name)
public static Profile.ProfileName[]	values()