saml/RootObject.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/RootObject.h
  19  *
  20  * Base class for SAML objects at the root of core schemas
  21  */
  22
  23 #ifndef __saml_root_h__
  24 #define __saml_root_h__
  25
  26 #include <saml/signature/SignableObject.h>
  27
  28 namespace xmltooling {
  29     class XMLTOOL_API DateTime;
  30 };
  31
  32 namespace opensaml {
  33
  34     /**
  35      * Base class for SAML objects at the root of core schemas.
  36      * Root objects are signable, and have message identifiers and timestamps.
  37      */
  38     class SAML_API RootObject : public SignableObject
  39     {
  40     public:
  41         virtual ~RootObject() {}
  42
  43         /**
  44          * Returns the unique SAML ID of the object.
  45          *
  46          * @return the unique SAML ID
  47          */
  48         virtual const XMLCh* getID() const=0;
  49
  50         /**
  51          * Returns the timestamp of the object
  52          *
  53          * @return the timestamp
  54          */
  55         virtual const xmltooling::DateTime* getIssueInstant() const=0;
  56
  57         /**
  58          * Returns the timestamp of the object as an epoch
  59          *
  60          * @return the timestamp
  61          */
  62         virtual time_t getIssueInstantEpoch() const=0;
  63
  64     protected:
  65         RootObject() {}
  66     };
  67
  68 };
  69
  70 #endif /* __saml_root_h__ */