1 files changed, 73 insertions, 0 deletions
diff --git a/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttribute.java b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttribute.java
new file mode 100644
index 000000000..795079227
--- /dev/null
+++ b/id.server/src/at/gv/egovernment/moa/id/auth/data/ExtendedSAMLAttribute.java
@@ -0,0 +1,73 @@
+package at.gv.egovernment.moa.id.auth.data;
+
+/**
+ * A SAML-Attribute to be appended to the final SAML-Assertion 
+ * that will be passed to the online application. 
+ */
+public interface ExtendedSAMLAttribute {
+  /**
+   * Add this attribute only to the SAML-Assertion
+   * passed to the online application, but not to 
+   * the AUTH-Block.
+   */
+  public final static int NOT_ADD_TO_AUTHBLOCK = 0;
+  /**
+   * Add this attribute to both, the AUTH-Block and the
+   * final SAML-Assertion passed to the online application.
+   */
+  public final static int ADD_TO_AUTHBLOCK = 1;
+  /**
+   * Add this attribute to only the AUTH-Block, but not
+   * to the final SAML-Assertion passed to the online application.
+   */
+  public final static int ADD_TO_AUTHBLOCK_ONLY = 2;
+  
+  /**
+   * The value of the SAML-Attribute. This must be either a
+   * <code>org.w3c.Element</code> or a <code>java.lang.String</code> 
+   * object. Each other type will be ignored. <br>
+   * If, for example, the type of the actual SAML-Attribute is a
+   * <code>&lt;xsd:boolean&gt;</code> the value must be either the String
+   * <code>&quot;true&quot;</code> or <code>&quot;false&quot;</code>. 
+   * Or the <code>&lt;xsd:integer&gt;</code> number <code>273</code> 
+   * has to be the String <code>&quot;273&quot;</code>.
+   *   
+   * @return The value of the SAML-Attribute. Must not be <code>null</code>.
+   */
+  public Object getValue();
+  
+  /**
+   * The name of the SAML-Attribute.
+   * 
+   * @return The name of the SAML-Attribute. Must not be <code>null</code>. 
+   */
+  public String getName();
+  
+  /**
+   * The namespace of the SAML-Attribute. 
+   * An application will use the context specific namespace URI for the attribute it returns. 
+   * However, if the application cannot explicitely assign a namespace URI, the 
+   * {@link at.gv.egovernment.moa.util.Constants#MOA_NS_URI default} MOA namespace URI
+   * should be used.
+   * 
+   * @return The namespace of the SAML-Attribute. Must not be <code>null</code>.
+   */
+  public String getNameSpace(); 
+  
+  /**
+   * Specifies if this SAML-Attribute should be added to the AUTH-Block.
+   * <br>
+   * Depending on the returned value, this SAML-Attribute should be only added to the
+   * final SAML-Assertion passed to the online application (0), to both, the final 
+   * assertion and the AUTH-Block (1) or to the AUTH-Block only (2).
+   * 
+   * @return <ul>
+   *         <li>0 - add this SAML-Attribute to the final SAML-Assertion only</li>
+   *         <li>1 - add this SAML-Attribute to both, the final SAML-Assertion and the
+   *             AUTH-Block</li>
+   *         <li>2 - add this SAML-Attribute to the AUTH-Block only
+   *         </ul>        
+   */
+  public int getAddToAUTHBlock();
+
+}