org.picketlink.idm.jpa.internal

Class JPAIdentityStore

java.lang.Object

org.picketlink.idm.internal.AbstractIdentityStore<JPAIdentityStoreConfiguration>

org.picketlink.idm.jpa.internal.JPAIdentityStore

All Implemented Interfaces:

PermissionStore, AttributeStore<JPAIdentityStoreConfiguration>, CredentialStore<JPAIdentityStoreConfiguration>, IdentityStore<JPAIdentityStoreConfiguration>, PartitionStore<JPAIdentityStoreConfiguration>

@CredentialHandlers(value={org.picketlink.idm.credential.handler.PasswordCredentialHandler.class,org.picketlink.idm.credential.handler.X509CertificateCredentialHandler.class,org.picketlink.idm.credential.handler.DigestCredentialHandler.class,org.picketlink.idm.credential.handler.TOTPCredentialHandler.class})
public class JPAIdentityStore
extends AbstractIdentityStore<JPAIdentityStoreConfiguration>
implements CredentialStore<JPAIdentityStoreConfiguration>, PartitionStore<JPAIdentityStoreConfiguration>, AttributeStore<JPAIdentityStoreConfiguration>, PermissionStore

Implementation of IdentityStore that stores its state in a relational database.

Author:

Shane Bryzak, Pedro Silva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JPAIdentityStore.PermissionOperationSet

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_CONTEXT_IDENTITY
static String	INVOCATION_CTX_ENTITY_MANAGER

Constructor Summary

Constructors

Constructor and Description
JPAIdentityStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IdentityContext identityContext, Partition partition, String configurationName)
void	addAttributedType(IdentityContext context, AttributedType attributedType)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityContext context, IdentityQuery<V> identityQuery)
<V extends Relationship> List<V>	fetchQueryResults(IdentityContext context, RelationshipQuery<V> query)
<P extends Partition> List<P>	get(IdentityContext identityContext, Class<P> partitionClass)
<P extends Partition> P	get(IdentityContext identityContext, Class<P> partitionClass, String name)
<V extends Serializable> Attribute<V>	getAttribute(IdentityContext context, AttributedType attributedType, String attributeName)
String	getConfigurationName(IdentityContext identityContext, Partition partition)
List<EntityMapper>	getEntityMappers()
List<EntityMapper>	getMapperFor(Class<? extends AttributedType> attributedType) Returns all EntityMapper instances used to map the given AttributedType.
EntityMapper	getMapperForEntity(Class<?> entityClass)
Object	getOwnerEntity(AttributedType attributedType, Property ownerProperty, javax.persistence.EntityManager entityManager)
<P extends Partition> List<P>	getPartitions(IdentityContext identityContext, Class<P> partitionClass, String name)
Object	getRootEntity(AttributedType attributedType, javax.persistence.EntityManager entityManager)
EntityMapper	getRootMapperForEntity(Class<?> entityClass)
boolean	grantPermission(IdentityContext context, IdentityType assignee, Object resource, String operation)
boolean	isMappedType(Class mappedClass)
List<Permission>	listPermissions(IdentityContext ctx, Class<?> resourceClass, Serializable identifier)
List<Permission>	listPermissions(IdentityContext ctx, Class<?> resourceClass, Serializable identifier, String operation)
List<Permission>	listPermissions(IdentityContext ctx, Object resource)
List<Permission>	listPermissions(IdentityContext ctx, Object resource, String operation)
List<Permission>	listPermissions(IdentityContext ctx, Set<Object> resources, String operation)
void	loadAttributes(IdentityContext context, AttributedType attributedType)
<P extends Partition> P	lookupById(IdentityContext context, Class<P> partitionClass, String id)
void	remove(IdentityContext identityContext, Partition partition)
void	removeAttribute(IdentityContext context, AttributedType attributedType, String attributeName)
void	removeAttributedType(IdentityContext context, AttributedType attributedType)
protected void	removeCredentials(IdentityContext context, Account account)
protected void	removeFromRelationships(IdentityContext context, IdentityType identityType)
<T extends CredentialStorage> List<T>	retrieveCredentials(IdentityContext context, Account account, Class<T> storageClass)
<T extends CredentialStorage> T	retrieveCurrentCredential(IdentityContext context, Account account, Class<T> storageClass)
void	revokeAllPermissions(IdentityContext ctx, Object resource)
boolean	revokePermission(IdentityContext context, IdentityType assignee, Object resource, String operation)
void	setAttribute(IdentityContext context, AttributedType attributedType, Attribute<? extends Serializable> attribute)
void	setup(JPAIdentityStoreConfiguration config)
void	storeCredential(IdentityContext context, Account account, CredentialStorage storage)
void	update(IdentityContext identityContext, Partition partition)
void	updateAttributedType(IdentityContext context, AttributedType attributedType)

