Class AbstractClientIdMetadataDocumentExecutorFactory
java.lang.Object
org.keycloak.protocol.oauth2.cimd.clientpolicy.executor.AbstractClientIdMetadataDocumentExecutorFactory
- All Implemented Interfaces:
ConfiguredProvider,EnvironmentDependentProviderFactory,ProviderFactory<ClientPolicyExecutorProvider>,ClientPolicyExecutorProviderFactory
- Direct Known Subclasses:
ClientIdMetadataDocumentExecutorFactory
public abstract class AbstractClientIdMetadataDocumentExecutorFactory
extends Object
implements ClientPolicyExecutorProviderFactory, EnvironmentDependentProviderFactory
The abstract class is the factory class of
AbstractClientIdMetadataDocumentExecutor.
It provides the following configurations:
- Client ID Verification / Client Metadata Verification (URL related)
- Allow http scheme: allows http scheme of a URI (for development environment)<
- Client ID Validation
- Trusted domains: only allow a URI whose hostname is under the one of the permitted domain (wildcard * can be used)
- Client Metadata Validation
- Restrict same domain: only allow {client_id} and {redirect_uri} parameter of an authorization request whose hostname is under the one of the permitted domain (wildcard * can be used)
- Required properties: only allow a client metadata that includes all required properties
- Author:
- Takashi Norimatsu
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static voidaddCommonConfigProperties(List<ProviderConfigProperty> configProperties) voidclose()voidinit(Config.Scope config) booleanisSupported(Config.Scope config) voidpostInit(KeycloakSessionFactory factory) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getConfigPropertiesMethods inherited from interface org.keycloak.provider.ProviderFactory
create, dependsOn, getId, order
-
Field Details
-
ALLOW_HTTP_SCHEME
- See Also:
-
TRUSTED_DOMAINS
- See Also:
-
REQUIRED_PROPERTIES
- See Also:
-
RESTRICT_SAME_DOMAIN
- See Also:
-
CONFIG_CIMD_PROVIDER_NAME
- See Also:
-
CONFIG_MIN_CACHE_TIME
- See Also:
-
CONFIG_MAX_CACHE_TIME
- See Also:
-
CONFIG_UPPER_LIMIT_METADATA_BYTES
- See Also:
-
providerConfig
-
-
Constructor Details
-
AbstractClientIdMetadataDocumentExecutorFactory
public AbstractClientIdMetadataDocumentExecutorFactory()
-
-
Method Details
-
init
- Specified by:
initin interfaceProviderFactory<ClientPolicyExecutorProvider>
-
postInit
- Specified by:
postInitin interfaceProviderFactory<ClientPolicyExecutorProvider>
-
close
public void close()- Specified by:
closein interfaceProviderFactory<ClientPolicyExecutorProvider>
-
getHelpText
- Specified by:
getHelpTextin interfaceConfiguredProvider
-
addCommonConfigProperties
-
getConfigMetadata
- Specified by:
getConfigMetadatain interfaceProviderFactory<ClientPolicyExecutorProvider>
-
isSupported
- Specified by:
isSupportedin interfaceClientPolicyExecutorProviderFactory- Specified by:
isSupportedin interfaceEnvironmentDependentProviderFactory
-