org.picketlink.idm.jpa.internal

Class JPAIdentityStore

java.lang.Object

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

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

org.picketlink.idm.jpa.internal.JPAIdentityStore

All Implemented Interfaces:

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

@CredentialHandlers(value={PasswordCredentialHandler.class,X509CertificateCredentialHandler.class,DigestCredentialHandler.class,TOTPCredentialHandler.class,TokenCredentialHandler.class})
public class JPAIdentityStore
extends AbstractAttributeStore<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	INVOCATION_CTX_ENTITY_MANAGER

Constructor Summary

Constructors

Constructor and Description
JPAIdentityStore()

Method Summary

Modifier and Type	Method and Description
void	add(IdentityContext identityContext, Partition partition, String configurationName)
void	addAttributedType(IdentityContext context, AttributedType attributedType)
void	doSetAttribute(IdentityContext context, AttributedType attributedType, Attribute<? extends Serializable> attribute)
<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)
protected Collection<Attribute<? extends Serializable>>	getAttributes(IdentityContext identityContext, AttributedType attributedType)
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) Grants the specified permission
boolean	isMappedType(Class mappedClass)
List<Permission>	listPermissions(IdentityContext ctx, Class<?> resourceClass, Serializable identifier) Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value.
List<Permission>	listPermissions(IdentityContext ctx, Class<?> resourceClass, Serializable identifier, String operation) Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value, with the specified operation.
List<Permission>	listPermissions(IdentityContext ctx, IdentityPermission query)
List<Permission>	listPermissions(IdentityContext ctx, IdentityType identityType) Returns a list of all Permission for the given IdentityType.
List<Permission>	listPermissions(IdentityContext ctx, Object resource) Returns a List value containing all permissions for the specified resource.
List<Permission>	listPermissions(IdentityContext ctx, Object resource, String operation) Returns a List value containing all permissions for the specified resource, having the specified operation
List<Permission>	listPermissions(IdentityContext ctx, Set<Object> resources, String operation) Returns a List value containing all permissions for all of the specified resource, having the specified operation
<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) Removes the specified Attribute value, for the specified IdentityType
void	removeAttributedType(IdentityContext context, AttributedType attributedType)
void	removeCredential(IdentityContext context, Account account, Class<? extends CredentialStorage> storageClass) Removes all credentials stored by a certain CredentialStorage associated with the given Account.
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) Returns a list of all credential state of the specified T, for the specified Account.
<T extends CredentialStorage> T	retrieveCurrentCredential(IdentityContext context, Account account, Class<T> storageClass) Returns the currently active credential state of the specified T, for the specified Account.
void	revokeAllPermissions(IdentityContext ctx, Object resource) Revokes all permissions for the specified resource
boolean	revokePermission(IdentityContext context, IdentityType assignee, Object resource, String operation) Revokes the specified permission
void	setup(JPAIdentityStoreConfiguration config) Sets the configuration and context in which the IdentityStore will execute its operations
void	storeCredential(IdentityContext context, Account account, CredentialStorage storage) Stores the specified credential state.
void	update(IdentityContext identityContext, Partition partition)
void	updateAttributedType(IdentityContext context, AttributedType attributedType)

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

getAttribute, loadAttributes, setAttribute

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.AttributeStore

getAttribute, loadAttributes, setAttribute

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

Constructor Detail

JPAIdentityStore

public JPAIdentityStore()

Method Detail

setup

public void setup(JPAIdentityStoreConfiguration config)

Description copied from interface: IdentityStore

Sets the configuration and context in which the IdentityStore will execute its operations

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>

getAttributes

protected Collection<Attribute<? extends Serializable>> getAttributes(IdentityContext identityContext,
                                                                      AttributedType attributedType)

Specified by:

getAttributes in class AbstractAttributeStore<JPAIdentityStoreConfiguration>

removeAttribute

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

Description copied from interface: AttributeStore

Removes the specified Attribute value, for the specified IdentityType

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>

doSetAttribute

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

Specified by:

doSetAttribute in class AbstractAttributeStore<JPAIdentityStoreConfiguration>

storeCredential

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

Description copied from interface: CredentialStore

Stores the specified credential state.

Specified by:

storeCredential in interface CredentialStore<JPAIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storage - The credential storage instance to be stored.

retrieveCurrentCredential

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

Description copied from interface: CredentialStore

Returns the currently active credential state of the specified T, for the specified Account.

Specified by:

retrieveCurrentCredential in interface CredentialStore<JPAIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

retrieveCredentials

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

Description copied from interface: CredentialStore

Returns a list of all credential state of the specified T, for the specified Account.

Specified by:

retrieveCredentials in interface CredentialStore<JPAIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

removeCredential

public void removeCredential(IdentityContext context,
                             Account account,
                             Class<? extends CredentialStorage> storageClass)

Description copied from interface: CredentialStore

Removes all credentials stored by a certain CredentialStorage associated with the given Account.

Specified by:

removeCredential in interface CredentialStore<JPAIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

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)

Description copied from interface: PermissionStore

Returns a List value containing all permissions for the specified resource.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                                        IdentityType identityType)

Description copied from interface: PermissionStore

Returns a list of all Permission for the given IdentityType.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

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

Description copied from interface: PermissionStore

Returns a List value containing all permissions for the specified resource, having the specified operation

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

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

Description copied from interface: PermissionStore

Returns a List value containing all permissions for all of the specified resource, having the specified operation

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

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

Description copied from interface: PermissionStore

Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

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

Description copied from interface: PermissionStore

Returns a List containing all the permissions for a resource that has not yet been loaded, using the specified resource class and resource identifier value, with the specified operation.

Specified by:

listPermissions in interface PermissionStore

Returns:

listPermissions

public List<Permission> listPermissions(IdentityContext ctx,
                                        IdentityPermission query)

grantPermission

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

Description copied from interface: PermissionStore

Grants the specified permission

Specified by:

grantPermission in interface PermissionStore

Returns:

revokePermission

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

Description copied from interface: PermissionStore

Revokes the specified permission

Specified by:

revokePermission in interface PermissionStore

Returns:

revokeAllPermissions

public void revokeAllPermissions(IdentityContext ctx,
                                 Object resource)

Description copied from interface: PermissionStore

Revokes all permissions for the specified resource

Specified by:

revokeAllPermissions in interface PermissionStore