Package org.keycloak.authorization.policy.provider.user

Class UserPolicyProviderFactory

java.lang.Object

org.keycloak.authorization.policy.provider.user.UserPolicyProviderFactory

All Implemented Interfaces:

PolicyProviderFactory<UserPolicyRepresentation>, ProviderFactory<PolicyProvider>

public class UserPolicyProviderFactory
extends Object
implements PolicyProviderFactory<UserPolicyRepresentation>

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor	Description
UserPolicyProviderFactory()

Method Summary

Modifier and Type	Method	Description
void	close()	This is called when the server shuts down.
PolicyProvider	create(AuthorizationProvider authorization)
PolicyProvider	create(KeycloakSession session)
String	getGroup()
String	getId()
String	getName()
Class<UserPolicyRepresentation>	getRepresentationType()
void	init(Config.Scope config)	Only called once when the factory is first created.
void	onCreate(Policy policy, UserPolicyRepresentation representation, AuthorizationProvider authorization)
void	onExport(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorizationProvider)
void	onImport(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization)
void	onUpdate(Policy policy, UserPolicyRepresentation representation, AuthorizationProvider authorization)
void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized
UserPolicyRepresentation	toRepresentation(Policy policy, AuthorizationProvider authorization)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.authorization.policy.provider.PolicyProviderFactory

getAdminResource, isInternal, onRemove

Methods inherited from interface org.keycloak.provider.ProviderFactory

getConfigMetadata, order

Constructor Detail

UserPolicyProviderFactory

public UserPolicyProviderFactory()

Method Detail

getName

public String getName()

Specified by:

getName in interface PolicyProviderFactory<UserPolicyRepresentation>

getGroup

public String getGroup()

Specified by:

getGroup in interface PolicyProviderFactory<UserPolicyRepresentation>

create

public PolicyProvider create(AuthorizationProvider authorization)

Specified by:

create in interface PolicyProviderFactory<UserPolicyRepresentation>

create

public PolicyProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<PolicyProvider>

toRepresentation

public UserPolicyRepresentation toRepresentation(Policy policy,
                                                 AuthorizationProvider authorization)

Specified by:

toRepresentation in interface PolicyProviderFactory<UserPolicyRepresentation>

getRepresentationType

public Class<UserPolicyRepresentation> getRepresentationType()

Specified by:

getRepresentationType in interface PolicyProviderFactory<UserPolicyRepresentation>

onCreate

public void onCreate(Policy policy,
                     UserPolicyRepresentation representation,
                     AuthorizationProvider authorization)

Specified by:

onCreate in interface PolicyProviderFactory<UserPolicyRepresentation>

onUpdate

public void onUpdate(Policy policy,
                     UserPolicyRepresentation representation,
                     AuthorizationProvider authorization)

Specified by:

onUpdate in interface PolicyProviderFactory<UserPolicyRepresentation>

onImport

public void onImport(Policy policy,
                     PolicyRepresentation representation,
                     AuthorizationProvider authorization)

Specified by:

onImport in interface PolicyProviderFactory<UserPolicyRepresentation>

onExport

public void onExport(Policy policy,
                     PolicyRepresentation representation,
                     AuthorizationProvider authorizationProvider)

Specified by:

onExport in interface PolicyProviderFactory<UserPolicyRepresentation>

init

public void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created. This config is pulled from keycloak_server.json

Specified by:

init in interface ProviderFactory<PolicyProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<PolicyProvider>

close

public void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<PolicyProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<PolicyProvider>