org.kuali.rice.kim.service.impl

Class IdentityArchiveServiceImpl

java.lang.Object

org.kuali.rice.kim.service.impl.IdentityArchiveServiceImpl

All Implemented Interfaces:

IdentityArchiveService, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class IdentityArchiveServiceImpl
extends Object
implements IdentityArchiveService, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

This is the default implementation for the IdentityArchiveService.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

IdentityArchiveService

Constructor Summary

Constructors

Constructor and Description
IdentityArchiveServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() schedule the writer on the KSB scheduled pool.
void	destroy() flush the write queue immediately.
void	flushToArchive() Flushes EntityDefault to the archive.
EntityDefault	getEntityDefaultFromArchive(String entityId) Gets a EntityDefault with an id from the archive.
EntityDefault	getEntityDefaultFromArchiveByEmployeeId(String employeeId) Gets a EntityDefault with an employeeId from the archive.
EntityDefault	getEntityDefaultFromArchiveByPrincipalId(String principalId) Gets a EntityDefault with an principalId from the archive.
EntityDefault	getEntityDefaultFromArchiveByPrincipalName(String principalName) Gets a EntityDefault with an principalName from the archive.
void	saveEntityDefaultToArchive(EntityDefault entity) Saves a EntityDefault to the archive.
void	setBusinessObjectService(BusinessObjectService businessObjectService)
void	setKualiConfigurationService(ConfigurationService kualiConfigurationService)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager txMgr)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityArchiveServiceImpl

public IdentityArchiveServiceImpl()

Method Detail

getEntityDefaultFromArchive

public EntityDefault getEntityDefaultFromArchive(String entityId)

Description copied from interface: IdentityArchiveService

Gets a EntityDefault with an id from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:

getEntityDefaultFromArchive in interface IdentityArchiveService

Parameters:

entityId - the unique id to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

getEntityDefaultFromArchiveByPrincipalId

public EntityDefault getEntityDefaultFromArchiveByPrincipalId(String principalId)

Description copied from interface: IdentityArchiveService

Gets a EntityDefault with an principalId from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:

getEntityDefaultFromArchiveByPrincipalId in interface IdentityArchiveService

Parameters:

principalId - the unique principalId to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

getEntityDefaultFromArchiveByPrincipalName

public EntityDefault getEntityDefaultFromArchiveByPrincipalName(String principalName)

Description copied from interface: IdentityArchiveService

Gets a EntityDefault with an principalName from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:

getEntityDefaultFromArchiveByPrincipalName in interface IdentityArchiveService

Parameters:

principalName - the unique principalName to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

getEntityDefaultFromArchiveByEmployeeId

public EntityDefault getEntityDefaultFromArchiveByEmployeeId(String employeeId)

Description copied from interface: IdentityArchiveService

Gets a EntityDefault with an employeeId from the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:

getEntityDefaultFromArchiveByEmployeeId in interface IdentityArchiveService

Parameters:

employeeId - the unique employeeId to retrieve the entity by. cannot be null.

Returns:

a EntityDefault or null

saveEntityDefaultToArchive

public void saveEntityDefaultToArchive(EntityDefault entity)

Description copied from interface: IdentityArchiveService

Saves a EntityDefault to the archive. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return the saved EntityDefault object

Specified by:

saveEntityDefaultToArchive in interface IdentityArchiveService

Parameters:

entity - the unique principalName to retrieve the entity by. cannot be null.

flushToArchive

public void flushToArchive()

Description copied from interface: IdentityArchiveService

Flushes EntityDefault to the archive.

This method flushes the "saved" entities to the database

Specified by:

flushToArchive in interface IdentityArchiveService

setBusinessObjectService

public void setBusinessObjectService(BusinessObjectService businessObjectService)

setKualiConfigurationService

public void setKualiConfigurationService(ConfigurationService kualiConfigurationService)

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager txMgr)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

schedule the writer on the KSB scheduled pool.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

destroy

public void destroy()
             throws Exception

flush the write queue immediately.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception