org.picketlink.idm.jpa.internal

Class JPAIdentityStore

java.lang.Object

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

org.picketlink.idm.jpa.internal.JPAIdentityStore

All Implemented Interfaces:

org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.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<org.picketlink.idm.config.JPAIdentityStoreConfiguration>
implements org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

Implementation of IdentityStore that stores its state in a relational database. This is a lightweight object that is generally created once per request, and is provided references to a (heavyweight) configuration and invocation context.

Author:

Shane Bryzak, Pedro Silva

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(org.picketlink.idm.spi.IdentityContext identityContext, org.picketlink.idm.model.Partition partition, String configurationName)
void	addAttributedType(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType)
<V extends org.picketlink.idm.model.IdentityType> int	countQueryResults(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.query.IdentityQuery<V> identityQuery)
<V extends org.picketlink.idm.model.Relationship> int	countQueryResults(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.query.RelationshipQuery<V> query)
<V extends org.picketlink.idm.model.IdentityType> List<V>	fetchQueryResults(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.query.IdentityQuery<V> identityQuery)
<V extends org.picketlink.idm.model.Relationship> List<V>	fetchQueryResults(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.query.RelationshipQuery<V> query)
<P extends org.picketlink.idm.model.Partition> List<P>	get(org.picketlink.idm.spi.IdentityContext identityContext, Class<P> partitionClass)
<P extends org.picketlink.idm.model.Partition> P	get(org.picketlink.idm.spi.IdentityContext identityContext, Class<P> partitionClass, String name)
<V extends Serializable> org.picketlink.idm.model.Attribute<V>	getAttribute(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType, String attributeName)
String	getConfigurationName(org.picketlink.idm.spi.IdentityContext identityContext, org.picketlink.idm.model.Partition partition)
List<EntityMapper>	getEntityMappers()
List<EntityMapper>	getMapperFor(Class<? extends org.picketlink.idm.model.AttributedType> attributedType) Returns all EntityMapper instances used to map the given AttributedType.
EntityMapper	getMapperForEntity(Class<?> entityClass)
Object	getOwnerEntity(org.picketlink.idm.model.AttributedType attributedType, org.picketlink.common.properties.Property ownerProperty, javax.persistence.EntityManager entityManager)
<P extends org.picketlink.idm.model.Partition> List<P>	getPartitions(org.picketlink.idm.spi.IdentityContext identityContext, Class<P> partitionClass, String name)
Object	getRootEntity(org.picketlink.idm.model.AttributedType attributedType, javax.persistence.EntityManager entityManager)
EntityMapper	getRootMapperForEntity(Class<?> entityClass)
boolean	isMappedType(Class mappedClass)
void	loadAttributes(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType)
<P extends org.picketlink.idm.model.Partition> P	lookupById(org.picketlink.idm.spi.IdentityContext context, Class<P> partitionClass, String id)
void	remove(org.picketlink.idm.spi.IdentityContext identityContext, org.picketlink.idm.model.Partition partition)
void	removeAttribute(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType, String attributeName)
void	removeAttributedType(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType)
<T extends org.picketlink.idm.credential.storage.CredentialStorage> List<T>	retrieveCredentials(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.Account account, Class<T> storageClass)
<T extends org.picketlink.idm.credential.storage.CredentialStorage> T	retrieveCurrentCredential(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.Account account, Class<T> storageClass)
void	setAttribute(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType, org.picketlink.idm.model.Attribute<? extends Serializable> attribute)
void	setup(org.picketlink.idm.config.JPAIdentityStoreConfiguration config)
void	storeCredential(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.Account account, org.picketlink.idm.credential.storage.CredentialStorage storage)
void	update(org.picketlink.idm.spi.IdentityContext identityContext, org.picketlink.idm.model.Partition partition)
void	updateAttributedType(org.picketlink.idm.spi.IdentityContext context, org.picketlink.idm.model.AttributedType attributedType)

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

add, 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, 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(org.picketlink.idm.config.JPAIdentityStoreConfiguration config)

Specified by:

setup in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

Overrides:

setup in class AbstractIdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

addAttributedType

public void addAttributedType(org.picketlink.idm.spi.IdentityContext context,
                     org.picketlink.idm.model.AttributedType attributedType)

Specified by:

addAttributedType in class AbstractIdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

updateAttributedType

public void updateAttributedType(org.picketlink.idm.spi.IdentityContext context,
                        org.picketlink.idm.model.AttributedType attributedType)

Specified by:

updateAttributedType in class AbstractIdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

removeAttributedType

public void removeAttributedType(org.picketlink.idm.spi.IdentityContext context,
                        org.picketlink.idm.model.AttributedType attributedType)

Specified by:

removeAttributedType in class AbstractIdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

add

public void add(org.picketlink.idm.spi.IdentityContext identityContext,
       org.picketlink.idm.model.Partition partition,
       String configurationName)

