[java-opensaml COMMIT] in /trunk/opensaml-saml-api/src/main/java/org/opensaml/saml: common/binding/artifact/AbstractS...

[noreply at shibboleth.net]

Author: putmanb
Date: Wed Sep 28 17:35:47 2016
New Revision: 4502

URL: http://svn.shibboleth.net/view/java-opensaml?rev=4502&view=rev
Log:
Extract formal interfaces for SAML artifacts.

This seems desirable to support work on metadata resolution based on artifacts.  Otherwise we
have components formally taking instances of Abstract- things in their interfaces, and this
seems questionable.

Added:
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/SAMLArtifact.java   (with props)
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/SAML1Artifact.java   (with props)
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/SAML2Artifact.java   (with props)
Modified:
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/AbstractSAMLArtifact.java
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/AbstractSAML1Artifact.java
    trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/AbstractSAML2Artifact.java

Modified: trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/AbstractSAMLArtifact.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/AbstractSAMLArtifact.java?rev=4502&r1=4501&r2=4502&view=diff
==============================================================================
--- trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/AbstractSAMLArtifact.java	(original)
+++ trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/common/binding/artifact/AbstractSAMLArtifact.java	Wed Sep 28 17:35:47 2016
@@ -30,7 +30,7 @@
 /**
  * Base class for SAML artifacts.
  */
-public abstract class AbstractSAMLArtifact {
+public abstract class AbstractSAMLArtifact implements SAMLArtifact {
 
     /** 2 byte artifact type code. */
     private byte[] typeCode;
@@ -49,11 +49,7 @@
         typeCode = code;
     }
 
-    /**
-     * Gets the bytes for the artifact.
-     * 
-     * @return the bytes for the artifact
-     */
+    /** {@inheritDoc} */
     @Nonnull public byte[] getArtifactBytes() {
         final byte[] remainingArtifact = getRemainingArtifact();
         final byte[] artifact = new byte[2 + remainingArtifact.length];
@@ -64,11 +60,7 @@
         return artifact;
     }
 
-    /**
-     * Gets the 2 byte type code for this artifact.
-     * 
-     * @return the type code for this artifact
-     */
+    /** {@inheritDoc} */
     @Nonnull public byte[] getTypeCode() {
         return typeCode;
     }
@@ -81,7 +73,7 @@
     protected void setTypeCode(@Nonnull final byte[] newTypeCode) {
         typeCode = Constraint.isNotNull(newTypeCode, "Type code cannot be null");
     }
-
+ 
     /**
      * Gets the artifact bytes minus the type code.
      * 

Modified: trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/AbstractSAML1Artifact.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/AbstractSAML1Artifact.java?rev=4502&r1=4501&r2=4502&view=diff
==============================================================================
--- trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/AbstractSAML1Artifact.java	(original)
+++ trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml1/binding/artifact/AbstractSAML1Artifact.java	Wed Sep 28 17:35:47 2016
@@ -22,7 +22,7 @@
 /**
  * SAML 1 Artifact marker.
  */
-public abstract class AbstractSAML1Artifact extends AbstractSAMLArtifact {
+public abstract class AbstractSAML1Artifact extends AbstractSAMLArtifact implements SAML1Artifact {
 
     /**
      * Constructor.

Modified: trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/AbstractSAML2Artifact.java
URL: http://svn.shibboleth.net/view/java-opensaml/trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/AbstractSAML2Artifact.java?rev=4502&r1=4501&r2=4502&view=diff
==============================================================================
--- trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/AbstractSAML2Artifact.java	(original)
+++ trunk/opensaml-saml-api/src/main/java/org/opensaml/saml/saml2/binding/artifact/AbstractSAML2Artifact.java	Wed Sep 28 17:35:47 2016
@@ -17,13 +17,15 @@
 
 package org.opensaml.saml.saml2.binding.artifact;
 
+import javax.annotation.Nonnull;
+
 import org.opensaml.saml.common.binding.artifact.AbstractSAMLArtifact;
 
 /**
  * SAML 2 Artifact base class. SAML 2 artifacts contains a 2 byte type code followed by a 2 byte endpoint index followed
  * by remaining artifact data.
  */
-public abstract class AbstractSAML2Artifact extends AbstractSAMLArtifact {
+public abstract class AbstractSAML2Artifact extends AbstractSAMLArtifact implements SAML2Artifact {
 
     /** 2 byte artifact endpoint index. */
     private byte[] endpointIndex;
@@ -67,12 +69,8 @@
         return artifact;
     }
 

[... 12 lines stripped ...]