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

Class ClientProtocolMapperRemoveContext

java.lang.Object

org.keycloak.services.clientpolicy.context.admin.ClientProtocolMapperRemoveContext

All Implemented Interfaces:

ClientPolicyContext, ClientProtocolMapperContext, ClientModelContext, ClientPolicyCRUDContext

public class ClientProtocolMapperRemoveContext
extends Object

Fired when a protocol mapper is being removed from a client through the admin REST API.

Emitted from ProtocolMappersResource.delete(java.lang.String) before the mapper is removed.

See Also:

• ClientPolicyEvent.UNREGISTER_PROTOCOL_MAPPER

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminAuth	adminAuth

Constructor Summary

Constructors

Constructor	Description
ClientProtocolMapperRemoveContext(ProtocolMapperContainerModel protocolMapperContainer, 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()
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, getProposedProtocolMapper, getProposedProtocolMappers, getTargetClient

Field Details

adminAuth

protected final AdminAuth adminAuth

Constructor Details

ClientProtocolMapperRemoveContext

public ClientProtocolMapperRemoveContext(ProtocolMapperContainerModel protocolMapperContainer,
 ProtocolMapperModel existing,
 AdminAuth adminAuth)

Method Details

getEvent

public ClientPolicyEvent getEvent()

Description copied from interface: ClientPolicyContext

returns ClientPolicyEvent of client policy related events.

Returns:

ClientPolicyEvent.UNREGISTER_PROTOCOL_MAPPER

getProtocolMapperContainer

public ProtocolMapperContainerModel getProtocolMapperContainer()

Returns:

the client or client scope that hosts the mapper.

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.