1 files changed, 81 insertions, 0 deletions
diff --git a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java
new file mode 100644
index 000000000..e79e41515
--- /dev/null
+++ b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2003 Federal Chancellery Austria
+ * MOA-ID has been developed in a cooperation between BRZ, the Federal
+ * Chancellery Austria - ICT staff unit, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ * http://www.osor.eu/eupl/
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text
+ * file for details on the various modules and licenses.
+ * The "NOTICE" text file is part of the distribution. Any derivative works
+ * that you distribute must include a readable copy of the "NOTICE" text file.
+ */
+
+
+package at.gv.egovernment.moa.id.auth.data;
+
+
+/**
+ * Includes the result of an extended infobox validation.
+ * 
+ * If validation succeeds, an array of
+ * {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute ExtendedSAMLAttributes}
+ * maybe provided. Each of these SAML-Attributes will be either appended to the  
+ * final SAML-Assertion passed to the online application or to the AUTH-Block,
+ * or to both.
+ * <br>
+ * If validation fails the implementing class has to provide a short error message. 
+ * 
+ * @author Harald Bratko
+ */
+public interface InfoboxValidationResult {
+  
+  /**
+   * The method returns <code>true</code> if validation succeeds. In that case
+   * method {@link  #getExtendedSamlAttributes()} may provide an array of 
+   * {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute 
+   * ExtendedSAMLAttributes} that should be appended to the final SAML-Assertion or the 
+   * AUTH-Block or to both.
+   * <br>
+   * The method returns <code>false</code> if validation fails. In that case
+   * method {@link #getErrorMessage()} has to provide a short error description.               
+   * 
+   * @return <code>True</code> if validation succeeds,
+   *         otherwise <code>false</code>.
+   */
+  public boolean isValid();
+  
+  /**
+   * Returns an array of {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute
+   * ExtendedSAMLAttributes} that should be added to the SAML-Assertion
+   * provided to the online application.
+   * The SAML-Attributes in that array will be added to the final
+   * SAML-Assertion, the AUTH-Block, or both, exactly in the order as they are arranged
+   * in the array this method returns. 
+   * 
+   * @return An array of {@link at.gv.egovernment.moa.id.auth.data.ExtendedSAMLAttribute
+   * ExtendedSAMLAttributes} that should be added to the SAML-Assertion
+   * provided to the online application, the AUTH-Block, or both. If no attributes should 
+   * be added this array maybe <code>null</code> or empty.
+   */
+  public ExtendedSAMLAttribute[] getExtendedSamlAttributes();
+  
+  /**
+   * A short error description that should be displayed by MOA-ID if
+   * validation of the InfoBoxReadResponse fails.
+   * 
+   * @return An short error message if validation fails.
+   */
+  public String getErrorMessage();
+
+}