Deprecated API

Contents

• Interfaces
• Classes
• Fields
• Methods
• Enum Constants

Deprecated Interfaces

Interface	Description
org.keycloak.cluster.ClusterProvider	This is only available when the legacy store is enabled. Support for this will be eventually removed.

Deprecated Classes

Class	Description
org.keycloak.storage.ImportRealmFromRepresentationEvent
org.keycloak.storage.PartialImportRealmFromRepresentationEvent

Deprecated Fields

Field	Description
org.keycloak.models.BrowserSecurityHeaders.realmDefaultHeaders
org.keycloak.models.LDAPConstants.USE_TRUSTSTORE_LDAPS_ONLY	Use LDAPConstants.USE_TRUSTSTORE_ALWAYS instead.

Deprecated Methods

Method	Description
org.keycloak.broker.provider.BrokeredIdentityContext.setName(String)	use BrokeredIdentityContext.setFirstName(String) and BrokeredIdentityContext.setLastName(String) instead
org.keycloak.component.AmphibianProviderFactory.create(KeycloakSession, ComponentModel)
org.keycloak.events.EventStoreProvider.clear()	Unused method. Currently, used only in the testsuite
org.keycloak.events.EventStoreProvider.clearAdmin()	Unused method. Currently, used only in the testsuite
org.keycloak.events.EventStoreProvider.clearExpiredEvents()	This method is problem from the performance perspective. Some storages can provide better way for doing this (e.g. entry lifespan in the Infinispan server, etc.). We need to leave solving event expiration to each storage provider separately using expiration field on entity level.
org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean)
org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean, String)
org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(GroupModel, boolean, String, Boolean)
org.keycloak.models.utils.ModelToRepresentation.toGroupHierarchy(KeycloakSession, RealmModel, boolean)
org.keycloak.provider.EnvironmentDependentProviderFactory.isSupported()	Prefer overriding/using the EnvironmentDependentProviderFactory.isSupported(Config.Scope) method.
org.keycloak.userprofile.UserProfileProvider.isEnabled(RealmModel)	should be removed once DeclarativeUserProfileProvider becomes the default.

Deprecated Enum Constants

Enum Constant	Description
org.keycloak.events.EventType.VALIDATE_ACCESS_TOKEN	see KEYCLOAK-2266
org.keycloak.events.EventType.VALIDATE_ACCESS_TOKEN_ERROR