saml/RootObject.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/RootObject.h
  23  *
  24  * Base class for SAML objects at the root of core schemas.
  25  */
  26
  27 #ifndef __saml_root_h__
  28 #define __saml_root_h__
  29
  30 #include <saml/signature/SignableObject.h>
  31
  32 namespace xmltooling {
  33     class XMLTOOL_API DateTime;
  34 };
  35
  36 namespace opensaml {
  37
  38     /**
  39      * Base class for SAML objects at the root of core schemas.
  40      * Root objects are signable, and have message identifiers and timestamps.
  41      */
  42     class SAML_API RootObject : public SignableObject
  43     {
  44     public:
  45         virtual ~RootObject();
  46
  47         /**
  48          * Returns the unique SAML ID of the object.
  49          *
  50          * @return the unique SAML ID
  51          */
  52         virtual const XMLCh* getID() const=0;
  53
  54         /**
  55          * Returns the timestamp of the object
  56          *
  57          * @return the timestamp
  58          */
  59         virtual const xmltooling::DateTime* getIssueInstant() const=0;
  60
  61         /**
  62          * Returns the timestamp of the object as an epoch
  63          *
  64          * @return the timestamp
  65          */
  66         virtual time_t getIssueInstantEpoch() const=0;
  67
  68     protected:
  69         RootObject();
  70     };
  71
  72     /**
  73      * Base class for SAML assertions.
  74      * Currently just a marker interface.
  75      */
  76     class SAML_API Assertion : public virtual RootObject
  77     {
  78     public:
  79         virtual ~Assertion();
  80     protected:
  81         Assertion();
  82     };
  83
  84     /**
  85      * Base class for SAML status codes.
  86      */
  87     class SAML_API Status : public virtual xmltooling::XMLObject
  88     {
  89     public:
  90         virtual ~Status();
  91
  92         /**
  93          * Returns a string representation of the top-level status code.
  94          *
  95          * @return string representation of top-level status code
  96          */
  97         virtual const XMLCh* getTopStatus() const=0;
  98
  99         /**
 100          * Returns a string representation of the second-level status code, if any.
 101          *
 102          * @return string representation of second-level status code, or nullptr
 103          */
 104         virtual const XMLCh* getSubStatus() const=0;
 105
 106         /**
 107          * Returns true iff status information beyond the second level exists.
 108          *
 109          * @return indicator of three or more status codes
 110          */
 111         virtual bool hasAdditionalStatus() const=0;
 112
 113         /**
 114          * Returns the message contained in the status, if any.
 115          *
 116          * @return status message, or nullptr
 117          */
 118         virtual const XMLCh* getMessage() const=0;
 119
 120     protected:
 121         Status();
 122     };
 123
 124 };
 125
 126 #endif /* __saml_root_h__ */