org.picketlink.idm.jpa.internal

Class JPAIdentityStore

java.lang.Object

org.picketlink.idm.jpa.internal.JPAIdentityStore

All Implemented Interfaces:

org.picketlink.idm.spi.CredentialStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>, org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.JPAIdentityStoreConfiguration>

@CredentialHandlers(value={PasswordCredentialHandler.class,X509CertificateCredentialHandler.class,DigestCredentialHandler.class,TOTPCredentialHandler.class})
public class JPAIdentityStore
extends Object
implements org.picketlink.idm.spi.CredentialStore<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_GROUP_ENTITY
static String	EVENT_CONTEXT_ROLE_ENTITY
static String	EVENT_CONTEXT_USER_ENTITY
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.SecurityContext context, org.picketlink.idm.model.AttributedType value)
protected org.picketlink.idm.model.Partition	convertPartitionEntityToPartition(Object partitionObject)
<T extends org.picketlink.idm.model.IdentityType> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
<T extends org.picketlink.idm.model.IdentityType> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
org.picketlink.idm.model.Agent	getAgent(org.picketlink.idm.spi.SecurityContext context, String loginName)
protected List<String>	getAllowedPartitionIds(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Partition currentPartition)
<T extends Serializable> org.picketlink.idm.model.Attribute<T>	getAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, String attributeName)
org.picketlink.idm.config.JPAIdentityStoreConfiguration	getConfig()
protected javax.persistence.EntityManager	getEntityManager(org.picketlink.idm.spi.SecurityContext context)
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String groupPath)
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String name, org.picketlink.idm.model.Group parent)
org.picketlink.idm.model.Role	getRole(org.picketlink.idm.spi.SecurityContext context, String name)
org.picketlink.idm.model.User	getUser(org.picketlink.idm.spi.SecurityContext context, String loginName)
protected Object	lookupAndCreatePartitionObject(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Partition partition)
protected Object	lookupIdentityObjectById(org.picketlink.idm.spi.SecurityContext context, String id) Lookup a stored IdentityType using the id.
void	remove(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	removeAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identity, String name)
<T extends org.picketlink.idm.credential.spi.CredentialStorage> List<T>	retrieveCredentials(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Class<T> storageClass)
<T extends org.picketlink.idm.credential.spi.CredentialStorage> T	retrieveCurrentCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Class<T> storageClass)
void	setAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identity, org.picketlink.idm.model.Attribute<? extends Serializable> attribute)
void	setup(org.picketlink.idm.config.JPAIdentityStoreConfiguration config)
void	storeCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, org.picketlink.idm.credential.spi.CredentialStorage storage)
void	update(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	updateCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Object credential, Date effectiveDate, Date expiryDate)
void	validateCredentials(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.credential.Credentials credentials)

Methods inherited from class java.lang.Object

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

Field Detail

INVOCATION_CTX_ENTITY_MANAGER

public static final String INVOCATION_CTX_ENTITY_MANAGER

See Also:

Constant Field Values

EVENT_CONTEXT_USER_ENTITY

public static final String EVENT_CONTEXT_USER_ENTITY

See Also:

Constant Field Values

EVENT_CONTEXT_GROUP_ENTITY

public static final String EVENT_CONTEXT_GROUP_ENTITY

See Also:

Constant Field Values

EVENT_CONTEXT_ROLE_ENTITY

public static final String EVENT_CONTEXT_ROLE_ENTITY

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>

getConfig

public org.picketlink.idm.config.JPAIdentityStoreConfiguration getConfig()

Specified by:

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

add

public void add(org.picketlink.idm.spi.SecurityContext context,
       org.picketlink.idm.model.AttributedType value)

Specified by:

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

update

public void update(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

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

remove

public void remove(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

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

getUser

public org.picketlink.idm.model.User getUser(org.picketlink.idm.spi.SecurityContext context,
                                    String loginName)

Specified by:

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

getGroup

public org.picketlink.idm.model.Group getGroup(org.picketlink.idm.spi.SecurityContext context,
                                      String groupPath)

Specified by:

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

getGroup

public org.picketlink.idm.model.Group getGroup(org.picketlink.idm.spi.SecurityContext context,
                                      String name,
                                      org.picketlink.idm.model.Group parent)

Specified by:

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

getRole

public org.picketlink.idm.model.Role getRole(org.picketlink.idm.spi.SecurityContext context,
                                    String name)

Specified by:

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

getAgent

public org.picketlink.idm.model.Agent getAgent(org.picketlink.idm.spi.SecurityContext context,
                                      String loginName)

Specified by:

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

fetchQueryResults

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

Specified by:

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

fetchQueryResults

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

Specified by:

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

countQueryResults

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

Specified by:

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

countQueryResults

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

Specified by:

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

setAttribute

public void setAttribute(org.picketlink.idm.spi.SecurityContext context,
                org.picketlink.idm.model.IdentityType identity,
                org.picketlink.idm.model.Attribute<? extends Serializable> attribute)

Specified by:

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

removeAttribute

public void removeAttribute(org.picketlink.idm.spi.SecurityContext context,
                   org.picketlink.idm.model.IdentityType identity,
                   String name)

Specified by:

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

getAttribute

public <T extends Serializable> org.picketlink.idm.model.Attribute<T> getAttribute(org.picketlink.idm.spi.SecurityContext context,
                                                                          org.picketlink.idm.model.IdentityType identityType,
                                                                          String attributeName)

Specified by:

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

retrieveCredentials

public <T extends org.picketlink.idm.credential.spi.CredentialStorage> List<T> retrieveCredentials(org.picketlink.idm.spi.SecurityContext context,
                                                                                          org.picketlink.idm.model.Agent agent,
                                                                                          Class<T> storageClass)

Specified by:

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

retrieveCurrentCredential

public <T extends org.picketlink.idm.credential.spi.CredentialStorage> T retrieveCurrentCredential(org.picketlink.idm.spi.SecurityContext context,
                                                                                          org.picketlink.idm.model.Agent agent,
                                                                                          Class<T> storageClass)

Specified by:

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

storeCredential

public void storeCredential(org.picketlink.idm.spi.SecurityContext context,
                   org.picketlink.idm.model.Agent agent,
                   org.picketlink.idm.credential.spi.CredentialStorage storage)

Specified by:

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

updateCredential

public void updateCredential(org.picketlink.idm.spi.SecurityContext context,
                    org.picketlink.idm.model.Agent agent,
                    Object credential,
                    Date effectiveDate,
                    Date expiryDate)

Specified by:

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

validateCredentials

public void validateCredentials(org.picketlink.idm.spi.SecurityContext context,
                       org.picketlink.idm.credential.Credentials credentials)

Specified by:

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

convertPartitionEntityToPartition

protected org.picketlink.idm.model.Partition convertPartitionEntityToPartition(Object partitionObject)

getEntityManager

protected javax.persistence.EntityManager getEntityManager(org.picketlink.idm.spi.SecurityContext context)

lookupIdentityObjectById

protected Object lookupIdentityObjectById(org.picketlink.idm.spi.SecurityContext context,
                              String id)

Lookup a stored IdentityType using the id.

Parameters:

id -

Returns:

lookupAndCreatePartitionObject

protected Object lookupAndCreatePartitionObject(org.picketlink.idm.spi.SecurityContext context,
                                    org.picketlink.idm.model.Partition partition)

getAllowedPartitionIds

protected List<String> getAllowedPartitionIds(org.picketlink.idm.spi.SecurityContext context,
                                  org.picketlink.idm.model.Partition currentPartition)