org.keycloak.services.clientpolicy

Interface ClientPolicyManager

All Superinterfaces:

Provider

All Known Implementing Classes:

DefaultClientPolicyManager

public interface ClientPolicyManager
extends Provider

Provides a method for handling an event defined in ClientPolicyEvent. Also provides methods for handling client profiles and policies.

Author:

Takashi Norimatsu

Method Summary

Modifier and Type	Method and Description
ClientPoliciesRepresentation	getClientPolicies(RealmModel realm) when getting client policies via Admin REST API, returns the existing client policies set on the realm.
ClientProfilesRepresentation	getClientProfiles(RealmModel realm, boolean includeGlobalProfiles) when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.
void	setupClientPoliciesOnCreatedRealm(RealmModel realm) when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute.
void	triggerOnEvent(ClientPolicyContext context) execute a method for handling an event defined in ClientPolicyEvent.
void	updateClientPolicies(RealmModel realm, ClientPoliciesRepresentation clientPolicies) when updating client policies via Admin REST API, reads the json representation of the client policies and overrides the existing client policies set on the realm with them.
void	updateClientProfiles(RealmModel realm, ClientProfilesRepresentation clientProfiles) when updating client profiles via Admin REST API, reads the json representation of the client profiles and overrides the existing client profiles set on the realm with them.
void	updateRealmModelFromRepresentation(RealmModel realm, RealmRepresentation rep) when importing a realm, or updating a realm, update model from the representation object
void	updateRealmRepresentationFromModel(RealmModel realm, RealmRepresentation rep) when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies.

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

triggerOnEvent

void triggerOnEvent(ClientPolicyContext context)
             throws ClientPolicyException

execute a method for handling an event defined in ClientPolicyEvent.

Parameters:

context - - the context of the event.

Throws:

{@link - ClientPolicyException}

ClientPolicyException

setupClientPoliciesOnCreatedRealm

void setupClientPoliciesOnCreatedRealm(RealmModel realm)

when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute. if these operation fails, put null.

Parameters:

realm - - the newly created realm

updateRealmModelFromRepresentation

void updateRealmModelFromRepresentation(RealmModel realm,
                                        RealmRepresentation rep)

when importing a realm, or updating a realm, update model from the representation object

Parameters:

realm - - the newly created realm to be overriden by imported realm's representation

rep - - imported realm's representation

updateClientProfiles

void updateClientProfiles(RealmModel realm,
                          ClientProfilesRepresentation clientProfiles)
                   throws ClientPolicyException

when updating client profiles via Admin REST API, reads the json representation of the client profiles and overrides the existing client profiles set on the realm with them. if these operation fails, rolls them back to the existing client profiles and throw an exception. If the "clientProfiles" parameter contains the global client profiles, they won't be updated on the realm at all

Parameters:

realm - - the realm whose client profiles is to be overriden by the new client profiles

clientProfiles - - the json representation of the new client profiles that overrides the existing client profiles set on the realm. With the exception of global profiles, which are not overriden as mentioned above.

Throws:

{@link - ClientPolicyException}

ClientPolicyException

getClientProfiles

ClientProfilesRepresentation getClientProfiles(RealmModel realm,
                                               boolean includeGlobalProfiles)
                                        throws ClientPolicyException

when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.

Parameters:

realm - - the realm whose client profiles is to be returned

includeGlobalProfiles - - If true, method will return realm profiles and global profiles as well. If false, then "globalProfiles" field would be null

Returns:

the json representation of the client profiles set on the realm

Throws:

ClientPolicyException

updateClientPolicies

void updateClientPolicies(RealmModel realm,
                          ClientPoliciesRepresentation clientPolicies)
                   throws ClientPolicyException

when updating client policies via Admin REST API, reads the json representation of the client policies and overrides the existing client policies set on the realm with them. if these operation fails, rolls them back to the existing client policies and throw an exception.

Parameters:

realm - - the realm whose client policies is to be overriden by the new client policies

clientPolicies - - the json representation of the new client policies that overrides the existing client policies set on the realm

Throws:

{@link - ClientPolicyException}

ClientPolicyException

getClientPolicies

ClientPoliciesRepresentation getClientPolicies(RealmModel realm)
                                        throws ClientPolicyException

when getting client policies via Admin REST API, returns the existing client policies set on the realm.

Parameters:

realm - - the realm whose client policies is to be returned

Returns:

the json representation of the client policies set on the realm

Throws:

ClientPolicyException

updateRealmRepresentationFromModel

void updateRealmRepresentationFromModel(RealmModel realm,
                                        RealmRepresentation rep)

when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies. Global client profiles and policies are filtered out and not exported.

Parameters:

realm - - the realm to be exported

rep - - the realm's representation to be exported actually