public interface ClientPolicyManager extends Provider
ClientPolicyEvent
.
Also provides methods for handling client profiles and policies.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.
|
void triggerOnEvent(ClientPolicyContext context) throws ClientPolicyException
ClientPolicyEvent
.context
- - the context of the event.{@link
- ClientPolicyException}ClientPolicyException
void setupClientPoliciesOnCreatedRealm(RealmModel realm)
realm
- - the newly created realmvoid updateRealmModelFromRepresentation(RealmModel realm, RealmRepresentation rep)
realm
- - the newly created realm to be overriden by imported realm's representationrep
- - imported realm's representationvoid updateClientProfiles(RealmModel realm, ClientProfilesRepresentation clientProfiles) throws ClientPolicyException
realm
- - the realm whose client profiles is to be overriden by the new client profilesclientProfiles
- - 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.{@link
- ClientPolicyException}ClientPolicyException
ClientProfilesRepresentation getClientProfiles(RealmModel realm, boolean includeGlobalProfiles) throws ClientPolicyException
realm
- - the realm whose client profiles is to be returnedincludeGlobalProfiles
- - If true, method will return realm profiles and global profiles as well. If false, then "globalProfiles" field would be nullClientPolicyException
void updateClientPolicies(RealmModel realm, ClientPoliciesRepresentation clientPolicies) throws ClientPolicyException
realm
- - the realm whose client policies is to be overriden by the new client policiesclientPolicies
- - the json representation of the new client policies that overrides the existing client policies set on the realm{@link
- ClientPolicyException}ClientPolicyException
ClientPoliciesRepresentation getClientPolicies(RealmModel realm) throws ClientPolicyException
realm
- - the realm whose client policies is to be returnedClientPolicyException
void updateRealmRepresentationFromModel(RealmModel realm, RealmRepresentation rep)
realm
- - the realm to be exportedrep
- - the realm's representation to be exported actuallyCopyright © 2021 JBoss by Red Hat. All rights reserved.