1 files changed, 98 insertions, 81 deletions

diff --git a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAustrianResidenceGuiResponseTask.java b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAustrianResidenceGuiResponseTask.java
index acf469d3..89a3f350 100644
--- a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAustrianResidenceGuiResponseTask.java
+++ b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAustrianResidenceGuiResponseTask.java
@@ -23,16 +23,24 @@
 
 package at.asitplus.eidas.specific.modules.auth.eidas.v2.tasks;
 
+import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.CONTEXT_FLAG_ADVANCED_MATCHING_FAILED;
+import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.CONTEXT_FLAG_ADVANCED_MATCHING_FAILED_REASON;
+import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK;
+
 import java.util.Enumeration;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.commons.lang.StringEscapeUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.stereotype.Component;
 
 import at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants;
+import at.asitplus.eidas.specific.modules.auth.eidas.v2.controller.AdresssucheController;
+import at.asitplus.eidas.specific.modules.auth.eidas.v2.controller.AdresssucheController.AdresssucheOutput;
+import at.asitplus.eidas.specific.modules.auth.eidas.v2.controller.AdresssucheController.AdresssucheOutput.AdresssucheOutputBuilder;
 import at.asitplus.eidas.specific.modules.auth.eidas.v2.dao.MatchedPersonResult;
 import at.asitplus.eidas.specific.modules.auth.eidas.v2.dao.SimpleEidasData;
 import at.asitplus.eidas.specific.modules.auth.eidas.v2.exception.ManualFixNecessaryException;
@@ -43,15 +51,9 @@ import at.asitplus.eidas.specific.modules.auth.eidas.v2.utils.MatchingTaskUtils;
 import at.gv.egiz.eaaf.core.api.idp.process.ExecutionContext;
 import at.gv.egiz.eaaf.core.exceptions.EaafStorageException;
 import at.gv.egiz.eaaf.core.exceptions.TaskExecutionException;
-import at.gv.egiz.eaaf.core.impl.idp.auth.modules.AbstractAuthServletTask;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
+import at.gv.egiz.eaaf.core.impl.idp.controller.tasks.AbstractLocaleAuthServletTask;
 import lombok.extern.slf4j.Slf4j;
 
-import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.CONTEXT_FLAG_ADVANCED_MATCHING_FAILED;
-import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK;
-
 
 /**
  * Task receives the response of {@link GenerateAustrianResidenceGuiTask} and handles it.
@@ -67,7 +69,7 @@ import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.TRANSIT
  * </ul>
  * Transitions:
  * <ul>
- *   <li>{@link CreateNewErnpEntryTask} if no results from search with residency data in registers</li>
+ *   <li>{@link GenerateOtherLoginMethodGuiTask} if no results from search with residency data in registers</li>
  *   <li>{@link CreateIdentityLinkTask} if one exact match between initial register search (with MDS) and results
  *   from search with residency data in registers exists</li>
  *   <li>{@link GenerateOtherLoginMethodGuiTask} if a user input error has happened</li>
@@ -79,71 +81,77 @@ import static at.asitplus.eidas.specific.modules.auth.eidas.v2.Constants.TRANSIT
  */
 @Slf4j
 @Component("ReceiveAustrianResidenceGuiResponseTask")
