generated from Health-Education-England/tis-microservice-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #465 from Health-Education-England/feat/responsibl…
…eOfficer Feat: responsible officer - needed resources
- Loading branch information
Showing
30 changed files
with
3,180 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
src/main/java/uk/nhs/hee/tis/trainee/sync/event/HeeUserEventListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright 2024 Crown Copyright (Health Education England) | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and | ||
| * associated documentation files (the "Software"), to deal in the Software without restriction, | ||
| * including without limitation the rights to use, copy, modify, merge, publish, distribute, | ||
| * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or | ||
| * substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT | ||
| * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
| * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| package uk.nhs.hee.tis.trainee.sync.event; | ||
|
|
||
| import java.util.Optional; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.cache.Cache; | ||
| import org.springframework.cache.CacheManager; | ||
| import org.springframework.data.mongodb.core.mapping.event.AbstractMongoEventListener; | ||
| import org.springframework.data.mongodb.core.mapping.event.AfterDeleteEvent; | ||
| import org.springframework.data.mongodb.core.mapping.event.AfterSaveEvent; | ||
| import org.springframework.data.mongodb.core.mapping.event.BeforeDeleteEvent; | ||
| import org.springframework.stereotype.Component; | ||
| import uk.nhs.hee.tis.trainee.sync.model.HeeUser; | ||
| import uk.nhs.hee.tis.trainee.sync.service.DbcSyncService; | ||
| import uk.nhs.hee.tis.trainee.sync.service.HeeUserSyncService; | ||
|
|
||
| /** | ||
| * A listener for HEE user mongo events. | ||
| */ | ||
| @Slf4j | ||
| @Component | ||
| public class HeeUserEventListener extends AbstractMongoEventListener<HeeUser> { | ||
|
|
||
| public static final String HEE_USER_NAME = "name"; | ||
|
|
||
| private final HeeUserSyncService heeUserSyncService; | ||
| private final DbcSyncService dbcSyncService; | ||
|
|
||
| private final Cache cache; | ||
|
|
||
| HeeUserEventListener(HeeUserSyncService heeUserSyncService, | ||
| DbcSyncService dbcSyncService, CacheManager cacheManager) { | ||
| this.heeUserSyncService = heeUserSyncService; | ||
| this.dbcSyncService = dbcSyncService; | ||
| this.cache = cacheManager.getCache(HeeUser.ENTITY_NAME); | ||
| } | ||
|
|
||
| @Override | ||
| public void onAfterSave(AfterSaveEvent<HeeUser> event) { | ||
| super.onAfterSave(event); | ||
|
|
||
| HeeUser heeUser = event.getSource(); | ||
| String userName = heeUser.getData().get(HEE_USER_NAME); | ||
|
|
||
| dbcSyncService.resyncProgrammesIfUserIsResponsibleOfficer(userName); | ||
| } | ||
|
|
||
| /** | ||
| * Before deleting a HEE user, ensure it is cached. | ||
| * | ||
| * @param event The before-delete event for the HEE user. | ||
| */ | ||
| @Override | ||
| public void onBeforeDelete(BeforeDeleteEvent<HeeUser> event) { | ||
| super.onBeforeDelete(event); | ||
| String id = event.getSource().get("_id").toString(); | ||
| HeeUser heeUser = cache.get(id, HeeUser.class); | ||
|
|
||
| if (heeUser == null) { | ||
| Optional<HeeUser> newHeeUser = heeUserSyncService.findById(id); | ||
| newHeeUser.ifPresent(psToCache -> cache.put(id, psToCache)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve the deleted HEE user from the cache and sync related programmes if they are a | ||
| * responsible officer. | ||
| * | ||
| * @param event The after-delete event for the HEE user. | ||
| */ | ||
| @Override | ||
| public void onAfterDelete(AfterDeleteEvent<HeeUser> event) { | ||
| super.onAfterDelete(event); | ||
| String id = event.getSource().get("_id").toString(); | ||
| HeeUser heeUser = cache.get(id, HeeUser.class); | ||
|
|
||
| if (heeUser != null) { | ||
| String userName = heeUser.getData().get(HEE_USER_NAME); | ||
| dbcSyncService.resyncProgrammesIfUserIsResponsibleOfficer(userName); | ||
| } | ||
| } | ||
| } | ||
|
|
146 changes: 146 additions & 0 deletions
146
src/main/java/uk/nhs/hee/tis/trainee/sync/event/UserDesignatedBodyEventListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright 2024 Crown Copyright (Health Education England) | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and | ||
| * associated documentation files (the "Software"), to deal in the Software without restriction, | ||
| * including without limitation the rights to use, copy, modify, merge, publish, distribute, | ||
| * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or | ||
| * substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT | ||
| * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
| * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
|
|
||
| package uk.nhs.hee.tis.trainee.sync.event; | ||
|
|
||
| import java.util.Optional; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.cache.Cache; | ||
| import org.springframework.cache.CacheManager; | ||
| import org.springframework.data.mongodb.core.mapping.event.AbstractMongoEventListener; | ||
| import org.springframework.data.mongodb.core.mapping.event.AfterDeleteEvent; | ||
| import org.springframework.data.mongodb.core.mapping.event.AfterSaveEvent; | ||
| import org.springframework.data.mongodb.core.mapping.event.BeforeDeleteEvent; | ||
| import org.springframework.stereotype.Component; | ||
| import uk.nhs.hee.tis.trainee.sync.model.Dbc; | ||
| import uk.nhs.hee.tis.trainee.sync.model.HeeUser; | ||
| import uk.nhs.hee.tis.trainee.sync.model.UserDesignatedBody; | ||
| import uk.nhs.hee.tis.trainee.sync.service.DbcSyncService; | ||
| import uk.nhs.hee.tis.trainee.sync.service.HeeUserSyncService; | ||
| import uk.nhs.hee.tis.trainee.sync.service.UserDesignatedBodySyncService; | ||
|
|
||
| /** | ||
| * A listener for UserDesignatedBody mongo events. | ||
| */ | ||
| @Slf4j | ||
| @Component | ||
| public class UserDesignatedBodyEventListener extends | ||
| AbstractMongoEventListener<UserDesignatedBody> { | ||
|
|
||
| private static final String USER_NAME = "userName"; | ||
| public static final String DESIGNATED_BODY_CODE = "designatedBodyCode"; | ||
|
|
||
| private final UserDesignatedBodySyncService userDesignatedBodySyncService; | ||
| private final DbcSyncService dbcSyncService; | ||
| private final HeeUserSyncService heeUserSyncService; | ||
|
|
||
| private final Cache cache; | ||
|
|
||
| UserDesignatedBodyEventListener(UserDesignatedBodySyncService userDesignatedBodySyncService, | ||
| DbcSyncService dbcSyncService, HeeUserSyncService heeUserSyncService, | ||
| CacheManager cacheManager) { | ||
| this.userDesignatedBodySyncService = userDesignatedBodySyncService; | ||
| this.dbcSyncService = dbcSyncService; | ||
| this.heeUserSyncService = heeUserSyncService; | ||
| this.cache = cacheManager.getCache(UserDesignatedBody.ENTITY_NAME); | ||
| } | ||
|
|
||
| @Override | ||
| public void onAfterSave(AfterSaveEvent<UserDesignatedBody> event) { | ||
| //NOTE: this assumes an update to a UserDesignatedBody record is received as a delete and then | ||
| //an insert. Given the composite primary key on both table fields, this seems reasonable but | ||
| //needs to be checked, otherwise we could have stale RO details attached to programmes where | ||
| //a UserDesignatedBody record is modified to refer to a non-RO user. | ||
| super.onAfterSave(event); | ||
|
|
||
| UserDesignatedBody userDesignatedBody = event.getSource(); | ||
| syncOrRequestMissingData(userDesignatedBody, "saved"); | ||
| } | ||
|
|
||
| /** | ||
| * Before deleting a user designated body, ensure it is cached. | ||
| * | ||
| * @param event The before-delete event for the user designated body. | ||
| */ | ||
| @Override | ||
| public void onBeforeDelete(BeforeDeleteEvent<UserDesignatedBody> event) { | ||
| super.onBeforeDelete(event); | ||
| String id = event.getSource().get("_id").toString(); | ||
| UserDesignatedBody userDesignatedBody = cache.get(id, UserDesignatedBody.class); | ||
|
|
||
| if (userDesignatedBody == null) { | ||
| Optional<UserDesignatedBody> newUserDesignatedBody = userDesignatedBodySyncService.findById( | ||
| id); | ||
| newUserDesignatedBody.ifPresent(udbToCache -> cache.put(id, udbToCache)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Retrieve the deleted user designated body from the cache and sync the updated programmes. | ||
| * | ||
| * @param event The after-delete event for the user designated body. | ||
| */ | ||
| @Override | ||
| public void onAfterDelete(AfterDeleteEvent<UserDesignatedBody> event) { | ||
| super.onAfterDelete(event); | ||
| String id = event.getSource().get("_id").toString(); | ||
| UserDesignatedBody userDesignatedBody = cache.get(id, UserDesignatedBody.class); | ||
|
|
||
| if (userDesignatedBody != null) { | ||
| syncOrRequestMissingData(userDesignatedBody, "deleted"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Sync associated DBC programmes, or request missing HEE user or DBC records. | ||
| * | ||
| * @param userDesignatedBody The user designated body to sync from. | ||
| * @param eventContext The event context (for logging purposes). | ||
| */ | ||
| private void syncOrRequestMissingData(UserDesignatedBody userDesignatedBody, | ||
| String eventContext) { | ||
| String userNameValue = userDesignatedBody.getData().get(USER_NAME); | ||
| String designatedBodyCodeValue = userDesignatedBody.getData().get(DESIGNATED_BODY_CODE); | ||
|
|
||
| Optional<HeeUser> optionalHeeUser = heeUserSyncService.findByName(userNameValue); | ||
| Optional<Dbc> optionalDbc = dbcSyncService.findByDbc(designatedBodyCodeValue); | ||
|
|
||
| if (optionalHeeUser.isPresent() && optionalDbc.isPresent()) { | ||
| log.debug("User designated body {} {} and HEE user {} and Dbc found.", | ||
| designatedBodyCodeValue, eventContext, userNameValue); | ||
| dbcSyncService | ||
| .resyncProgrammesForSingleDbcIfUserIsResponsibleOfficer(userNameValue, | ||
| designatedBodyCodeValue); | ||
| } else { | ||
| if (optionalHeeUser.isEmpty()) { | ||
| log.info("User designated body {} {} but HEE user {} not found, requesting data.", | ||
| designatedBodyCodeValue, eventContext, userNameValue); | ||
| heeUserSyncService.request(userNameValue); | ||
| } | ||
| if (optionalDbc.isEmpty()) { | ||
| log.info("User designated body {} {} but Dbc not found, requesting data.", | ||
| designatedBodyCodeValue, eventContext); | ||
| dbcSyncService.request(designatedBodyCodeValue); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.