org.kuali.kra.award.awardhierarchy.sync.service

Class AwardSyncServiceImpl

java.lang.Object

org.kuali.kra.award.awardhierarchy.sync.service.AwardSyncServiceImpl

All Implemented Interfaces:

AwardSyncService

public class AwardSyncServiceImpl
extends Object
implements AwardSyncService

Award Hierarchy Sync Service Implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AwardSyncServiceImpl.RunSyncOnAward Runnable that calls AwardSyncServiceImpl#applyChanges in a separate thread.
protected class	AwardSyncServiceImpl.SendAdHocRequests Runnable that sends a list of ad hoc requests in a separate thread.
protected class	AwardSyncServiceImpl.SyncRunnable Parent for thread based runnables related to award sync to provide a finished flag that supports ensuring all threads are finished.
protected static class	AwardSyncServiceImpl.SyncType Validation or running full sync
protected class	AwardSyncServiceImpl.TransactionRunnable Abstract class that is used to generate runnables to run in transactions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHANGE_LOG_SUCCESS
protected static String	IGNORED_MESSAGE_KEYS
protected org.apache.commons.logging.Log	LOG
protected static String	SYNC_FAILURE_MESSAGE
protected static String	SYNC_SAVED_MESSAGE
protected static String	SYNC_SUCCESS_MESSAGE
protected static String	VALIDATION_FAILURE_MESSAGE
protected static String	VALIDATION_SUCCESS_MESSAGE

Constructor Summary

Constructors

