Package org.keycloak.services.clientregistration.policy.impl

Class ClientScopesClientRegistrationPolicyFactory

java.lang.Object

org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory

org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory

All Implemented Interfaces:

ComponentFactory<ClientRegistrationPolicy,ClientRegistrationPolicy>, ConfiguredProvider, ProviderFactory<ClientRegistrationPolicy>, ClientRegistrationPolicyFactory

public class ClientScopesClientRegistrationPolicyFactory
extends AbstractClientRegistrationPolicyFactory

Author:

Marek Posolda

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_DEFAULT_SCOPES
static final String	ALLOWED_CLIENT_SCOPES
static final String	PROVIDER_ID

Fields inherited from class org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory

sessionFactory

Constructor Summary

Constructors

Constructor	Description
ClientScopesClientRegistrationPolicyFactory()

Method Summary

Modifier and Type	Method	Description
ClientRegistrationPolicy	create(KeycloakSession session, ComponentModel model)
List<ProviderConfigProperty>	getConfigProperties()
List<ProviderConfigProperty>	getConfigProperties(KeycloakSession session)	Get config properties filled for particular session.
String	getHelpText()
String	getId()
void	validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel config)	Called before a component is created or updated.

Methods inherited from class org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory

close, init, postInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.component.ComponentFactory

create, getCommonProviderConfigProperties, getTypeMetadata, onCreate, onUpdate, preRemove

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, order

Field Details

PROVIDER_ID

public static final String PROVIDER_ID

See Also:

• Constant Field Values

ALLOWED_CLIENT_SCOPES

public static final String ALLOWED_CLIENT_SCOPES

See Also:

• Constant Field Values

ALLOW_DEFAULT_SCOPES

public static final String ALLOW_DEFAULT_SCOPES

See Also:

• Constant Field Values

Constructor Details

ClientScopesClientRegistrationPolicyFactory

public ClientScopesClientRegistrationPolicyFactory()

Method Details

create

public ClientRegistrationPolicy create(KeycloakSession session,
 ComponentModel model)

getHelpText

public String getHelpText()

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties(KeycloakSession session)

Description copied from interface: ClientRegistrationPolicyFactory

Get config properties filled for particular session. It assumes the session.getContext() has set realm

Specified by:

getConfigProperties in interface ClientRegistrationPolicyFactory

Overrides:

getConfigProperties in class AbstractClientRegistrationPolicyFactory

Returns:

getConfigProperties

public List<ProviderConfigProperty> getConfigProperties()

validateConfiguration

public void validateConfiguration(KeycloakSession session,
 RealmModel realm,
 ComponentModel config)
                           throws ComponentValidationException

Description copied from interface: ComponentFactory

Called before a component is created or updated. Allows you to validate the configuration

Specified by:

validateConfiguration in interface ComponentFactory<ClientRegistrationPolicy,ClientRegistrationPolicy>

Overrides:

validateConfiguration in class AbstractClientRegistrationPolicyFactory

Throws:

ComponentValidationException

getId

public String getId()