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

Class RegistrationWebOriginsPolicy

java.lang.Object

org.keycloak.services.clientregistration.policy.impl.RegistrationWebOriginsPolicy

All Implemented Interfaces:

org.keycloak.provider.Provider, ClientRegistrationPolicy

public class RegistrationWebOriginsPolicy
extends Object
implements ClientRegistrationPolicy

Constructor Summary

Constructors

Constructor	Description
RegistrationWebOriginsPolicy(org.keycloak.models.KeycloakSession session, org.keycloak.component.ComponentModel model)

Method Summary

Modifier and Type	Method	Description
void	afterRegister(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	afterUpdate(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	beforeDelete(ClientRegistrationProvider provider, org.keycloak.models.ClientModel clientModel)
void	beforeRegister(ClientRegistrationContext context)
void	beforeUpdate(ClientRegistrationContext context, org.keycloak.models.ClientModel clientModel)
void	beforeView(ClientRegistrationProvider provider, org.keycloak.models.ClientModel clientModel)
Collection<String>	getAllowedOrigins()	Extra web origins this policy contributes to the CORS allow-list for responses produced by the client registration endpoints.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy

close

Constructor Details

RegistrationWebOriginsPolicy

public RegistrationWebOriginsPolicy(org.keycloak.models.KeycloakSession session,
 org.keycloak.component.ComponentModel model)

Method Details

beforeRegister

public void beforeRegister(ClientRegistrationContext context)
                    throws ClientRegistrationPolicyException

Specified by:

beforeRegister in interface ClientRegistrationPolicy

Throws:

ClientRegistrationPolicyException

afterRegister

public void afterRegister(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)

Specified by:

afterRegister in interface ClientRegistrationPolicy

beforeUpdate

public void beforeUpdate(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)
                  throws ClientRegistrationPolicyException

Specified by:

beforeUpdate in interface ClientRegistrationPolicy

Throws:

ClientRegistrationPolicyException

afterUpdate

public void afterUpdate(ClientRegistrationContext context,
 org.keycloak.models.ClientModel clientModel)

Specified by:

afterUpdate in interface ClientRegistrationPolicy

beforeView

public void beforeView(ClientRegistrationProvider provider,
 org.keycloak.models.ClientModel clientModel)
                throws ClientRegistrationPolicyException

Specified by:

beforeView in interface ClientRegistrationPolicy

Throws:

ClientRegistrationPolicyException

beforeDelete

public void beforeDelete(ClientRegistrationProvider provider,
 org.keycloak.models.ClientModel clientModel)
                  throws ClientRegistrationPolicyException

Specified by:

beforeDelete in interface ClientRegistrationPolicy

Throws:

ClientRegistrationPolicyException

getAllowedOrigins

public Collection<String> getAllowedOrigins()

Description copied from interface: ClientRegistrationPolicy

Extra web origins this policy contributes to the CORS allow-list for responses produced by the client registration endpoints. Origins are collected up-front so validation can happen in a single checkAllowedOrigins call before the handler runs.

Specified by:

getAllowedOrigins in interface ClientRegistrationPolicy