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

Class ClientProtocolMapperUpdateContext

java.lang.Object

org.keycloak.services.clientpolicy.context.admin.ClientProtocolMapperUpdateContext

All Implemented Interfaces:

ClientPolicyContext, ClientProtocolMapperContext, ClientModelContext, ClientPolicyCRUDContext

public class ClientProtocolMapperUpdateContext
extends Object

Fired when a protocol mapper is being updated on a client through the admin REST API.

Emitted from ProtocolMappersResource.update(java.lang.String, org.keycloak.representations.idm.ProtocolMapperRepresentation) before the mapper is persisted.

See Also:

• ClientPolicyEvent.UPDATE_PROTOCOL_MAPPER

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminAuth	adminAuth

Constructor Summary

Constructors

Constructor	Description
ClientProtocolMapperUpdateContext(ProtocolMapperContainerModel protocolMapperContainer, ProtocolMapperRepresentation proposed, ProtocolMapperModel existing, AdminAuth adminAuth)

Method Summary

Modifier and Type	Method	Description
ClientModel	getAuthenticatedClient()
UserModel	getAuthenticatedUser()
ClientPolicyEvent	getEvent()	returns ClientPolicyEvent of client policy related events.
ProtocolMapperModel	getExistingProtocolMapper()
ProtocolMapperRepresentation	getProposedProtocolMapper()
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, getProposedProtocolMappers, getTargetClient

Field Details

adminAuth

protected final AdminAuth adminAuth

Constructor Details

ClientProtocolMapperUpdateContext

public ClientProtocolMapperUpdateContext(ProtocolMapperContainerModel protocolMapperContainer,
 ProtocolMapperRepresentation proposed,
 ProtocolMapperModel existing,
 AdminAuth adminAuth)

Method Details

getEvent

public ClientPolicyEvent getEvent()

Description copied from interface: ClientPolicyContext

returns ClientPolicyEvent of client policy related events.

Returns:

ClientPolicyEvent.UPDATE_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.

getExistingProtocolMapper

public ProtocolMapperModel getExistingProtocolMapper()

Returns:

the existing mapper model on UPDATE/UNREGISTER; null on REGISTER.

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.