-public class ReceiveAustrianResidenceGuiResponseTask extends AbstractAuthServletTask {
+public class ReceiveAustrianResidenceGuiResponseTask extends AbstractLocaleAuthServletTask {
 
-  public static final String PARAM_FORMER_RESIDENCE_AVAILABLE = "formerResidenceAvailable";
-  public static final String PARAM_STREET = "street";
-  public static final String PARAM_CITY = "city";
-  public static final String PARAM_ZIPCODE = "zipcode";
+  private static final String MSG_PROP_20 = "module.eidasauth.matching.20";
+  private static final String MSG_PROP_21 = "module.eidasauth.matching.21";
+  private static final String MSG_PROP_22 = "module.eidasauth.matching.22";
+  
+  public static final String HTTP_PARAM_NO_RESIDENCE = "noResidence";  
   private final RegisterSearchService registerSearchService;
 
   public ReceiveAustrianResidenceGuiResponseTask(RegisterSearchService registerSearchService) {
     this.registerSearchService = registerSearchService;
+    
   }
-
-  @Data
-  @AllArgsConstructor
-  @NoArgsConstructor
-  public static class UserInput {
-    private boolean formerResidenceAvailable;
-    private String zipcode;
-    private String city;
-    private String street;
-  }
-
+  
   @Override
-  public void execute(ExecutionContext executionContext, HttpServletRequest request, HttpServletResponse response)
-      throws TaskExecutionException {
+  protected void executeWithLocale(ExecutionContext executionContext, HttpServletRequest request,
+      HttpServletResponse response) throws TaskExecutionException {
     log.trace("Starting ReceiveAustrianResidenceGuiResponseTask");
 
-    UserInput input = parseHtmlInput(request);
-    if (!input.isFormerResidenceAvailable()) {
-      moveToNextTask(executionContext);
-      return;
-
-    }
-
-    if (input.getStreet().isEmpty() || input.getCity().isEmpty() || input.getZipcode().isEmpty()) {
-      // HTML form should ensure that mandatory fields are set => this should never happen
-      executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED, true);
-      executionContext.put(TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK, true);
-      return;
-
-    }
+    try {    
+      //return to AuswahlScreen if HTTP_PARAM_NO_RESIDENCE was selected
+      final boolean forwardWithOutMandate = parseFlagFromHttpRequest(request, HTTP_PARAM_NO_RESIDENCE, false);
+      if (forwardWithOutMandate) {
+        log.debug("User selects 'no residence' button. Switch back to 'other matching' selection ... ");       
+        executionContext.put(TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK, true);
+      
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED_REASON, MSG_PROP_20);
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED, true);                  
+        return;
+      
+      }
+            
+      //load search parameters from HTML form    
+      AdresssucheOutput input = parseHtmlInput(request);        
+      if (validateHtmlInput(input)) {
+        // HTML form should ensure that mandatory fields are set => this should never happen
+        log.warn("HTML form contains no residence information. Switch back to 'other matching' selection ... ");
+        executionContext.put(TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK, true);
+    
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED_REASON, MSG_PROP_21);
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED, true);
+        return;
 
-    try {
+      }
+    
+      // get pre-processed information
       SimpleEidasData eidasData = MatchingTaskUtils.getInitialEidasData(pendingReq);
       RegisterStatusResults initialSearchResult = MatchingTaskUtils.getIntermediateMatchingResult(pendingReq);
 
+      // search in register
       RegisterStatusResults residencyResult =
-          registerSearchService.searchWithResidence(initialSearchResult.getOperationStatus(),
-              eidasData, input.zipcode, input.city, input.street);
-      if (residencyResult.getResultCount() == 0) {
-        //TODO: her we should add a GUI step of result is zero to inform user an forward process by click
-        moveToNextTask(executionContext);
-
-      } else if (residencyResult.getResultCount() == 1) {
-        compareSearchResultWithInitialData(executionContext, residencyResult, eidasData);
+          registerSearchService.searchWithResidence(initialSearchResult.getOperationStatus(), eidasData, input);
+      
+      // validate matching response from registers
+      if (residencyResult.getResultCount() != 1) {
+        log.info("Find {} match by using residence information. Forward user to 'other matching' selection ... ",
+            residencyResult.getResultCount() == 0 ? "no" : "more-than-one");       
+        executionContext.put(TRANSITION_TO_GENERATE_OTHER_LOGIN_METHOD_GUI_TASK, true);
+        
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED_REASON, MSG_PROP_22);
+        executionContext.put(CONTEXT_FLAG_ADVANCED_MATCHING_FAILED, true);    
 
       } else {
-        /*TODO: align with form generation task and to better error handling in case of more-than-one result.
-         *      Maybe the user has to provide more information.
-         */
-        throw new TaskExecutionException(pendingReq,
-            "Manual Fix necessary", new ManualFixNecessaryException(eidasData));
+        log.debug("Find single match by using residence information. Starting data validation ... ");
+        compareSearchResultWithInitialData(residencyResult, eidasData);
 
       }
 
+    } catch (WorkflowException e) {
+      throw new TaskExecutionException(pendingReq, "Search with residency data failed", e);
+      
     } catch (EaafStorageException e) {
       log.error("Search with residency data failed", e);
       throw new TaskExecutionException(pendingReq, "Search with residency data failed", e);
@@ -151,58 +159,67 @@ public class ReceiveAustrianResidenceGuiResponseTask extends AbstractAuthServlet
     }
   }
 