Constructor and Description
AwardSyncServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applyAndValidateChanges(Award award, AwardSyncStatus awardStatus, List<AwardSyncChange> changes) Apply the list of changes against the award and then validate the changes.
void	applyAwardSyncChangesToHierarchy(Award award) Apply the sync changes queued on the specified award against the award hierarchy
protected boolean	applyChange(Award award, AwardSyncChange change, AwardSyncStatus awardStatus) Apply single sync change to award.
protected void	applyChange(Award award, AwardSyncHelper syncHelper, AwardSyncChange change) Apply the specific change to the award using the specified syncHelper.
protected boolean	areRunnablesFinished(List<AwardSyncServiceImpl.SyncRunnable> runnables) Loops through all runnables and check their finished flags.
protected Award	checkAwardVersions(String awardNumber, AwardSyncStatus awardStatus, String failureMessage) Check and validate the status of the award.
protected void	clearSyncStatuses(Award award) Clears sync status from parent award as long as it has an award number(not the parent status), and it is not yet complete.
protected void	finalizeAward(AwardDocument awardDocument, AwardSyncStatus awardSyncStatus) Blanket Approve the award document.
protected void	finalizeAwardStatus(AwardDocument awardDocument, AwardSyncStatus awardStatus, String successMessage, AwardSyncServiceImpl.SyncType syncType, List<String> principalsToNotify) Finalize the award sync.
protected AwardSyncStatus	findAwardSyncStatus(Award parentAward, String awardNumber) Find or create a new award status for the award number.
protected Award	getActiveAward(String awardNumber) Get the active version of an award if it exists.
protected List<String>	getAllPrincipalsToNotify(List<AwardSyncServiceImpl.SyncRunnable> runnables) Collects all prinicipalsToNotify from #RunSyncOnAward runnables in the list of runnables.
protected AwardHierarchyService	getAwardHierarchyService()
AwardDocument	getAwardLockingHierarchyForSync(AwardDocument awardDocument, String principalId) Checks to see if the award hierarchy is locked for the given principal.
protected AwardService	getAwardService()
protected AwardSyncCreationService	getAwardSyncCreationService()
protected AwardSyncHelpersService	getAwardSyncHelpersService()
protected AwardSyncSelectorService	getAwardSyncSelectorService()
protected AwardSyncUtilityService	getAwardSyncUtilityService()
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
protected KraAuthorizationService	getKraAuthorizationService()
protected KraWorkflowService	getKraWorkflowService()
protected List<String>	getNotificationList(AwardDocument awardDocument) Save award and generate a list of workflow recipients as if this document were normally routed to later be used in an FYI list of the parent award.
protected AwardSyncStatus	getParentAwardStatus(Award parentAward) Finds the parents award status log entry, the one without an award listed.
protected Award	getPendingAward(String awardNumber) Get the pending version for the award if it exists.
protected org.kuali.rice.kim.api.identity.PersonService	getPersonService()
protected org.kuali.rice.krad.service.PessimisticLockService	getPessimisticLockService()
protected org.springframework.core.task.TaskExecutor	getSyncExecutor()
protected AwardSyncHelper	getSyncHelper(String className) Get the syncHelper from the syncHelpers for the given className.
protected VersionHistoryService	getVersionHistoryService()
protected boolean	hasAwardPermission(AwardSyncStatus awardStatus, Award award, String principalId) Ensure that the person specified by principalId has modify permission on the award specified.
protected AwardDocument	loadAwardDocument(Award award) Attempts to load the award document for the specified award.
protected void	logFailure(AwardSyncStatus awardStatus, String statusMessage, String logMessage) Set the status to failure and set the status to the message and add the log message.
protected org.kuali.rice.krad.UserSession	replaceSessionWithRoutedBy(Award parentAward) Replace the UserSession with one for the user who routed the parent award.
protected void	runInTransaction(AwardSyncServiceImpl.TransactionRunnable runnable) Run the runnable in a separate transaction, commiting when finished or rolling back if an exception is generated.
protected void	runSync(Award award, AwardSyncServiceImpl.SyncType syncType) Run validation or full sync depending on syncType on the award hierarchy under award.
protected void	runSyncChanges(Award parentAward, AwardHierarchy hierarchy, AwardSyncServiceImpl.SyncType syncType, List<AwardSyncChange> changes, List<String> principalsToNotify) Run the actual sync changes against the specific award in the hierarchy.
protected void	runSyncInThread(Award parentAward, AwardHierarchy hierarchy, AwardSyncServiceImpl.SyncType syncType, List<AwardSyncChange> changes, List<AwardSyncServiceImpl.SyncRunnable> runnables) Run AwardSyncServiceImpl#applyChanges through the use of #RunSyncOnAward.
protected void	runSyncOnHierarchy(Award parentAward, AwardHierarchy hierarchy, List<AwardSyncChange> changes, AwardSyncServiceImpl.SyncType syncType, List<AwardSyncServiceImpl.SyncRunnable> runnables) Run the sync recursively down the hierarchy.
protected void	saveInTransaction(Object object) Save or delete object in a separate thread using #SaveBo.
protected void	sendAdHocRequestsInThread(AwardDocument document, String annotation, List<org.kuali.rice.krad.bo.AdHocRouteRecipient> recipients, List<AwardSyncServiceImpl.SyncRunnable> runnables) Send ad hoc requests in a thread.
protected void	sendSyncFYIs(Award award, List<String> principalsToNotify, List<AwardSyncServiceImpl.SyncRunnable> runnables) Sends FYIs to all principals listed in principalsToNotify for award.
void	setAwardHierarchyService(AwardHierarchyService awardHierarchyService)
void	setAwardService(AwardService awardService)
void	setAwardSyncCreationService(AwardSyncCreationService awardSyncCreationService)
void	setAwardSyncHelpersService(AwardSyncHelpersService awardSyncHelpersService)
void	setAwardSyncSelectorService(AwardSyncSelectorService awardSyncSelectorService)
void	setAwardSyncUtilityService(AwardSyncUtilityService awardSyncUtilityService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
void	setKraWorkflowService(KraWorkflowService kraWorkflowService)
protected void	setParentAwardStatus(Award parentAward, boolean success, String newStatus) Sets the parent award status for the sync.
void	setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)
void	setPessimisticLockService(org.kuali.rice.krad.service.PessimisticLockService pessimisticLockService)
void	setSyncExecutor(org.springframework.core.task.TaskExecutor syncExecutor)
void	setVersionHistoryService(VersionHistoryService versionHistoryService)
void	validateHierarchyChanges(Award award) Run all validation checks against the award in the hierarchy and the sync changes attached to the specified award
protected boolean	validateModifiedAward(AwardDocument award, AwardSyncStatus awardStatus) Run the DocumentRuleBase.processSaveDocument(org.kuali.rice.krad.document.Document) and AwardDocumentRule.processRunAuditBusinessRules(org.kuali.rice.krad.document.Document) against award.
protected AwardDocument	versionAndPrepareAwardDocument(Award parentAward, Award oldAward, AwardSyncStatus awardStatus) Create new version of oldAward and prepare document for sync by setting document description, transaction type, etc.
protected void	waitTillRunablesFinished(List<AwardSyncServiceImpl.SyncRunnable> runnables) Wait forever until all runnables are finished.

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_SUCCESS_MESSAGE

protected static final String VALIDATION_SUCCESS_MESSAGE

See Also:

Constant Field Values

VALIDATION_FAILURE_MESSAGE

