Removed PersonData return value.

git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@893 d688527b-c9ab-4aba-bd8d-4036d912da1d

3 files changed, 27 insertions, 66 deletions

diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java
index 0ee2f21d5..b8dd7f18e 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationResult.java
@@ -1,6 +1,5 @@
 package at.gv.egovernment.moa.id.auth.data;
 
-import org.w3c.dom.Element;
 
 /**
  * Includes the result of an extended infobox validation.
@@ -12,10 +11,6 @@ import org.w3c.dom.Element;
  * or to both.
  * <br>
  * If validation fails the implementing class has to provide a short error message. 
- * <br>
- * If the corresponding infobox validator runs in the so called <code>compatibility mode</code>
- * a <code>pr:Persondata</code> element to be used in the final <code>saml:Assertion</code>
- * ({@see #getPersonData()})
  * 
  * @author Harald Bratko
  */
@@ -58,19 +53,5 @@ public interface InfoboxValidationResult {
    * @return An short error message if validation fails.
    */
   public String getErrorMessage();
-  
-  /**
-   * Returns a <code>&lt;pr:PersonData&gt;</code> element to be used in the final 
-   * <code>&lt;saml:Assertion&gt;</code>.
-   * <br>
-   * If the corresponding infobox validator runs in the so called <code>compatibility mode</code>
-   * the method must return a <code>&lt;pr:PersonData&gt;</code> element to be used within
-   * the final <code>&lt;saml:Assertion&gt;</code> sent to the online application instead of
-   * the original <code>&lt;pr:PersonData&gt;</code> element derived from the <code>&lt;Identitylink&gt;</code>.
-   * 
-   * @return A <code>&lt;pr:PersonData&gt;</code> element if the corresponding infobox validator 
-   * runs in the <code>compatibility mode</code>, otherwise <code>null</code>.
-   */
-  public Element getPersonData();
 
 }
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationresultImpl.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationresultImpl.java
index 24eb01e95..ad2e0134f 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationresultImpl.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidationresultImpl.java
@@ -1,6 +1,5 @@
 package at.gv.egovernment.moa.id.auth.data;
 
-import org.w3c.dom.Element;
 
 /**
  * Default implementation of the {@link InfoboxValidationresult} interface.
@@ -24,35 +23,26 @@ public class InfoboxValidationresultImpl implements InfoboxValidationResult {
    */
   protected ExtendedSAMLAttribute[] extendedSamlAttributes_; 
   
-  /**
-   * The <code>&lt;pr:PersonData&gt;</code> element to be used in the final 
-   * <code>&lt;saml:Assertion&gt;</code>, if the validator runs in the
-   * <code>compatibility mode</code>.
-   */
-  protected Element personData_;
   
   /**
    * Constructor.
    * 
-   * @param valid
-   * @param extendedSamlAttributes
-   * @param errorMessage
-   * @param personData
+   * @param valid                   Global validation result.
+   * @param extendedSamlAttributes  SAML attributes that should be appended to the final
+   *                                <code>SAML Assertion</code> or to the <code>AUTH Block</code>
+   *                                or to both.
+   * @param errorMessage            An error message if infobox validation fails.
    */
   public InfoboxValidationresultImpl(
     boolean valid, 
     ExtendedSAMLAttribute[] extendedSamlAttributes,
-    String errorMessage,
-    Element personData)
+    String errorMessage)
   {
     valid_ = valid;
     extendedSamlAttributes_ = extendedSamlAttributes;
     errorMessage_ = errorMessage;
-    personData_ = personData;
   }
 
-    
-   
 
   /**
    * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult#getErrorMessage()
@@ -69,13 +59,6 @@ public class InfoboxValidationresultImpl implements InfoboxValidationResult {
   }
 
   /**
-   * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult#getPersonData()
-   */
-  public Element getPersonData() {
-    return personData_;
-  }
-
-  /**
    * @see at.gv.egovernment.moa.id.auth.data.InfoboxValidationResult#isValid()
    */
   public boolean isValid() {
@@ -83,37 +66,28 @@ public class InfoboxValidationresultImpl implements InfoboxValidationResult {
   }
 
   /**
-   * Sets the errorMessage.
+   * Sets the error message if validation fails..
    *
-   * @param errorMessage The errorMessage to set.
+   * @param errorMessage The error message to set.
    */
   public void setErrorMessage(String errorMessage) {
     errorMessage_ = errorMessage;
   }
 
   /**
-   * Sets the extendedSamlAttributes.
+   * Sets the SAML attributes returned by the infobox validatior..
    *
-   * @param extendedSamlAttributes The extendedSamlAttributes to set.
+   * @param extendedSamlAttributes The SAML attributes returned by the infobox validator.
    */
   public void setExtendedSamlAttributes(ExtendedSAMLAttribute[] extendedSamlAttributes) {
     extendedSamlAttributes_ = extendedSamlAttributes;
   }
 
   /**
-   * Sets the <code>&lt;pr:PersonData&gt;</code> element.
-   *
-   * @param personData <code>&lt;pr:PersonData&gt;</code> to set.
-   */
-  public void setPersonData(Element personData) {
-    personData_ = personData;
-  }
-
-  /**
-   * Specify whether the result is valid or not.
+   * Sets validation result..
    *
-   * @param valid <code>True</code> if the infobox could be validated successfully,
-   * otherwise <code>false</code>.
+   * @param valid   <code>True</code> if the infobox could be validated successfully,
+   *                otherwise <code>false</code>.
    */
   public void setValid(boolean valid) {
     valid_ = valid;
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParams.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParams.java
index 71d675259..0f78760a8 100644
--- a/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParams.java
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/InfoboxValidatorParams.java
@@ -157,17 +157,23 @@ public interface InfoboxValidatorParams {
   public boolean getHideStammzahl();
   
   /**
-   * Indicates if the infobox validator has to run in the so called <code>compatibility mode</code>.
+   * Indicates if the infobox validator has to run in the so called 
+   * <code>compatibility mode</code>.
    * <br>
    * The <code>compatibility mode</code> is used when the final <code>&lt;saml:Assertion&gt;</code> 
-   * sent to the online application should be rather built on the basis of a <code>&lt;pr:PersonData&gt;</code>
-   * structure returned by the infobox validator instead of the original identity link.
-   * This mode is mainly used within the <code>Mandates</code> context 
-   * (please refer MOA-ID specification for more details). 
+   * sent to the online application should be rather built on the basis of a 
+   * <code>&lt;pr:PersonData&gt;</code> structure returned by the infobox validator instead 
+   * of the <code>&lt;pr:PersonData&gt;</code> structure extracted from the original identity link.
+   * The <code>compatibility mode</code> is <b>only</b> available within the 
+   * <code>Mandates</code>-infobox context. For all other infoboxes the return value of
+   * this method will be ignored.
+   * (please refer MOA-ID specification for more details).
+   * <p> 
+   * <b>Note:</b> In the current version the <code>compatibility mode</code> is not yet
+   *              supported!
    * 
-   * @return <code>True</code> the infobox validator has to run in the so called 
-   * <code>compatibility mode</code>, otherwise <code>false</code>. The default value
-   * <i>should</i> be </code>false</code>.
+   * @return <code>True</code> if the infobox validator has to run in the so called 
+   * <code>compatibility mode</code>, otherwise <code>false</code>.
    */
   public boolean getCompMode();