Implement metadata lookup by artifact, refactored metadata indexing.

[shibboleth/cpp-opensaml.git] / saml / SAMLArtifact.h

diff --git a/saml/SAMLArtifact.h b/saml/SAMLArtifact.h
index 5281205..18ebcaf 100644 (file)
--- a/saml/SAMLArtifact.h
+++ b/saml/SAMLArtifact.h
@@ -63,7 +63,7 @@ namespace opensaml {
 \r
         /**\r
          * Returns the binary type code of the artifact.\r
-         * The result is NOT null-terminated.\r
+         * The result MAY contain embedded null characters.\r
          * \r
          * @return the binary type code\r
          */\r
@@ -73,7 +73,7 @@ namespace opensaml {
         \r
         /**\r
          * Returns the binary artifact data following the type code.\r
-         * The result is NOT null-terminated.\r
+         * The result MAY contain embedded null characters.\r
          * \r
          * @return the binary artifact data\r
          */\r
@@ -82,18 +82,18 @@ namespace opensaml {
         }\r
         \r
         /**\r
-         * Returns the binary data that identifies the source of the artifact.\r
-         * The exact form this takes depends on the type.\r
-         * The result is NOT null-terminated.\r
+         * Returns a string that identifies the source of the artifact.\r
+         * The exact form this takes depends on the type but should match\r
+         * the syntax needed for metadata lookup.\r
          * \r
-         * @return the binary source data\r
+         * @return null-terminated source string\r
          */\r
         virtual std::string getSource() const=0;\r
         \r
         /**\r
          * Returns the binary data that references the message (2.0) or assertion (1.x)\r
          * The exact form this takes depends on the type.\r
-         * The result is NOT null-terminated.\r
+         * The result MAY contain embedded null characters.\r
          * \r
          * @return the binary reference data\r
          */\r