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(JPAIdentityStoreConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
Object	createEntity(T fromIdentityType, JPAIdentityStore store) Creates a Identity Class instance using the information from the given IdentityType.
T	createIdentityType(Object identity, JPAIdentityStore store) Creates a IdentityType instance using the information from the given Identity Class instance.
protected abstract T	doCreateIdentityType(Object identity, JPAIdentityStore store) Subclasses should override this method to create a specific IdentityType given the provided Identity Class instance.
protected abstract void	doPopulateIdentityInstance(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.
protected JPAIdentityStoreConfiguration	getConfig()
List<javax.persistence.criteria.Order>	getOrders(JPACriteriaQueryBuilder criteria) Return list of Order instances to be used for sorting during the query execution.
List<javax.persistence.criteria.Predicate>	getPredicate(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.jpa.annotations.PropertyType>	getSortParametersMapping()
protected void	populateEntity(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)
protected void	setModelPropertyValue(Object identity, org.picketlink.idm.jpa.annotations.PropertyType propertyType, Object value)
protected void	setModelPropertyValue(Object identity, org.picketlink.idm.jpa.annotations.PropertyType propertyType, Object value, boolean notNull)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityTypeHandler

public IdentityTypeHandler(JPAIdentityStoreConfiguration config)

Method Detail

createIdentityType

public T createIdentityType(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(T fromIdentityType,
                  JPAIdentityStore store)

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

Parameters:

fromIdentityType -

Returns:

populateEntity

protected void populateEntity(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(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)

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(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(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)

getConfig

protected JPAIdentityStoreConfiguration getConfig()

setModelPropertyValue

protected void setModelPropertyValue(Object identity,
                         org.picketlink.idm.jpa.annotations.PropertyType propertyType,
                         Object value,
                         boolean notNull)

setModelPropertyValue

protected void setModelPropertyValue(Object identity,
                         org.picketlink.idm.jpa.annotations.PropertyType propertyType,
                         Object value)

getSortParametersMapping

protected Map<org.picketlink.idm.query.QueryParameter,org.picketlink.idm.jpa.annotations.PropertyType> getSortParametersMapping()