1 files changed, 96 insertions, 0 deletions
diff --git a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/validator/InfoboxValidator.java b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/validator/InfoboxValidator.java
new file mode 100644
index 000000000..e6b05d852
--- /dev/null
+++ b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/validator/InfoboxValidator.java
@@ -0,0 +1,96 @@
+/*
+* Copyright 2003 Federal Chancellery Austria
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package at.gv.egovernment.moa.id.auth.validator;
+
+import java.util.Map;
+
+import org.w3c.dom.Element;
+
+import at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult;
+import at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams;
+
+/**
+ * Validates an InfoboxReadResponse.
+ * An implementing class has to validate the content of the InfoboxReadResponse  
+ * according to the type specific rules and guidelines of the underlying 
+ * application.
+ */
+public interface InfoboxValidator {
+  
+  /**
+   * This method validates an InfoboxReadResponse.
+   * The method validates the content of the passed <code>infoboxReadResponse</code>
+   * according to the type specific rules and guidelines of the underlying
+   * application.
+   *
+   * @param params {@link at.gv.egovernment.moa.id.auth.data.InfoboxValidatorParams
+   *                Parameters} needed by the validator.
+   * 
+   * @return InfoboxValidationResult structure (@link at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult}
+   *                            
+   * @throws ValidateException  If an error occurs on validating the 
+   *                            InfoboxReadResponse.
+   */
+  public InfoboxValidationResult validate (InfoboxValidatorParams params)
+    throws ValidateException;
+
+  /**
+   * This method is used to do intermediate processing before signing the auth block.
+   * If a infobox validator threw a form to gather user input, this method is used
+   * to validate this input. In no further input is needed the form must be empty to 
+   * proceed, and also a valid <code>InfoboxValidationResult</code> is necessary.
+   * If more input is needed, the validator can build a new form and it is then shown 
+   * to the citizen. 
+   * The implementation of <code>InfoboxValidator</code> must hold its necessary 
+   * data and configuration internally, if this method is called - the class is 
+   * reused at this call
+   *
+   * @param parameters the parameters got returned by the input fields
+   * 
+   * @return InfoboxValidationResult structure (@link at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult}
+   *                            
+   * @throws ValidateException  If an error occurs on validating the 
+   *                            InfoboxReadResponse.
+   */
+  public InfoboxValidationResult validate (Map parameters)
+    throws ValidateException;
+
+  /**
+   * This method is used to do post processing after signing the auth block.
+   * The method validates the content of the <code>infoboxReadResponse</code 
+   * against the passed <code>samlAssertion</code> if needed.
+   * The implementation of <code>InfoboxValidator</code> must hold its necessary 
+   * data and configuration internally, if this method is called - the class is 
+   * reused at this call
+   *
+   * @param samlAssertion the SAML assertion needed by the validator
+   * 
+   * @return InfoboxValidationResult structure (@link at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult}
+   *                            
+   * @throws ValidateException  If an error occurs on validating the 
+   *                            InfoboxReadResponse.
+   */
+  public InfoboxValidationResult validate (Element samlAssertion)
+    throws ValidateException;
+  
+  /**
+   * form for user interaction for intermediate processing of infobox validation
+   * 
+   * @return answer form of the servlet request.
+   */
+  public String getForm();
+  
+}