Methods inherited from class org.picketlink.idm.internal.AbstractIdentityStore

add, countQueryResults, countQueryResults, getConfig, remove, update, updateCredential, validateCredentials

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.idm.spi.IdentityStore

add, countQueryResults, countQueryResults, getConfig, remove, update, updateCredential, validateCredentials

Field Detail

INVOCATION_CTX_ENTITY_MANAGER

public static final String INVOCATION_CTX_ENTITY_MANAGER

See Also:

Constant Field Values

EVENT_CONTEXT_IDENTITY

public static final String EVENT_CONTEXT_IDENTITY

See Also:

Constant Field Values

Constructor Detail

JPAIdentityStore

public JPAIdentityStore()

Method Detail

setup

public void setup(JPAIdentityStoreConfiguration config)

Specified by:

setup in interface IdentityStore<JPAIdentityStoreConfiguration>

Overrides:

setup in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

addAttributedType

public void addAttributedType(IdentityContext context,
                     AttributedType attributedType)

Overrides:

addAttributedType in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

updateAttributedType

public void updateAttributedType(IdentityContext context,
                        AttributedType attributedType)

Specified by:

updateAttributedType in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

removeAttributedType

public void removeAttributedType(IdentityContext context,
                        AttributedType attributedType)

Specified by:

removeAttributedType in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

removeFromRelationships

protected void removeFromRelationships(IdentityContext context,
                           IdentityType identityType)

Specified by:

removeFromRelationships in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

removeCredentials

protected void removeCredentials(IdentityContext context,
                     Account account)

Specified by:

removeCredentials in class AbstractIdentityStore<JPAIdentityStoreConfiguration>

add

public void add(IdentityContext identityContext,
       Partition partition,
       String configurationName)

Specified by:

add in interface PartitionStore<JPAIdentityStoreConfiguration>

getConfigurationName

public String getConfigurationName(IdentityContext identityContext,
                          Partition partition)

Specified by:

getConfigurationName in interface PartitionStore<JPAIdentityStoreConfiguration>

get

public <P extends Partition> P get(IdentityContext identityContext,
                          Class<P> partitionClass,
                          String name)

Specified by:

get in interface PartitionStore<JPAIdentityStoreConfiguration>

get

public <P extends Partition> List<P> get(IdentityContext identityContext,
                                Class<P> partitionClass)

Specified by:

get in interface PartitionStore<JPAIdentityStoreConfiguration>

getPartitions

public <P extends Partition> List<P> getPartitions(IdentityContext identityContext,
                                          Class<P> partitionClass,
                                          String name)

lookupById

public <P extends Partition> P lookupById(IdentityContext context,
                                 Class<P> partitionClass,
                                 String id)

Specified by:

lookupById in interface PartitionStore<JPAIdentityStoreConfiguration>

update

public void update(IdentityContext identityContext,
          Partition partition)

Specified by:

update in interface PartitionStore<JPAIdentityStoreConfiguration>

remove

public void remove(IdentityContext identityContext,
          Partition partition)

Specified by:

remove in interface PartitionStore<JPAIdentityStoreConfiguration>

getAttribute

public <V extends Serializable> Attribute<V> getAttribute(IdentityContext context,
                                                 AttributedType attributedType,
                                                 String attributeName)

Specified by:

getAttribute in interface AttributeStore<JPAIdentityStoreConfiguration>

loadAttributes

public void loadAttributes(IdentityContext context,
                  AttributedType attributedType)

Specified by:

loadAttributes in interface AttributeStore<JPAIdentityStoreConfiguration>

removeAttribute

public void removeAttribute(IdentityContext context,
                   AttributedType attributedType,
                   String attributeName)

Specified by:

removeAttribute in interface AttributeStore<JPAIdentityStoreConfiguration>

fetchQueryResults

public <V extends IdentityType> List<V> fetchQueryResults(IdentityContext context,
                                                 IdentityQuery<V> identityQuery)

Specified by:

fetchQueryResults in interface IdentityStore<JPAIdentityStoreConfiguration>

fetchQueryResults

public <V extends Relationship> List<V> fetchQueryResults(IdentityContext context,
                                                 RelationshipQuery<V> query)

Specified by:

fetchQueryResults in interface IdentityStore<JPAIdentityStoreConfiguration>

setAttribute

public void setAttribute(IdentityContext context,
                AttributedType attributedType,
                Attribute<? extends Serializable> attribute)

Specified by:

setAttribute in interface AttributeStore<JPAIdentityStoreConfiguration>

storeCredential

public void storeCredential(IdentityContext context,
                   Account account,
                   CredentialStorage storage)

Specified by:

storeCredential in interface CredentialStore<JPAIdentityStoreConfiguration>

retrieveCurrentCredential

public <T extends CredentialStorage> T retrieveCurrentCredential(IdentityContext context,
                                                        Account account,
                                                        Class<T> storageClass)

Specified by:

retrieveCurrentCredential in interface CredentialStore<JPAIdentityStoreConfiguration>

retrieveCredentials

public <T extends CredentialStorage> List<T> retrieveCredentials(IdentityContext context,
                                                        Account account,
                                                        Class<T> storageClass)

Specified by:

retrieveCredentials in interface CredentialStore<JPAIdentityStoreConfiguration>

getOwnerEntity

public Object getOwnerEntity(AttributedType attributedType,
                    Property ownerProperty,
                    javax.persistence.EntityManager entityManager)

getMapperFor

public List<EntityMapper> getMapperFor(Class<? extends AttributedType> attributedType)

Returns all EntityMapper instances used to map the given AttributedType. Only mappers for IdentityManaged annotated entity classes are considered, what means that this method can only be used when trying to persist or populate @{link AttributedType} instances.

Parameters:

attributedType -

Returns:

getRootMapperForEntity

public EntityMapper getRootMapperForEntity(Class<?> entityClass)

getMapperForEntity

public EntityMapper getMapperForEntity(Class<?> entityClass)

getEntityMappers

public List<EntityMapper> getEntityMappers()

isMappedType

public boolean isMappedType(Class mappedClass)

getRootEntity

public Object getRootEntity(AttributedType attributedType,
                   javax.persistence.EntityManager entityManager)

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                               Object resource)

Specified by:

listPermissions in interface PermissionStore

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                               Object resource,
                               String operation)

Specified by:

listPermissions in interface PermissionStore

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                               Set<Object> resources,
                               String operation)

Specified by:

listPermissions in interface PermissionStore

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                               Class<?> resourceClass,
                               Serializable identifier)

Specified by:

listPermissions in interface PermissionStore

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                               Class<?> resourceClass,
                               Serializable identifier,
                               String operation)

Specified by:

listPermissions in interface PermissionStore

grantPermission

public boolean grantPermission(IdentityContext context,
                      IdentityType assignee,
                      Object resource,
                      String operation)

Specified by:

grantPermission in interface PermissionStore

revokePermission

public boolean revokePermission(IdentityContext context,
                       IdentityType assignee,
                       Object resource,
                       String operation)

Specified by:

revokePermission in interface PermissionStore

revokeAllPermissions

public void revokeAllPermissions(IdentityContext ctx,
                        Object resource)

Specified by:

revokeAllPermissions in interface PermissionStore