saml/saml2/binding/SAML2Artifact.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/binding/SAML2Artifact.h
  23  *
  24  * Base class for SAML 2.0 artifacts.
  25  */
  26
  27 #ifndef __saml2_artifact_h__
  28 #define __saml2_artifact_h__
  29
  30 #include <saml/binding/SAMLArtifact.h>
  31
  32 namespace opensaml {
  33     namespace saml2p {
  34
  35         /**
  36          * Base class for SAML 2.0 artifacts.
  37          */
  38         class SAML_API SAML2Artifact : public SAMLArtifact
  39         {
  40             SAML2Artifact& operator=(const SAML2Artifact& src);
  41         public:
  42             virtual ~SAML2Artifact();
  43
  44             /**
  45              * Returns the endpoint index of the artifact.
  46              *
  47              * @return endpoint index
  48              */
  49             virtual int getEndpointIndex() const;
  50
  51             /** Length of endpoint index */
  52             static const unsigned int INDEX_LENGTH;
  53
  54         protected:
  55             SAML2Artifact();
  56
  57             /**
  58              * Constructor.
  59              *
  60              * @param s raw artifact string
  61              */
  62             SAML2Artifact(const char* s);
  63
  64             /**
  65              * Copy constructor.
  66              *
  67              * @param src   object to copy
  68              */
  69             SAML2Artifact(const SAML2Artifact& src);
  70         };
  71
  72     };
  73 };
  74
  75 #endif /* __saml2_artifact_h__ */