saml/saml2/binding/SAML2Artifact.h

   1 /*
   2  *  Copyright 2001-2007 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/saml2/binding/SAML2Artifact.h
  19  *
  20  * Base class for SAML 2.0 artifacts.
  21  */
  22
  23 #ifndef __saml2_artifact_h__
  24 #define __saml2_artifact_h__
  25
  26 #include <saml/binding/SAMLArtifact.h>
  27
  28 namespace opensaml {
  29     namespace saml2p {
  30
  31         /**
  32          * Base class for SAML 2.0 artifacts.
  33          */
  34         class SAML_API SAML2Artifact : public SAMLArtifact
  35         {
  36             SAML2Artifact& operator=(const SAML2Artifact& src);
  37         public:
  38             virtual ~SAML2Artifact();
  39
  40             /**
  41              * Returns the endpoint index of the artifact.
  42              *
  43              * @return endpoint index
  44              */
  45             virtual int getEndpointIndex() const;
  46
  47             /** Length of endpoint index */
  48             static const unsigned int INDEX_LENGTH;
  49
  50         protected:
  51             SAML2Artifact();
  52
  53             /**
  54              * Constructor.
  55              *
  56              * @param s raw artifact string
  57              */
  58             SAML2Artifact(const char* s);
  59
  60             /**
  61              * Copy constructor.
  62              *
  63              * @param src   object to copy
  64              */
  65             SAML2Artifact(const SAML2Artifact& src);
  66         };
  67
  68     };
  69 };
  70
  71 #endif /* __saml2_artifact_h__ */