<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>opensaml-2.5.2: opensaml::RootObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">opensaml-2.5.2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00048.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00145.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">opensaml::RootObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for SAML objects at the root of core schemas.
<a href="a00048.html#details">More...</a></p>
<p><code>#include <saml/RootObject.h></code></p>
<div class="dynheader">
Inheritance diagram for opensaml::RootObject:</div>
<div class="dyncontent">
<div class="center">
<img src="a00048.png" usemap="#opensaml::RootObject_map" alt=""/>
<map id="opensaml::RootObject_map" name="opensaml::RootObject_map">
<area href="a00062.html" title="Base class for SAML objects that can be signed. " alt="opensaml::SignableObject" shape="rect" coords="90,56,261,80"/>
<area href="a00005.html" title="Base class for SAML assertions. " alt="opensaml::Assertion" shape="rect" coords="0,168,171,192"/>
<area href="a00047.html" title="SAML 2.0 assertion or protocol message. " alt="opensaml::saml2::RootObject" shape="rect" coords="181,168,352,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a72a14746639fb725d4d281bbe1870e28"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a72a14746639fb725d4d281bbe1870e28">getID</a> () const =0</td></tr>
<tr class="memdesc:a72a14746639fb725d4d281bbe1870e28"><td class="mdescLeft"> </td><td class="mdescRight">Returns the unique SAML ID of the object. <a href="#a72a14746639fb725d4d281bbe1870e28">More...</a><br/></td></tr>
<tr class="separator:a72a14746639fb725d4d281bbe1870e28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a094f96c1b21007be8d298e41cb3fcaa2"><td class="memItemLeft" align="right" valign="top">virtual const <br class="typebreak"/>
xmltooling::DateTime * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#a094f96c1b21007be8d298e41cb3fcaa2">getIssueInstant</a> () const =0</td></tr>
<tr class="memdesc:a094f96c1b21007be8d298e41cb3fcaa2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timestamp of the object. <a href="#a094f96c1b21007be8d298e41cb3fcaa2">More...</a><br/></td></tr>
<tr class="separator:a094f96c1b21007be8d298e41cb3fcaa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae37ca91ddc57f6b7a704fa884cbbb875"><td class="memItemLeft" align="right" valign="top">virtual time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html#ae37ca91ddc57f6b7a704fa884cbbb875">getIssueInstantEpoch</a> () const =0</td></tr>
<tr class="memdesc:ae37ca91ddc57f6b7a704fa884cbbb875"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timestamp of the object as an epoch. <a href="#ae37ca91ddc57f6b7a704fa884cbbb875">More...</a><br/></td></tr>
<tr class="separator:ae37ca91ddc57f6b7a704fa884cbbb875"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_a00062"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00062')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00062.html">opensaml::SignableObject</a></td></tr>
<tr class="memitem:aeb384be77bdee824de7e7fb0baf4e35a inherit pub_methods_a00062"><td class="memItemLeft" align="right" valign="top">virtual xmlsignature::Signature * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#aeb384be77bdee824de7e7fb0baf4e35a">getSignature</a> () const =0</td></tr>
<tr class="memdesc:aeb384be77bdee824de7e7fb0baf4e35a inherit pub_methods_a00062"><td class="mdescLeft"> </td><td class="mdescRight">Returns the enveloped Signature from the object. <a href="#aeb384be77bdee824de7e7fb0baf4e35a">More...</a><br/></td></tr>
<tr class="separator:aeb384be77bdee824de7e7fb0baf4e35a inherit pub_methods_a00062"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a422facef2b414637e9f4448f724f8381 inherit pub_methods_a00062"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a422facef2b414637e9f4448f724f8381">setSignature</a> (xmlsignature::Signature *sig)=0</td></tr>
<tr class="memdesc:a422facef2b414637e9f4448f724f8381 inherit pub_methods_a00062"><td class="mdescLeft"> </td><td class="mdescRight">Sets an enveloped Signature in the object. <a href="#a422facef2b414637e9f4448f724f8381">More...</a><br/></td></tr>
<tr class="separator:a422facef2b414637e9f4448f724f8381 inherit pub_methods_a00062"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_a00062"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_a00062')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="a00062.html">opensaml::SignableObject</a></td></tr>
<tr class="memitem:a53453e526860ca51157035b870a931c4 inherit pro_methods_a00062"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53453e526860ca51157035b870a931c4"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00062.html#a53453e526860ca51157035b870a931c4">declareNonVisibleNamespaces</a> () const </td></tr>
<tr class="memdesc:a53453e526860ca51157035b870a931c4 inherit pro_methods_a00062"><td class="mdescLeft"> </td><td class="mdescRight">Search the object for non-visible namespaces, and pin them on the root of the object where necessary, adding them to the inclusive prefix list for signing purposes. <br/></td></tr>
<tr class="separator:a53453e526860ca51157035b870a931c4 inherit pro_methods_a00062"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for SAML objects at the root of core schemas. </p>
<p>Root objects are signable, and have message identifiers and timestamps. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a72a14746639fb725d4d281bbe1870e28"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* opensaml::RootObject::getID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the unique SAML ID of the object. </p>
<dl class="section return"><dt>Returns</dt><dd>the unique SAML ID </dd></dl>
</div>
</div>
<a class="anchor" id="a094f96c1b21007be8d298e41cb3fcaa2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const xmltooling::DateTime* opensaml::RootObject::getIssueInstant </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the timestamp of the object. </p>
<dl class="section return"><dt>Returns</dt><dd>the timestamp </dd></dl>
</div>
</div>
<a class="anchor" id="ae37ca91ddc57f6b7a704fa884cbbb875"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual time_t opensaml::RootObject::getIssueInstantEpoch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the timestamp of the object as an epoch. </p>
<dl class="section return"><dt>Returns</dt><dd>the timestamp </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>saml/<a class="el" href="a00082.html">RootObject.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00119.html">opensaml</a></li><li class="navelem"><a class="el" href="a00048.html">RootObject</a></li>
<li class="footer">Generated on Sat Oct 19 2013 08:32:21 for opensaml-2.5.2 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
