[jboss-identity-commits] JBoss Identity SVN: r247 - in identity-federation/trunk: identity-bindings/src/main/java/org/jboss/identity/federation/bindings/jboss/subject and 2 other directories.

[jboss-identity-commits at lists.jboss.org]

Author: anil.saldhana at jboss.com
Date: 2009-01-23 00:37:06 -0500 (Fri, 23 Jan 2009)
New Revision: 247

Modified:
   identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/interfaces/TrustKeyManager.java
   identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/jboss/subject/JBossIdentityGroup.java
   identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/saml/v2/request/SAML2Request.java
   identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/DeflateUtil.java
   identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/XMLSignatureUtil.java
Log:
javadoc 

Modified: identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/interfaces/TrustKeyManager.java
===================================================================
--- identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/interfaces/TrustKeyManager.java	2009-01-23 04:45:10 UTC (rev 246)
+++ identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/interfaces/TrustKeyManager.java	2009-01-23 05:37:06 UTC (rev 247)
@@ -29,13 +29,41 @@
 import org.jboss.identity.federation.bindings.config.KeyValue;
 
 /**
+ * Key Manager interface used in trust decisions
  * @author Anil.Saldhana at redhat.com
  * @since Jan 22, 2009
  */
 public interface TrustKeyManager
 {
+   /**
+    * Provide a set of properties used for authentication
+    * into the storage of keys - keystore, ldap, db, HSM etc
+    * @param authList
+    * @throws Exception
+    */
    void setAuthProperties(List<AuthProperty> authList) throws Exception;
+   
+   /**
+    * Set a list of (domain,alias) tuple to trust domains
+    * The alias is a string that represents the validating key stored
+    * for a domain
+    * @param aliases
+    * @throws Exception
+    */
    void setValidatingAlias(List<KeyValue> aliases) throws Exception;
+   
+   /**
+    * Get the Signing Key
+    * @return
+    * @throws Exception
+    */
    PrivateKey getSigningKey() throws Exception;
+   
+   /**
+    * Get the Validating Public Key of the domain
+    * @param domain
+    * @return
+    * @throws Exception
+    */
    PublicKey getValidatingKey(String domain) throws Exception;
 }
\ No newline at end of file

Modified: identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/jboss/subject/JBossIdentityGroup.java
===================================================================
--- identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/jboss/subject/JBossIdentityGroup.java	2009-01-23 04:45:10 UTC (rev 246)
+++ identity-federation/trunk/identity-bindings/src/main/java/org/jboss/identity/federation/bindings/jboss/subject/JBossIdentityGroup.java	2009-01-23 05:37:06 UTC (rev 247)
@@ -29,6 +29,7 @@
 import java.util.Set;
 
 /**
+ * A Principal Group used to register roles in JBoss
  * @author Anil.Saldhana at redhat.com
  * @since Jan 16, 2009
  */

Modified: identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/saml/v2/request/SAML2Request.java
===================================================================
--- identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/saml/v2/request/SAML2Request.java	2009-01-23 04:45:10 UTC (rev 246)
+++ identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/saml/v2/request/SAML2Request.java	2009-01-23 05:37:06 UTC (rev 247)
@@ -79,6 +79,13 @@
    } 
    
    
+   /**
+    * Get a Request Type from Input Stream
+    * @param is
+    * @return
+    * @throws Exception
+    * @throws IllegalArgumentException inputstream is null
+    */
    @SuppressWarnings("unchecked")
    public RequestAbstractType getRequestType(InputStream is) throws Exception
    {

Modified: identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/DeflateUtil.java
===================================================================
--- identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/DeflateUtil.java	2009-01-23 04:45:10 UTC (rev 246)
+++ identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/DeflateUtil.java	2009-01-23 05:37:06 UTC (rev 247)
@@ -31,8 +31,7 @@
 import java.util.zip.InflaterInputStream;
 
 /**
- * Encoder of saml messages based on the DEFLATE
- * compression
+ * Encoder of saml messages based on DEFLATE compression
  * @author Anil.Saldhana at redhat.com
  * @since Dec 11, 2008
  */

Modified: identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/XMLSignatureUtil.java
===================================================================
--- identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/XMLSignatureUtil.java	2009-01-23 04:45:10 UTC (rev 246)
+++ identity-federation/trunk/identity-fed-api/src/main/java/org/jboss/identity/federation/api/util/XMLSignatureUtil.java	2009-01-23 05:37:06 UTC (rev 247)
@@ -55,6 +55,7 @@
 import org.jboss.identity.federation.api.saml.v2.request.SAML2Request;
 import org.jboss.identity.federation.core.saml.v2.factories.JBossSAMLBaseFactory;
 import org.jboss.identity.federation.saml.v2.protocol.AuthnRequestType;
+import org.jboss.identity.federation.saml.v2.protocol.RequestAbstractType;
 import org.jboss.identity.xmlsec.w3.xmldsig.ObjectFactory;
 import org.jboss.identity.xmlsec.w3.xmldsig.SignatureType;
 import org.w3c.dom.Document;
@@ -149,7 +150,7 @@
    }
    
    /**
-    * Sign an AuthnRequestType
+    * Sign an RequestType
     * @param request
     * @param keypair Key Pair 
     * @param digestMethod (Example: DigestMethod.SHA1)
@@ -157,7 +158,7 @@
     * @return
     * @throws Exception
     */
-   public static Document sign(AuthnRequestType request, KeyPair keypair,
+   public static Document sign(RequestAbstractType request, KeyPair keypair,
          String digestMethod, String signatureMethod) throws Exception
    {
       DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();