-  private void compareSearchResultWithInitialData(ExecutionContext executionContext,
-      RegisterStatusResults residencyResult, SimpleEidasData eidasData)
+  private boolean validateHtmlInput(AdresssucheOutput input) {
+    return StringUtils.isEmpty(input.getMunicipality()) 
+        && StringUtils.isEmpty(input.getNumber())
+        && StringUtils.isEmpty(input.getPostleitzahl())
+        && StringUtils.isEmpty(input.getStreet())
+        && StringUtils.isEmpty(input.getVillage());            
+  }
+
+  private void compareSearchResultWithInitialData(RegisterStatusResults residencyResult, SimpleEidasData eidasData)
       throws TaskExecutionException, EaafStorageException {
     try {
-      if (eidasData.equalsRegisterData(residencyResult.getResult())) {
+      if (!eidasData.equalsRegisterData(residencyResult.getResult())) {
         // update register information
-        registerSearchService.step7aKittProcess(residencyResult, eidasData);
+        RegisterStatusResults updateResult = registerSearchService.step7aKittProcess(residencyResult, eidasData);
 
-        // store search result to re-used in CreateIdentityLink step, because there we need bPK and MDS
+        // store updated result to re-used in CreateIdentityLink step, because there we need bPK and MDS
         MatchingTaskUtils.storeFinalMatchingResult(pendingReq,
             MatchedPersonResult.generateFormMatchingResult(
-                residencyResult.getResult(), eidasData.getCitizenCountryCode()));
+                updateResult.getResult(), eidasData.getCitizenCountryCode()));
 
       } else {
-        moveToNextTask(executionContext);
-
+        log.warn("Suspect state FOUND. Matching by residence was neccessary but NO register-update are required!");
+        // no update required. Data can be used as it is.
+        MatchingTaskUtils.storeFinalMatchingResult(pendingReq,
+            MatchedPersonResult.generateFormMatchingResult(
+                residencyResult.getResult(), eidasData.getCitizenCountryCode()));
+        
       }
-
+            
     } catch (WorkflowException e) {
+      log.warn("Kitt operation after successful residence matching FAILED.", e);
       throw new TaskExecutionException(pendingReq, "Search failed", new ManualFixNecessaryException(eidasData));
 
     }
   }
 
-  private void moveToNextTask(ExecutionContext executionContext) {
-    // Later on, this should transition to Step 20
-    executionContext.put(Constants.TRANSITION_TO_CREATE_NEW_ERNP_ENTRY_TASK, true);
-
-  }
-
-  private @NotNull UserInput parseHtmlInput(HttpServletRequest request) {
+  private @NotNull AdresssucheOutput parseHtmlInput(HttpServletRequest request) {
     Enumeration<String> reqParamNames = request.getParameterNames();
-    UserInput result = new UserInput();
+    AdresssucheOutputBuilder resultBuilder = AdresssucheOutput.builder();
     while (reqParamNames.hasMoreElements()) {
       final String paramName = reqParamNames.nextElement();
       String escaped = StringEscapeUtils.escapeHtml(request.getParameter(paramName));
-      if (PARAM_FORMER_RESIDENCE_AVAILABLE.equalsIgnoreCase(paramName)) {
-        result.setFormerResidenceAvailable(Boolean.parseBoolean(escaped));
+      if (AdresssucheController.PARAM_MUNIPICALITY.equalsIgnoreCase(paramName)) {
+        resultBuilder.municipality(escaped);
 
-      } else if (PARAM_STREET.equalsIgnoreCase(paramName)) {
-        result.setStreet(escaped);
+      } else if (AdresssucheController.PARAM_NUMBER.equalsIgnoreCase(paramName)) {
+        resultBuilder.number(escaped);
 
-      } else if (PARAM_CITY.equalsIgnoreCase(paramName)) {
-        result.setCity(escaped);
+      } else if (AdresssucheController.PARAM_POSTLEITZAHL.equalsIgnoreCase(paramName)) {
+        resultBuilder.postleitzahl(escaped);
 
-      } else if (PARAM_ZIPCODE.equalsIgnoreCase(paramName)) {
-        result.setZipcode(escaped);
+      } else if (AdresssucheController.PARAM_STREET.equalsIgnoreCase(paramName)) {
+        resultBuilder.street(escaped);
+
+      } else if (AdresssucheController.PARAM_VILLAGE.equalsIgnoreCase(paramName)) {
+        resultBuilder.village(escaped);
 
       }
     }
-    return result;
-
+    
+    return resultBuilder.build();    
   }
 
 }