Package org.keycloak.services.clientpolicy.context.admin

Class ClientProtocolMapperRegisterContext

java.lang.Object

org.keycloak.services.clientpolicy.context.admin.ClientProtocolMapperRegisterContext

All Implemented Interfaces:

ClientPolicyContext, ClientProtocolMapperContext, ClientModelContext, ClientPolicyCRUDContext

public class ClientProtocolMapperRegisterContext
extends Object

Fired when protocol mappers are being created on a client through the admin REST API.

Emitted from ProtocolMappersResource.createMapper(org.keycloak.representations.idm.ProtocolMapperRepresentation) and ProtocolMappersResource.createMapper(java.util.List) before the mapper is persisted. An executor may inspect getProposedProtocolMappers() and throw ClientPolicyException to reject the request.

See Also:

• ClientPolicyEvent.REGISTER_PROTOCOL_MAPPER

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminAuth	adminAuth

Constructor Summary

Constructors

Constructor	Description
ClientProtocolMapperRegisterContext(ProtocolMapperContainerModel protocolMapperContainer, List<ProtocolMapperRepresentation> proposed, AdminAuth adminAuth)
ClientProtocolMapperRegisterContext(ProtocolMapperContainerModel protocolMapperContainer, ProtocolMapperRepresentation proposed, AdminAuth adminAuth)

Method Summary

Modifier and Type	Method	Description
ClientModel	getAuthenticatedClient()
UserModel	getAuthenticatedUser()
ClientPolicyEvent	getEvent()	returns ClientPolicyEvent of client policy related events.
ProtocolMapperRepresentation	getProposedProtocolMapper()
List<ProtocolMapperRepresentation>	getProposedProtocolMappers()
ProtocolMapperContainerModel	getProtocolMapperContainer()
JsonWebToken	getToken()

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.clientpolicy.context.admin.ClientProtocolMapperContext

getClient, getExistingProtocolMapper, getTargetClient

Field Details

adminAuth

protected final AdminAuth adminAuth

Constructor Details

ClientProtocolMapperRegisterContext

public ClientProtocolMapperRegisterContext(ProtocolMapperContainerModel protocolMapperContainer,
 ProtocolMapperRepresentation proposed,
 AdminAuth adminAuth)

ClientProtocolMapperRegisterContext

public ClientProtocolMapperRegisterContext(ProtocolMapperContainerModel protocolMapperContainer,
 List<ProtocolMapperRepresentation> proposed,
 AdminAuth adminAuth)

Method Details

getEvent

public ClientPolicyEvent getEvent()

Description copied from interface: ClientPolicyContext

returns ClientPolicyEvent of client policy related events.

Returns:

ClientPolicyEvent.REGISTER_PROTOCOL_MAPPER

getProtocolMapperContainer

public ProtocolMapperContainerModel getProtocolMapperContainer()

Returns:

the client or client scope that hosts the mapper.

getProposedProtocolMapper

public ProtocolMapperRepresentation getProposedProtocolMapper()

Returns:

the inbound mapper representation on single-item REGISTER/UPDATE flows; null on UNREGISTER and on batch REGISTER flows. Use ClientProtocolMapperContext.getProposedProtocolMappers() to inspect batch payloads.

getProposedProtocolMappers

public List<ProtocolMapperRepresentation> getProposedProtocolMappers()

Returns:

a structurally immutable list of inbound mapper representations when the context carries proposed mapper payloads; the representations themselves remain mutable for policy executors; null on UNREGISTER.

getAuthenticatedClient

public ClientModel getAuthenticatedClient()

Specified by:

getAuthenticatedClient in interface ClientPolicyCRUDContext

Specified by:

getAuthenticatedClient in interface ClientProtocolMapperContext

Returns:

the authenticated client.

getAuthenticatedUser

public UserModel getAuthenticatedUser()

Specified by:

getAuthenticatedUser in interface ClientPolicyCRUDContext

Specified by:

getAuthenticatedUser in interface ClientProtocolMapperContext

Returns:

the authenticated user performing this operation.

getToken

public JsonWebToken getToken()

Specified by:

getToken in interface ClientPolicyCRUDContext

Specified by:

getToken in interface ClientProtocolMapperContext

Returns:

the access token accompanying the request.