protected static final String VALIDATION_FAILURE_MESSAGE

See Also:

Constant Field Values

SYNC_SAVED_MESSAGE

protected static final String SYNC_SAVED_MESSAGE

See Also:

Constant Field Values

SYNC_SUCCESS_MESSAGE

protected static final String SYNC_SUCCESS_MESSAGE

See Also:

Constant Field Values

SYNC_FAILURE_MESSAGE

protected static final String SYNC_FAILURE_MESSAGE

See Also:

Constant Field Values

CHANGE_LOG_SUCCESS

protected static final String CHANGE_LOG_SUCCESS

See Also:

Constant Field Values

IGNORED_MESSAGE_KEYS

protected static final String IGNORED_MESSAGE_KEYS

See Also:

Constant Field Values

LOG

protected final org.apache.commons.logging.Log LOG

Constructor Detail

AwardSyncServiceImpl

public AwardSyncServiceImpl()

Method Detail

validateHierarchyChanges

public void validateHierarchyChanges(Award award)

Description copied from interface: AwardSyncService

Run all validation checks against the award in the hierarchy and the sync changes attached to the specified award

Specified by:

validateHierarchyChanges in interface AwardSyncService

See Also:

AwardSyncService.validateHierarchyChanges(org.kuali.kra.award.home.Award)

applyAwardSyncChangesToHierarchy

public void applyAwardSyncChangesToHierarchy(Award award)

Description copied from interface: AwardSyncService

Apply the sync changes queued on the specified award against the award hierarchy

Specified by:

applyAwardSyncChangesToHierarchy in interface AwardSyncService

See Also:

AwardSyncService.applyAwardSyncChangesToHierarchy(org.kuali.kra.award.home.Award)

getAwardLockingHierarchyForSync

public AwardDocument getAwardLockingHierarchyForSync(AwardDocument awardDocument,
                                            String principalId)

Description copied from interface: AwardSyncService

Checks to see if the award hierarchy is locked for the given principal. Hierarchy is locked if there is an award higher in the hierarchy enroute with award hierarchy descendant sync and the principal is not who routed the parent document.

Specified by:

getAwardLockingHierarchyForSync in interface AwardSyncService

Returns:

the award document responsible for the lock

See Also:

AwardSyncService.getAwardLockingHierarchyForSync(org.kuali.kra.award.document.AwardDocument, java.lang.String)

runSync

protected void runSync(Award award,
           AwardSyncServiceImpl.SyncType syncType)

Run validation or full sync depending on syncType on the award hierarchy under award.

Parameters:

award -

syncType -

runSyncOnHierarchy

protected void runSyncOnHierarchy(Award parentAward,
                      AwardHierarchy hierarchy,
                      List<AwardSyncChange> changes,
                      AwardSyncServiceImpl.SyncType syncType,
                      List<AwardSyncServiceImpl.SyncRunnable> runnables)

Run the sync recursively down the hierarchy.

Parameters:

parentAward -

hierarchy -

changes -

syncType -

runnables -

clearSyncStatuses

protected void clearSyncStatuses(Award award)

Clears sync status from parent award as long as it has an award number(not the parent status), and it is not yet complete.

Parameters:

award -

runnables -

sendSyncFYIs

protected void sendSyncFYIs(Award award,
                List<String> principalsToNotify,
                List<AwardSyncServiceImpl.SyncRunnable> runnables)
                     throws org.kuali.rice.kew.api.exception.WorkflowException

Sends FYIs to all principals listed in principalsToNotify for award.

Parameters:

award -

principalsToNotify -

runnables -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

setParentAwardStatus

protected void setParentAwardStatus(Award parentAward,
                        boolean success,
                        String newStatus)

Sets the parent award status for the sync. This is done by creating and updating a sync status that has no award.

Parameters:

parentAward -

success -

newStatus -

runnables -

getParentAwardStatus

protected AwardSyncStatus getParentAwardStatus(Award parentAward)

Finds the parents award status log entry, the one without an award listed.

Parameters:

parentAward -

Returns:

findAwardSyncStatus

protected AwardSyncStatus findAwardSyncStatus(Award parentAward,
                                  String awardNumber)

Find or create a new award status for the award number.

Parameters:

parentAward -

awardNumber -

Returns:

replaceSessionWithRoutedBy

protected org.kuali.rice.krad.UserSession replaceSessionWithRoutedBy(Award parentAward)

Replace the UserSession with one for the user who routed the parent award.

Parameters:

parentAward -

Returns:

checkAwardVersions

