saml/saml2/binding/SAML2Artifact.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file saml/saml2/core/SAML2Artifact.h\r
  19  * \r
  20  * Base class for SAML 2.0 artifacts\r
  21  */\r
  22 \r
  23 #ifndef __saml2_artifact_h__\r
  24 #define __saml2_artifact_h__\r
  25 \r
  26 #include <saml/binding/SAMLArtifact.h>\r
  27 \r
  28 namespace opensaml {\r
  29     namespace saml2p {\r
  30         \r
  31         /**\r
  32          * Base class for SAML 2.0 artifacts\r
  33          */\r
  34         class SAML_API SAML2Artifact : public SAMLArtifact\r
  35         {\r
  36             SAML2Artifact& operator=(const SAML2Artifact& src);\r
  37         public:\r
  38             virtual ~SAML2Artifact() {}\r
  39             \r
  40             /**\r
  41              * Returns the endpoint index of the artifact.\r
  42              * \r
  43              * @return endpoint index\r
  44              */\r
  45             virtual int getEndpointIndex() const;\r
  46             \r
  47             /** Length of endpoint index */            \r
  48             static const unsigned int INDEX_LENGTH;\r
  49 \r
  50         protected:\r
  51             SAML2Artifact() {}\r
  52 \r
  53             SAML2Artifact(const char* s) : SAMLArtifact(s) {}\r
  54     \r
  55             SAML2Artifact(const SAML2Artifact& src) : SAMLArtifact(src) {}\r
  56         };\r
  57         \r
  58     };\r
  59 };\r
  60 \r
  61 #endif /* __saml2_artifact_h__ */\r