org.picketlink.idm.jpa.internal

Class IdentityTypeHandler<T extends org.picketlink.idm.model.IdentityType>

java.lang.Object

org.picketlink.idm.jpa.internal.IdentityTypeHandler<T>

Direct Known Subclasses:

AgentHandler, GroupHandler, RoleHandler, UserHandler

public abstract class IdentityTypeHandler<T extends org.picketlink.idm.model.IdentityType>
extends Object

Base class that provides some common functionality for IdentityType types.

Author:

Pedro Silva

Constructor Summary

Constructors

Constructor and Description
IdentityTypeHandler()

Method Summary

Methods

Modifier and Type	Method and Description
Object	createEntity(org.picketlink.idm.spi.SecurityContext context, T fromIdentityType, JPAIdentityStore store) Creates a Identity Class instance using the information from the given IdentityType.
T	createIdentityType(org.picketlink.idm.spi.SecurityContext context, Object identity, JPAIdentityStore store) Creates a IdentityType instance using the information from the given Identity Class instance.
protected abstract T	doCreateIdentityType(org.picketlink.idm.spi.SecurityContext context, Object identity, JPAIdentityStore store) Subclasses should override this method to create a specific IdentityType given the provided Identity Class instance.
protected abstract void	doPopulateIdentityInstance(org.picketlink.idm.spi.SecurityContext context, Object toIdentity, T fromIdentityType, JPAIdentityStore store) Subclasses should override this method to populate the given Identity Class instance with the specific information for a given IdentityType.
List<javax.persistence.criteria.Order>	getOrders(JPACriteriaQueryBuilder criteria, JPAIdentityStore store) Return list of Order instances to be used for sorting during the query execution.
List<javax.persistence.criteria.Predicate>	getPredicate(org.picketlink.idm.spi.SecurityContext context, JPACriteriaQueryBuilder criteria, JPAIdentityStore store) Returns a List of Predicate to be used during the query execution.
protected Map<org.picketlink.idm.query.QueryParameter,org.picketlink.idm.config.JPAIdentityStoreConfiguration.PropertyType>	getSortParametersMapping()
protected void	populateEntity(org.picketlink.idm.spi.SecurityContext context, Object toIdentity, T fromIdentityType, JPAIdentityStore store) Populates the given Object argument representing a Identity Class (from the config) with the information from the specified IdentityType.
protected abstract org.picketlink.idm.event.AbstractBaseEvent	raiseCreatedEvent(T fromIdentityType)
protected abstract org.picketlink.idm.event.AbstractBaseEvent	raiseDeletedEvent(T fromIdentityType)
protected abstract org.picketlink.idm.event.AbstractBaseEvent	raiseUpdatedEvent(T fromIdentityType)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityTypeHandler

public IdentityTypeHandler()

Method Detail

createIdentityType

public T createIdentityType(org.picketlink.idm.spi.SecurityContext context,
                   Object identity,
                   JPAIdentityStore store)

Creates a IdentityType instance using the information from the given Identity Class instance. This method already provides the mapping for the common properties for all IdentityType types.

Parameters:

identity -

Returns:

createEntity

public Object createEntity(org.picketlink.idm.spi.SecurityContext context,
                  T fromIdentityType,
                  JPAIdentityStore store)

Creates a Identity Class instance using the information from the given IdentityType.

Parameters:

fromIdentityType -

Returns:

populateEntity

protected void populateEntity(org.picketlink.idm.spi.SecurityContext context,
                  Object toIdentity,
                  T fromIdentityType,
                  JPAIdentityStore store)

Populates the given Object argument representing a Identity Class (from the config) with the information from the specified IdentityType.

Parameters:

toIdentity -

fromIdentityType -

getPredicate

public List<javax.persistence.criteria.Predicate> getPredicate(org.picketlink.idm.spi.SecurityContext context,
                                                      JPACriteriaQueryBuilder criteria,
                                                      JPAIdentityStore store)

Returns a List of Predicate to be used during the query execution. This method already provides the mapping for the common properties for all IdentityType types.

Parameters:

criteria -

Returns:

getOrders

public List<javax.persistence.criteria.Order> getOrders(JPACriteriaQueryBuilder criteria,
                                               JPAIdentityStore store)

Return list of Order instances to be used for sorting during the query execution.

Parameters:

criteria - criteria which encapsulate all the parameters and JPA builder

Returns:

list of orders to be used during identity query execution

doCreateIdentityType

protected abstract T doCreateIdentityType(org.picketlink.idm.spi.SecurityContext context,
                     Object identity,
                     JPAIdentityStore store)

Subclasses should override this method to create a specific IdentityType given the provided Identity Class instance.

Parameters:

identity -

Returns:

doPopulateIdentityInstance

protected abstract void doPopulateIdentityInstance(org.picketlink.idm.spi.SecurityContext context,
                              Object toIdentity,
                              T fromIdentityType,
                              JPAIdentityStore store)

Subclasses should override this method to populate the given Identity Class instance with the specific information for a given IdentityType.

Parameters:

toIdentity -

fromIdentityType -

raiseCreatedEvent

protected abstract org.picketlink.idm.event.AbstractBaseEvent raiseCreatedEvent(T fromIdentityType)

raiseUpdatedEvent

protected abstract org.picketlink.idm.event.AbstractBaseEvent raiseUpdatedEvent(T fromIdentityType)

raiseDeletedEvent

protected abstract org.picketlink.idm.event.AbstractBaseEvent raiseDeletedEvent(T fromIdentityType)

getSortParametersMapping

protected Map<org.picketlink.idm.query.QueryParameter,org.picketlink.idm.config.JPAIdentityStoreConfiguration.PropertyType> getSortParametersMapping()