com.communote.server.persistence.user

Class ExternalUserAuthenticationDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.ExternalUserAuthenticationDaoBase

All Implemented Interfaces:

ExternalUserAuthenticationDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

ExternalUserAuthenticationDaoImpl

public abstract class ExternalUserAuthenticationDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements ExternalUserAuthenticationDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type com.communote.server.persistence.user.ExternalUserAuthentication.

Author:

Communote GmbH - http://www.communote.com/

See Also:

ExternalUserAuthentication

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface com.communote.server.persistence.user.ExternalUserAuthenticationDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
ExternalUserAuthenticationDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<ExternalUserAuthentication>	create(Collection<ExternalUserAuthentication> entities) Creates a new instance of com.communote.server.persistence.user.ExternalUserAuthentication and adds from the passed in entities collection
ExternalUserAuthentication	create(ExternalUserAuthentication externalUserAuthentication) Creates an instance of com.communote.server.persistence.user.ExternalUserAuthentication and adds it to the persistent store.
Collection<ExternalUserAuthentication>	create(int transform, Collection<ExternalUserAuthentication> entities) Does the same thing as ExternalUserAuthenticationDao.create(com.communote.server.model.user.ExternalUserAuthentication) with an additional flag called transform.
Object	create(int transform, ExternalUserAuthentication externalUserAuthentication) Does the same thing as ExternalUserAuthenticationDao.create(com.communote.server.model.user.ExternalUserAuthentication) with an additional flag called transform.
void	evict(ExternalUserAuthentication entity) Evicts (removes) the entity from the hibernate cache
List<ExternalUserAuthentication>	findBySystemId(String systemId) find all external authentications by the external systemId
Long	findUserByPermanentId(String externalSystemId, String permanentId) returns the ID of the user that has the provided permanent ID for the given system or null if there is no such user.
protected abstract List<ExternalUserAuthentication>	handleFindBySystemId(String systemId) Performs the core logic for findBySystemId(String)
protected abstract Long	handleFindUserByPermanentId(String externalSystemId, String permanentId) Performs the core logic for findUserByPermanentId(String, String)
Object	load(int transform, Long id) Does the same thing as ExternalUserAuthenticationDao.load(Long) with an additional flag called transform.
ExternalUserAuthentication	load(Long id) Loads an instance of com.communote.server.persistence.user.ExternalUserAuthentication from the persistent store.
Collection<ExternalUserAuthentication>	loadAll() Loads all entities of type ExternalUserAuthentication .
Collection<?>	loadAll(int transform) Does the same thing as ExternalUserAuthenticationDao.loadAll() with an additional flag called transform.
void	remove(Collection<ExternalUserAuthentication> entities) Removes all entities in the given entities collection.
void	remove(ExternalUserAuthentication externalUserAuthentication) Removes the instance of com.communote.server.persistence.user.ExternalUserAuthentication from the persistent store.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.ExternalUserAuthentication having the given identifier from the persistent store.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.ExternalUserAuthentication) method.
protected Object	transformEntity(int transform, ExternalUserAuthentication entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.ExternalUserAuthenticationDao, please note that the ExternalUserAuthenticationDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<ExternalUserAuthentication> entities) Updates all instances in the entities collection in the persistent store.
void	update(ExternalUserAuthentication externalUserAuthentication) Updates the externalUserAuthentication instance in the persistent store.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalUserAuthenticationDaoBase

public ExternalUserAuthenticationDaoBase()

Method Detail

create

public ExternalUserAuthentication create(ExternalUserAuthentication externalUserAuthentication)

Description copied from interface: ExternalUserAuthenticationDao

Creates an instance of com.communote.server.persistence.user.ExternalUserAuthentication and adds it to the persistent store.

Specified by:

create in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.create(com.communote.server.model.user.ExternalUserAuthentication)

create

public Object create(int transform,
                     ExternalUserAuthentication externalUserAuthentication)

Description copied from interface: ExternalUserAuthenticationDao

Does the same thing as ExternalUserAuthenticationDao.create(com.communote.server.model.user.ExternalUserAuthentication) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface ExternalUserAuthenticationDao

See Also:

com.communote.server.persistence.user.ExternalUserAuthenticationDao#create(int transform, com.communote.server.persistence.user.ExternalUserAuthentication)

create

public Collection<ExternalUserAuthentication> create(int transform,
                                                     Collection<ExternalUserAuthentication> entities)

Description copied from interface: ExternalUserAuthenticationDao

Does the same thing as ExternalUserAuthenticationDao.create(com.communote.server.model.user.ExternalUserAuthentication) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Specified by:

create in interface ExternalUserAuthenticationDao

See Also:

com.communote.server.persistence.user.ExternalUserAuthenticationDao#create(int, java.util.Collection)

create

public Collection<ExternalUserAuthentication> create(Collection<ExternalUserAuthentication> entities)

