diff options
| author | Christian Kollmann <christian.kollmann@a-sit.at> | 2021-07-12 10:23:29 +0200 |
|---|---|---|
| committer | Christian Kollmann <christian.kollmann@a-sit.at> | 2021-07-12 10:23:29 +0200 |
| commit | 38d2a59abe9f0bd04abd2caf4ea110afd3f5ff11 (patch) | |
| tree | 501b22cb2abdeb3ee7eb2a35051b1003647f4f99 /eidas_modules | |
| parent | 311185cadc5f6abed886830688c7e928be9d5577 (diff) | |
| download | National_eIDAS_Gateway-38d2a59abe9f0bd04abd2caf4ea110afd3f5ff11.tar.gz National_eIDAS_Gateway-38d2a59abe9f0bd04abd2caf4ea110afd3f5ff11.tar.bz2 National_eIDAS_Gateway-38d2a59abe9f0bd04abd2caf4ea110afd3f5ff11.zip | |
Add documentation to task implementations
Diffstat (limited to 'eidas_modules')
2 files changed, 37 insertions, 1 deletions
diff --git a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/GenerateAuthnRequestTask.java b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/GenerateAuthnRequestTask.java index 575b2334..33d3f175 100644 --- a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/GenerateAuthnRequestTask.java +++ b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/GenerateAuthnRequestTask.java @@ -61,10 +61,26 @@ import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.UUID; + /** - * Authentication-process task that generates the Authn. Request to eIDAS Node. + * Generates the authn request to the eIDAS Node. This is the first task in the process. + * <p> + * Input: + * <ul> + * <li>none</li> + * </ul> + * Output: + * <ul> + * <li>none</li> + * </ul> + * Transitions: + * <ul> + * <li>{@link at.asitplus.eidas.specific.modules.auth.eidas.v2.tasks.ReceiveAuthnResponseTask} + * to read the response from the eIDAS Node</li> + * </ul> * * @author tlenz + * @author ckollmann */ @Slf4j @Component("GenerateAuthnRequestTask") diff --git a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAuthnResponseTask.java b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAuthnResponseTask.java index 6d011d3d..dcc1b7d5 100644 --- a/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAuthnResponseTask.java +++ b/eidas_modules/authmodule-eIDAS-v2/src/main/java/at/asitplus/eidas/specific/modules/auth/eidas/v2/tasks/ReceiveAuthnResponseTask.java @@ -45,6 +45,26 @@ import org.springframework.stereotype.Component; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; + +/** + * Receives the authn response from the eIDAS Node, containing the (initial) eIDAS authentication. + * <p> + * Input: + * <ul> + * <li>none</li> + * </ul> + * Output: + * <ul> + * <li>{@link Constants#DATA_FULL_EIDAS_RESPONSE} the full response details</li> + * </ul> + * Transitions: + * <ul> + * <li>{@link InitialSearchTask} to perform search in registers</li> + * </ul> + * + * @author tlenz + * @author ckollmann + */ @Slf4j @Component("ReceiveAuthnResponseTask") public class ReceiveAuthnResponseTask extends AbstractAuthServletTask { |