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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file saml/RootObject.h
24 * Base class for SAML objects at the root of core schemas.
27 #ifndef __saml_root_h__
28 #define __saml_root_h__
30 #include <saml/signature/SignableObject.h>
32 namespace xmltooling {
33 class XMLTOOL_API DateTime;
39 * Base class for SAML objects at the root of core schemas.
40 * Root objects are signable, and have message identifiers and timestamps.
42 class SAML_API RootObject : public SignableObject
45 virtual ~RootObject();
48 * Returns the unique SAML ID of the object.
50 * @return the unique SAML ID
52 virtual const XMLCh* getID() const=0;
55 * Returns the timestamp of the object
57 * @return the timestamp
59 virtual const xmltooling::DateTime* getIssueInstant() const=0;
62 * Returns the timestamp of the object as an epoch
64 * @return the timestamp
66 virtual time_t getIssueInstantEpoch() const=0;
73 * Base class for SAML assertions.
74 * Currently just a marker interface.
76 class SAML_API Assertion : public virtual RootObject
85 * Base class for SAML status codes.
87 class SAML_API Status : public virtual xmltooling::XMLObject
93 * Returns a string representation of the top-level status code.
95 * @return string representation of top-level status code
97 virtual const XMLCh* getTopStatus() const=0;
100 * Returns a string representation of the second-level status code, if any.
102 * @return string representation of second-level status code, or nullptr
104 virtual const XMLCh* getSubStatus() const=0;
107 * Returns true iff status information beyond the second level exists.
109 * @return indicator of three or more status codes
111 virtual bool hasAdditionalStatus() const=0;
114 * Returns the message contained in the status, if any.
116 * @return status message, or nullptr
118 virtual const XMLCh* getMessage() const=0;
126 #endif /* __saml_root_h__ */