Description copied from interface: ExternalUserAuthenticationDao

Creates a new instance of com.communote.server.persistence.user.ExternalUserAuthentication and adds from the passed in entities collection

Specified by:

create in interface ExternalUserAuthenticationDao

Parameters:

entities - the collection of com.communote.server.persistence.user.ExternalUserAuthentication instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.user.ExternalUserAuthenticationDao#create(java.util. Collection)

evict

public void evict(ExternalUserAuthentication entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface ExternalUserAuthenticationDao

Parameters:

entity - the entity to evict

findBySystemId

public List<ExternalUserAuthentication> findBySystemId(String systemId)

Description copied from interface: ExternalUserAuthenticationDao

find all external authentications by the external systemId

Specified by:

findBySystemId in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.findBySystemId(String)

findUserByPermanentId

public Long findUserByPermanentId(String externalSystemId,
                                  String permanentId)

Description copied from interface: ExternalUserAuthenticationDao

returns the ID of the user that has the provided permanent ID for the given system or null if there is no such user.

Specified by:

findUserByPermanentId in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.findUserByPermanentId(String, String)

handleFindBySystemId

protected abstract List<ExternalUserAuthentication> handleFindBySystemId(String systemId)

Performs the core logic for findBySystemId(String)

handleFindUserByPermanentId

protected abstract Long handleFindUserByPermanentId(String externalSystemId,
                                                    String permanentId)

Performs the core logic for findUserByPermanentId(String, String)

load

public Object load(int transform,
                   Long id)

Description copied from interface: ExternalUserAuthenticationDao

Does the same thing as ExternalUserAuthenticationDao.load(Long) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface ExternalUserAuthenticationDao

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

ExternalUserAuthenticationDao.load(int, Long)

load

public ExternalUserAuthentication load(Long id)

Description copied from interface: ExternalUserAuthenticationDao

Loads an instance of com.communote.server.persistence.user.ExternalUserAuthentication from the persistent store.

Specified by:

load in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.load(Long)

loadAll

public Collection<ExternalUserAuthentication> loadAll()

Description copied from interface: ExternalUserAuthenticationDao

Loads all entities of type ExternalUserAuthentication .

Specified by:

loadAll in interface ExternalUserAuthenticationDao

Returns:

the loaded entities.

See Also:

ExternalUserAuthenticationDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: ExternalUserAuthenticationDao

Does the same thing as ExternalUserAuthenticationDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

loadAll in interface ExternalUserAuthenticationDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

ExternalUserAuthenticationDao.loadAll(int)

remove

public void remove(ExternalUserAuthentication externalUserAuthentication)

Description copied from interface: ExternalUserAuthenticationDao

Removes the instance of com.communote.server.persistence.user.ExternalUserAuthentication from the persistent store.

Specified by:

remove in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.remove(com.communote.server.model.user.ExternalUserAuthentication)

remove

public void remove(Collection<ExternalUserAuthentication> entities)

Description copied from interface: ExternalUserAuthenticationDao

Removes all entities in the given entities collection.

Specified by:

remove in interface ExternalUserAuthenticationDao

See Also:

com.communote.server.persistence.user.ExternalUserAuthenticationDao#remove(java.util. Collection)

remove

public void remove(Long id)

Description copied from interface: ExternalUserAuthenticationDao

Removes the instance of com.communote.server.persistence.user.ExternalUserAuthentication having the given identifier from the persistent store.

Specified by:

remove in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.remove(Long)

transformEntities

protected void transformEntities(int transform,
                                 Collection<?> entities)

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.ExternalUserAuthentication) method. This method does not instantiate a new collection.

This method is to be used internally only.

Parameters:

transform - one of the constants declared in com.communote.server.persistence.user.ExternalUserAuthenticationDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.user.ExternalUserAuthentication)

transformEntity

protected Object transformEntity(int transform,
                                 ExternalUserAuthentication entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.ExternalUserAuthenticationDao, please note that the ExternalUserAuthenticationDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown ExternalUserAuthenticationDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in ExternalUserAuthenticationDao

entity - an entity that was found

Returns:

the transformed entity (i.e. new value object, etc)

See Also:

transformEntities(int,java.util.Collection)

update

public void update(ExternalUserAuthentication externalUserAuthentication)

Description copied from interface: ExternalUserAuthenticationDao

Updates the externalUserAuthentication instance in the persistent store.

Specified by:

update in interface ExternalUserAuthenticationDao

See Also:

ExternalUserAuthenticationDao.update(com.communote.server.model.user.ExternalUserAuthentication)

update

public void update(Collection<ExternalUserAuthentication> entities)

Description copied from interface: ExternalUserAuthenticationDao

Updates all instances in the entities collection in the persistent store.

Specified by:

update in interface ExternalUserAuthenticationDao

See Also:

com.communote.server.persistence.user.ExternalUserAuthenticationDao#update(java.util. Collection)