com.rsmart.kuali.coeus.hr.service.impl

Class HRImportServiceImpl

java.lang.Object

com.rsmart.kuali.coeus.hr.service.impl.HRImportServiceImpl

All Implemented Interfaces:

HRImportService

public class HRImportServiceImpl
extends Object
implements HRImportService

This implements the core logic for performing an import of an HR file. This class is dependent upon several services from KIM and KRA: IdentityService, legacyDataAdapter, UnitService, and CacheManagerRegistry Processing starts in the startImport method.

Author:

duffy

Constructor Summary

Constructors

Constructor and Description
HRImportServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	abort(String importId)
protected <T,Z> List<T>	adaptAndSortList(String entityId, List<Z> toImport, PersistableBoMergeAdapter<T,Z> adapter) This converts an incoming set of JAXB objects into their corresponding KIM entity objects.
protected void	deactivatePeople(List<String> ids)
protected void	delete(org.kuali.rice.kim.impl.identity.entity.EntityBo entity) Deletes and entity and all its dependent entities.
void	deletePerson(String entityId) Removes a single person and his/her dependent entities
protected boolean	equals(org.kuali.coeus.common.framework.person.attr.KcPersonExtendedAttributes oldAttrs, KCExtendedAttributes newAttrs)
org.kuali.coeus.sys.framework.auth.AuthServicePushService	getAuthServicePushService()
protected void	handleRecord(HRImportRecord record)
protected <T,Z> boolean	mergeImportedBOs(List<Z> objsToMerge, List<T> existingBOs, PersistableBoMergeAdapter<T,Z> adapter, String entityId) This merges an incoming list of JAXB objects into a list of existing business objects for a single Entity.
protected org.kuali.rice.kim.impl.identity.entity.EntityBo	newEntityBo(HRImportRecord record)
protected boolean	nullSafeEquals(Object obj0, Object obj1)
void	setAuthServicePushService(org.kuali.coeus.sys.framework.auth.AuthServicePushService authServicePushService)
void	setCacheManagerRegistry(org.kuali.rice.core.api.cache.CacheManagerRegistry registry)
void	setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)
void	setImportStatusService(ImportStatusService svc)
void	setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter)
void	setUnitService(org.kuali.coeus.common.framework.unit.UnitService unitService)
void	startImport(String importId, HRImport toImport) This is the workhorse of HRImportServiceImpl.
protected org.kuali.rice.kim.impl.identity.principal.PrincipalBo	updateEntityBo(org.kuali.rice.kim.impl.identity.entity.EntityBo entity, HRImportRecord record) This handles each of the KIM dependent entity business object collections connected to a single Entity.
protected boolean	updateExtendedAttributes(String principalId, HRImportRecord record)
protected org.kuali.rice.kim.impl.identity.principal.PrincipalBo	updatePrincipal(org.kuali.rice.kim.impl.identity.entity.EntityBo entity, HRImportRecord record) Set the principal name and Id.
protected Set<javax.validation.ConstraintViolation<HRImportRecord>>	validateRecord(HRImportRecord record)

Methods inherited from class java.lang.Object

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

Constructor Detail

HRImportServiceImpl

public HRImportServiceImpl()

Method Detail

setImportStatusService

public void setImportStatusService(ImportStatusService svc)

Specified by:

setImportStatusService in interface HRImportService

deactivatePeople

protected void deactivatePeople(List<String> ids)

validateRecord

protected Set<javax.validation.ConstraintViolation<HRImportRecord>> validateRecord(HRImportRecord record)

handleRecord

protected void handleRecord(HRImportRecord record)
                     throws Exception

Throws:

Exception

startImport

public void startImport(String importId,
                        HRImport toImport)

This is the workhorse of HRImportServiceImpl. It takes an HRImport and walks through the records it contains. For each record the contained dependent business objects are merged with the list of current business objects. Each set of dependent objects is handled in the following manner: 1) if the list of dependent objects does not exist in the import, no change is made. 2) if the list exists 2.1) any new items in the list are added 2.2) any old items currently stored for the user which are not in the list are deleted 2.3) any new items in the list that are equivalent to items already attached to the user are ignored. The net effect is that the state of incoming collections of business objects will replace the state stored for the user. If no change is desired for a particular set of business objects (eg. no changes have occurred for a user's name or email records) it can be omitted entirely from the import. This is *different* than including an empty element in the import. An empty element will cause all of that type of business object to be deleted for the user.

Specified by:

startImport in interface HRImportService

adaptAndSortList

protected final <T,Z> List<T> adaptAndSortList(String entityId,
                                               List<Z> toImport,
                                               PersistableBoMergeAdapter<T,Z> adapter)

This converts an incoming set of JAXB objects into their corresponding KIM entity objects. The list is returned sorted so that it is possible to determine which incoming objects are new versus updates, versus when an existing object has been omitted in order to delete it.

Parameters:

entityId -

toImport -

adapter -

Returns:

mergeImportedBOs

protected <T,Z> boolean mergeImportedBOs(List<Z> objsToMerge,
                                         List<T> existingBOs,
                                         PersistableBoMergeAdapter<T,Z> adapter,
                                         String entityId)

This merges an incoming list of JAXB objects into a list of existing business objects for a single Entity.

Parameters:

objsToMerge -

existingBOs -

adapter -

entityId -

Returns:

updateEntityBo

protected org.kuali.rice.kim.impl.identity.principal.PrincipalBo updateEntityBo(org.kuali.rice.kim.impl.identity.entity.EntityBo entity,
                                                                                HRImportRecord record)

This handles each of the KIM dependent entity business object collections connected to a single Entity.

Parameters:

entity -

record -

deletePerson

public void deletePerson(String entityId)

Removes a single person and his/her dependent entities

Specified by:

deletePerson in interface HRImportService

delete

protected void delete(org.kuali.rice.kim.impl.identity.entity.EntityBo entity)

Deletes and entity and all its dependent entities.

Parameters:

entity -

updatePrincipal

protected org.kuali.rice.kim.impl.identity.principal.PrincipalBo updatePrincipal(org.kuali.rice.kim.impl.identity.entity.EntityBo entity,
                                                                                 HRImportRecord record)

Set the principal name and Id.

Parameters:

entity -

record -

newEntityBo

protected org.kuali.rice.kim.impl.identity.entity.EntityBo newEntityBo(HRImportRecord record)

nullSafeEquals

protected final boolean nullSafeEquals(Object obj0,
                                       Object obj1)

equals

protected final boolean equals(org.kuali.coeus.common.framework.person.attr.KcPersonExtendedAttributes oldAttrs,
                               KCExtendedAttributes newAttrs)

updateExtendedAttributes

protected boolean updateExtendedAttributes(String principalId,
                                           HRImportRecord record)

setIdentityService

public void setIdentityService(org.kuali.rice.kim.api.identity.IdentityService identityService)

setLegacyDataAdapter

public void setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter)

setUnitService

public void setUnitService(org.kuali.coeus.common.framework.unit.UnitService unitService)

setCacheManagerRegistry

public void setCacheManagerRegistry(org.kuali.rice.core.api.cache.CacheManagerRegistry registry)

abort

public void abort(String importId)

Specified by:

abort in interface HRImportService

getAuthServicePushService

public org.kuali.coeus.sys.framework.auth.AuthServicePushService getAuthServicePushService()

setAuthServicePushService

public void setAuthServicePushService(org.kuali.coeus.sys.framework.auth.AuthServicePushService authServicePushService)