Specified by:

add in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

getConfigurationName

public String getConfigurationName(org.picketlink.idm.spi.IdentityContext identityContext,
                          org.picketlink.idm.model.Partition partition)

Specified by:

getConfigurationName in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

get

public <P extends org.picketlink.idm.model.Partition> P get(org.picketlink.idm.spi.IdentityContext identityContext,
                                                   Class<P> partitionClass,
                                                   String name)

Specified by:

get in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

get

public <P extends org.picketlink.idm.model.Partition> List<P> get(org.picketlink.idm.spi.IdentityContext identityContext,
                                                         Class<P> partitionClass)

Specified by:

get in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

getPartitions

public <P extends org.picketlink.idm.model.Partition> List<P> getPartitions(org.picketlink.idm.spi.IdentityContext identityContext,
                                                                   Class<P> partitionClass,
                                                                   String name)

lookupById

public <P extends org.picketlink.idm.model.Partition> P lookupById(org.picketlink.idm.spi.IdentityContext context,
                                                          Class<P> partitionClass,
                                                          String id)

Specified by:

lookupById in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

update

public void update(org.picketlink.idm.spi.IdentityContext identityContext,
          org.picketlink.idm.model.Partition partition)

Specified by:

update in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

remove

public void remove(org.picketlink.idm.spi.IdentityContext identityContext,
          org.picketlink.idm.model.Partition partition)

Specified by:

remove in interface org.picketlink.idm.spi.PartitionStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

getAttribute

public <V extends Serializable> org.picketlink.idm.model.Attribute<V> getAttribute(org.picketlink.idm.spi.IdentityContext context,
                                                                          org.picketlink.idm.model.AttributedType attributedType,
                                                                          String attributeName)

Specified by:

getAttribute in interface org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

loadAttributes

public void loadAttributes(org.picketlink.idm.spi.IdentityContext context,
                  org.picketlink.idm.model.AttributedType attributedType)

Specified by:

loadAttributes in interface org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

removeAttribute

public void removeAttribute(org.picketlink.idm.spi.IdentityContext context,
                   org.picketlink.idm.model.AttributedType attributedType,
                   String attributeName)

Specified by:

removeAttribute in interface org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

fetchQueryResults

public <V extends org.picketlink.idm.model.IdentityType> List<V> fetchQueryResults(org.picketlink.idm.spi.IdentityContext context,
                                                                          org.picketlink.idm.query.IdentityQuery<V> identityQuery)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

countQueryResults

public <V extends org.picketlink.idm.model.IdentityType> int countQueryResults(org.picketlink.idm.spi.IdentityContext context,
                                                                      org.picketlink.idm.query.IdentityQuery<V> identityQuery)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

fetchQueryResults

public <V extends org.picketlink.idm.model.Relationship> List<V> fetchQueryResults(org.picketlink.idm.spi.IdentityContext context,
                                                                          org.picketlink.idm.query.RelationshipQuery<V> query)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

setAttribute

public void setAttribute(org.picketlink.idm.spi.IdentityContext context,
                org.picketlink.idm.model.AttributedType attributedType,
                org.picketlink.idm.model.Attribute<? extends Serializable> attribute)

Specified by:

setAttribute in interface org.picketlink.idm.spi.AttributeStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

storeCredential

public void storeCredential(org.picketlink.idm.spi.IdentityContext context,
                   org.picketlink.idm.model.Account account,
                   org.picketlink.idm.credential.storage.CredentialStorage storage)

Specified by:

storeCredential in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

retrieveCurrentCredential

public <T extends org.picketlink.idm.credential.storage.CredentialStorage> T retrieveCurrentCredential(org.picketlink.idm.spi.IdentityContext context,
                                                                                              org.picketlink.idm.model.Account account,
                                                                                              Class<T> storageClass)

Specified by:

retrieveCurrentCredential in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

retrieveCredentials

public <T extends org.picketlink.idm.credential.storage.CredentialStorage> List<T> retrieveCredentials(org.picketlink.idm.spi.IdentityContext context,
                                                                                              org.picketlink.idm.model.Account account,
                                                                                              Class<T> storageClass)

Specified by:

retrieveCredentials in interface org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

countQueryResults

public <V extends org.picketlink.idm.model.Relationship> int countQueryResults(org.picketlink.idm.spi.IdentityContext context,
                                                                      org.picketlink.idm.query.RelationshipQuery<V> query)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

getOwnerEntity

public Object getOwnerEntity(org.picketlink.idm.model.AttributedType attributedType,
                    org.picketlink.common.properties.Property ownerProperty,
                    javax.persistence.EntityManager entityManager)

getMapperFor

public List<EntityMapper> getMapperFor(Class<? extends org.picketlink.idm.model.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(org.picketlink.idm.model.AttributedType attributedType,
                   javax.persistence.EntityManager entityManager)