saml/RootObject.h

   1 /*
   2  *  Copyright 2001-2006 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 #include <xmltooling/util/DateTime.h>
  28
  29 namespace opensaml {
  30
  31     /**
  32      * Base class for SAML objects at the root of core schemas.
  33      * Root objects are signable, and have message identifiers and timestamps.
  34      */
  35     class SAML_API RootObject : public virtual SignableObject
  36     {
  37     public:
  38         virtual ~RootObject() {}
  39
  40         /**
  41          * Indicates whether the object is an assertion.
  42          *
  43          * @return true iff the object is an assertion
  44          */
  45         virtual bool isAssertion() const {
  46             return false;
  47         }
  48
  49         /**
  50          * Returns the unique SAML ID of the object.
  51          *
  52          * @return the unique SAML ID
  53          */
  54         virtual const XMLCh* getID() const=0;
  55
  56         /**
  57          * Returns the timestamp of the object
  58          *
  59          * @return the timestamp
  60          */
  61         virtual const xmltooling::DateTime* getIssueInstant() const=0;
  62
  63         /**
  64          * Returns the timestamp of the object as an epoch
  65          *
  66          * @return the timestamp
  67          */
  68         virtual time_t getIssueInstantEpoch() const=0;
  69
  70     protected:
  71         RootObject() {}
  72     };
  73
  74 };
  75
  76 #endif /* __saml_root_h__ */