saml/saml1/binding/SAMLArtifactType0001.h

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file saml/saml1/binding/SAMLArtifactType0001.h
  19  *
  20  * Type 0x0001 SAML 1.x artifact class.
  21  */
  22
  23 #ifndef __saml_artifacttype0001_h__
  24 #define __saml_artifacttype0001_h__
  25
  26 #include <saml/binding/SAMLArtifact.h>
  27
  28 namespace opensaml {
  29     namespace saml1p {
  30
  31         /**
  32          * Type 0x0001 SAML 1.x artifact class
  33          */
  34         class SAML_API SAMLArtifactType0001 : public SAMLArtifact
  35         {
  36             SAMLArtifactType0001& operator=(const SAMLArtifactType0001& src);
  37         public:
  38             /**
  39              * Decodes a base64-encoded type 0x0001 artifact
  40              *
  41              * @param s NULL-terminated base64-encoded string
  42              */
  43             SAMLArtifactType0001(const char* s);
  44
  45             /**
  46              * Constructs an artifact with the specified source ID, but a random assertion handle.
  47              *
  48              * @param sourceid SOURCEID_LENGTH bytes of binary data
  49              */
  50             SAMLArtifactType0001(const std::string& sourceid);
  51
  52             /**
  53              * Constructs an artifact with the specified source ID and assertion handle.
  54              *
  55              * @param sourceid  SOURCEID_LENGTH bytes of binary data
  56              * @param handle    HANDLE_LENGTH bytes of binary data
  57              */
  58             SAMLArtifactType0001(const std::string& sourceid, const std::string& handle);
  59
  60             virtual ~SAMLArtifactType0001();
  61
  62             // Virtual function overrides.
  63             SAMLArtifactType0001* clone() const;
  64             std::string getSource() const;
  65             std::string getMessageHandle() const;
  66
  67             /**
  68              * Returns the binary data that identifies the source.
  69              * The result MAY contain embedded null characters.
  70              *
  71              * @return the binary source ID
  72              */
  73             virtual std::string getSourceID() const;
  74
  75             /** Length of source ID */
  76             static const unsigned int SOURCEID_LENGTH;
  77
  78             /** Length of assertion handle */
  79             static const unsigned int HANDLE_LENGTH;
  80
  81         protected:
  82             /**
  83              * Copy constructor.
  84              *
  85              * @param src   object to copy
  86              */
  87             SAMLArtifactType0001(const SAMLArtifactType0001& src);
  88         };
  89
  90     };
  91 };
  92
  93 #endif /* __saml_artifacttype0001_h__ */