protected Award checkAwardVersions(String awardNumber,
                       AwardSyncStatus awardStatus,
                       String failureMessage)

Check and validate the status of the award. Must have an active version and there must not be a pending version.

Parameters:

awardNumber -

awardStatus -

failureMessage -

Returns:

runSyncChanges

protected void runSyncChanges(Award parentAward,
                  AwardHierarchy hierarchy,
                  AwardSyncServiceImpl.SyncType syncType,
                  List<AwardSyncChange> changes,
                  List<String> principalsToNotify)

Run the actual sync changes against the specific award in the hierarchy.

Parameters:

parentAward -

hierarchy -

syncType -

changes -

principalsToNotify -

Throws:

RuntimeException

applyAndValidateChanges

protected boolean applyAndValidateChanges(Award award,
                              AwardSyncStatus awardStatus,
                              List<AwardSyncChange> changes)

Apply the list of changes against the award and then validate the changes.

Parameters:

award -

awardStatus -

changes -

Returns:

finalizeAwardStatus

protected void finalizeAwardStatus(AwardDocument awardDocument,
                       AwardSyncStatus awardStatus,
                       String successMessage,
                       AwardSyncServiceImpl.SyncType syncType,
                       List<String> principalsToNotify)
                            throws org.kuali.rice.kew.api.exception.WorkflowException

Finalize the award sync. If running validation this only requires setting the AwardSyncStatus to final. If running full sync the award is saved, FYI list generated and award blanket approved.

Parameters:

awardDocument -

awardStatus -

successMessage -

syncType -

principalsToNotify -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

loadAwardDocument

protected AwardDocument loadAwardDocument(Award award)

Attempts to load the award document for the specified award. This ensures that the workflow document is not null and can be used for validation.

Parameters:

awardStatus -

award -

errorMessage -

runnables -

Returns:

logFailure

protected void logFailure(AwardSyncStatus awardStatus,
              String statusMessage,
              String logMessage)

Set the status to failure and set the status to the message and add the log message.

Parameters:

awardStatus -

statusMessage -

logMessage -

hasAwardPermission

protected boolean hasAwardPermission(AwardSyncStatus awardStatus,
                         Award award,
                         String principalId)

Ensure that the person specified by principalId has modify permission on the award specified.

Parameters:

awardStatus -

award -

principalId -

errorMessage -

runnables -

Returns:

validateModifiedAward

protected boolean validateModifiedAward(AwardDocument award,
                            AwardSyncStatus awardStatus)

Run the DocumentRuleBase.processSaveDocument(org.kuali.rice.krad.document.Document) and AwardDocumentRule.processRunAuditBusinessRules(org.kuali.rice.krad.document.Document) against award. Add all messages generated from running the rules to logList as AwardSyncLog. Return false if any of the error keys generated by the rules are not in the ignoredMessageKeys list.

Parameters:

award -

logs -

Returns:

applyChange

protected void applyChange(Award award,
               AwardSyncHelper syncHelper,
               AwardSyncChange change)
                    throws Exception

Apply the specific change to the award using the specified syncHelper.

Parameters:

award -

syncHelper -

change -

Throws:

Exception

getSyncHelper

protected AwardSyncHelper getSyncHelper(String className)

Get the syncHelper from the syncHelpers for the given className. If the className is a full qualified class name, only the class name itself is used.

Parameters:

className -

Returns:

getActiveAward

protected Award getActiveAward(String awardNumber)

Get the active version of an award if it exists.

Parameters:

awardNumber -

Returns:

getPendingAward

protected Award getPendingAward(String awardNumber)

Get the pending version for the award if it exists.

Parameters:

awardNumber -

Returns:

waitTillRunablesFinished

protected void waitTillRunablesFinished(List<AwardSyncServiceImpl.SyncRunnable> runnables)
                                 throws AwardSyncException

Wait forever until all runnables are finished.

Parameters:

runnables -

Throws:

AwardSyncException

getAllPrincipalsToNotify

protected List<String> getAllPrincipalsToNotify(List<AwardSyncServiceImpl.SyncRunnable> runnables)

Collects all prinicipalsToNotify from #RunSyncOnAward runnables in the list of runnables.

Parameters:

runnables -

Returns:

areRunnablesFinished

protected boolean areRunnablesFinished(List<AwardSyncServiceImpl.SyncRunnable> runnables)

Loops through all runnables and check their finished flags.

Parameters:

runnables -

Returns:

applyChange

protected boolean applyChange(Award award,
                  AwardSyncChange change,
                  AwardSyncStatus awardStatus)

Apply single sync change to award.

Parameters:

parentAward -

award -

change -

logList -

Returns:

versionAndPrepareAwardDocument

protected AwardDocument versionAndPrepareAwardDocument(Award parentAward,
                                           Award oldAward,
                                           AwardSyncStatus awardStatus)

Create new version of oldAward and prepare document for sync by setting document description, transaction type, etc.

Parameters:

parentAward -

oldAward -

logList -

Returns:

getNotificationList

protected List<String> getNotificationList(AwardDocument awardDocument)
                                    throws org.kuali.rice.kew.api.exception.WorkflowException

Save award and generate a list of workflow recipients as if this document were normally routed to later be used in an FYI list of the parent award.

Parameters:

awardDocument -

Returns:

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

finalizeAward

protected void finalizeAward(AwardDocument awardDocument,
                 AwardSyncStatus awardSyncStatus)

Blanket Approve the award document.

Parameters:

newAwardDocument -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

saveInTransaction

protected void saveInTransaction(Object object)

Save or delete object in a separate thread using #SaveBo.

Parameters:

object -

delete -

runnables -

runInTransaction

protected void runInTransaction(AwardSyncServiceImpl.TransactionRunnable runnable)

Run the runnable in a separate transaction, commiting when finished or rolling back if an exception is generated.

Parameters:

runnable -

runSyncInThread

protected void runSyncInThread(Award parentAward,
                   AwardHierarchy hierarchy,
                   AwardSyncServiceImpl.SyncType syncType,
                   List<AwardSyncChange> changes,
                   List<AwardSyncServiceImpl.SyncRunnable> runnables)

Run AwardSyncServiceImpl#applyChanges through the use of #RunSyncOnAward.

Parameters:

parentAward -

currentVersion -

changes -

runnables -

sendAdHocRequestsInThread

protected void sendAdHocRequestsInThread(AwardDocument document,
                             String annotation,
                             List<org.kuali.rice.krad.bo.AdHocRouteRecipient> recipients,
                             List<AwardSyncServiceImpl.SyncRunnable> runnables)

Send ad hoc requests in a thread. This is used to make sure the requests are processed before the document moves to the next step in workflow and then the requests get ignored.

Parameters:

document -

annotation -

recipients -

runnables -

getAwardHierarchyService

protected AwardHierarchyService getAwardHierarchyService()

setAwardHierarchyService

public void setAwardHierarchyService(AwardHierarchyService awardHierarchyService)

getAwardService

protected AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

setVersionHistoryService

public void setVersionHistoryService(VersionHistoryService versionHistoryService)

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

getDocumentService

protected org.kuali.rice.krad.service.DocumentService getDocumentService()

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

getSyncExecutor

protected org.springframework.core.task.TaskExecutor getSyncExecutor()

setSyncExecutor

public void setSyncExecutor(org.springframework.core.task.TaskExecutor syncExecutor)

getAwardSyncSelectorService

protected AwardSyncSelectorService getAwardSyncSelectorService()

setAwardSyncSelectorService

public void setAwardSyncSelectorService(AwardSyncSelectorService awardSyncSelectorService)

getPersonService

protected org.kuali.rice.kim.api.identity.PersonService getPersonService()

setPersonService

public void setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)

getPessimisticLockService

protected org.kuali.rice.krad.service.PessimisticLockService getPessimisticLockService()

setPessimisticLockService

public void setPessimisticLockService(org.kuali.rice.krad.service.PessimisticLockService pessimisticLockService)

getKraWorkflowService

protected KraWorkflowService getKraWorkflowService()

setKraWorkflowService

public void setKraWorkflowService(KraWorkflowService kraWorkflowService)

getAwardSyncHelpersService

protected AwardSyncHelpersService getAwardSyncHelpersService()

setAwardSyncHelpersService

public void setAwardSyncHelpersService(AwardSyncHelpersService awardSyncHelpersService)

getAwardSyncCreationService

protected AwardSyncCreationService getAwardSyncCreationService()

setAwardSyncCreationService

public void setAwardSyncCreationService(AwardSyncCreationService awardSyncCreationService)

getAwardSyncUtilityService

protected AwardSyncUtilityService getAwardSyncUtilityService()

setAwardSyncUtilityService

public void setAwardSyncUtilityService(AwardSyncUtilityService awardSyncUtilityService)

getKraAuthorizationService

protected KraAuthorizationService getKraAuthorizationService()

setKraAuthorizationService

public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)