<!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>shibboleth-2.5.3: shibsp::Session 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">shibboleth-2.5.3
</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('a00045.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00179.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::Session Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Encapsulates access to a user's security session.
<a href="a00045.html#details">More...</a></p>
<p><code>#include <shibsp/SessionCache.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::Session:</div>
<div class="dyncontent">
<div class="center">
<img src="a00045.png" usemap="#shibsp::Session_map" alt=""/>
<map id="shibsp::Session_map" name="shibsp::Session_map">
</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:a34acd69829462a89c22fbc22592cc9dd"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a34acd69829462a89c22fbc22592cc9dd">getID</a> () const =0</td></tr>
<tr class="memdesc:a34acd69829462a89c22fbc22592cc9dd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the session key. <a href="#a34acd69829462a89c22fbc22592cc9dd">More...</a><br/></td></tr>
<tr class="separator:a34acd69829462a89c22fbc22592cc9dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6db41060041ce25a8f78f3ebb232964a"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a6db41060041ce25a8f78f3ebb232964a">getApplicationID</a> () const =0</td></tr>
<tr class="memdesc:a6db41060041ce25a8f78f3ebb232964a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the session's application ID. <a href="#a6db41060041ce25a8f78f3ebb232964a">More...</a><br/></td></tr>
<tr class="separator:a6db41060041ce25a8f78f3ebb232964a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa57f353290b5f817f22157351751c30"><td class="memItemLeft" align="right" valign="top">virtual time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#aaa57f353290b5f817f22157351751c30">getExpiration</a> () const =0</td></tr>
<tr class="memdesc:aaa57f353290b5f817f22157351751c30"><td class="mdescLeft"> </td><td class="mdescRight">Returns the session expiration. <a href="#aaa57f353290b5f817f22157351751c30">More...</a><br/></td></tr>
<tr class="separator:aaa57f353290b5f817f22157351751c30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac86753a8065074afbace8cb00497f306"><td class="memItemLeft" align="right" valign="top">virtual time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ac86753a8065074afbace8cb00497f306">getLastAccess</a> () const =0</td></tr>
<tr class="memdesc:ac86753a8065074afbace8cb00497f306"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last access time of the session. <a href="#ac86753a8065074afbace8cb00497f306">More...</a><br/></td></tr>
<tr class="separator:ac86753a8065074afbace8cb00497f306"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a695bb0053f208670e322a0c691542139"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a695bb0053f208670e322a0c691542139">getClientAddress</a> () const =0</td></tr>
<tr class="memdesc:a695bb0053f208670e322a0c691542139"><td class="mdescLeft"> </td><td class="mdescRight">Returns the address of the client associated with the session. <a href="#a695bb0053f208670e322a0c691542139">More...</a><br/></td></tr>
<tr class="separator:a695bb0053f208670e322a0c691542139"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a995e6181aecfb3afba8702086ad72e93"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a995e6181aecfb3afba8702086ad72e93">getEntityID</a> () const =0</td></tr>
<tr class="memdesc:a995e6181aecfb3afba8702086ad72e93"><td class="mdescLeft"> </td><td class="mdescRight">Returns the entityID of the IdP that initiated the session. <a href="#a995e6181aecfb3afba8702086ad72e93">More...</a><br/></td></tr>
<tr class="separator:a995e6181aecfb3afba8702086ad72e93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94f44c65b37586dd938ce6949e09f5fa"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a94f44c65b37586dd938ce6949e09f5fa">getProtocol</a> () const =0</td></tr>
<tr class="memdesc:a94f44c65b37586dd938ce6949e09f5fa"><td class="mdescLeft"> </td><td class="mdescRight">Returns the protocol family used to initiate the session. <a href="#a94f44c65b37586dd938ce6949e09f5fa">More...</a><br/></td></tr>
<tr class="separator:a94f44c65b37586dd938ce6949e09f5fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae21062bd75f57c66590aec54532620a5"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ae21062bd75f57c66590aec54532620a5">getAuthnInstant</a> () const =0</td></tr>
<tr class="memdesc:ae21062bd75f57c66590aec54532620a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the UTC timestamp on the authentication event at the IdP. <a href="#ae21062bd75f57c66590aec54532620a5">More...</a><br/></td></tr>
<tr class="separator:ae21062bd75f57c66590aec54532620a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18ea15f559779988453e737b8f0bc851"><td class="memItemLeft" align="right" valign="top">virtual const <br class="typebreak"/>
opensaml::saml2::NameID * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a18ea15f559779988453e737b8f0bc851">getNameID</a> () const =0</td></tr>
<tr class="memdesc:a18ea15f559779988453e737b8f0bc851"><td class="mdescLeft"> </td><td class="mdescRight">Returns the NameID associated with a session. <a href="#a18ea15f559779988453e737b8f0bc851">More...</a><br/></td></tr>
<tr class="separator:a18ea15f559779988453e737b8f0bc851"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5eeed91c87e84773e46b1e9cc34d9faa"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a5eeed91c87e84773e46b1e9cc34d9faa">getSessionIndex</a> () const =0</td></tr>
<tr class="memdesc:a5eeed91c87e84773e46b1e9cc34d9faa"><td class="mdescLeft"> </td><td class="mdescRight">Returns the SessionIndex provided with the session. <a href="#a5eeed91c87e84773e46b1e9cc34d9faa">More...</a><br/></td></tr>
<tr class="separator:a5eeed91c87e84773e46b1e9cc34d9faa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5b25094d8f0a388a7b1dd57b17ee686"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ae5b25094d8f0a388a7b1dd57b17ee686">getAuthnContextClassRef</a> () const =0</td></tr>
<tr class="memdesc:ae5b25094d8f0a388a7b1dd57b17ee686"><td class="mdescLeft"> </td><td class="mdescRight">Returns a URI containing an AuthnContextClassRef provided with the session. <a href="#ae5b25094d8f0a388a7b1dd57b17ee686">More...</a><br/></td></tr>
<tr class="separator:ae5b25094d8f0a388a7b1dd57b17ee686"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5aa3a348b66e31f25ba42a9ad5df3a5"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ac5aa3a348b66e31f25ba42a9ad5df3a5">getAuthnContextDeclRef</a> () const =0</td></tr>
<tr class="memdesc:ac5aa3a348b66e31f25ba42a9ad5df3a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a URI containing an AuthnContextDeclRef provided with the session. <a href="#ac5aa3a348b66e31f25ba42a9ad5df3a5">More...</a><br/></td></tr>
<tr class="separator:ac5aa3a348b66e31f25ba42a9ad5df3a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7ad803a93094577220cf4fd969efddb"><td class="memItemLeft" align="right" valign="top">virtual const std::vector<br class="typebreak"/>
< <a class="el" href="a00007.html">Attribute</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ac7ad803a93094577220cf4fd969efddb">getAttributes</a> () const =0</td></tr>
<tr class="memdesc:ac7ad803a93094577220cf4fd969efddb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the resolved attributes associated with the session. <a href="#ac7ad803a93094577220cf4fd969efddb">More...</a><br/></td></tr>
<tr class="separator:ac7ad803a93094577220cf4fd969efddb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49f0dd6ab9e4ade0d04143bc9ac97486"><td class="memItemLeft" align="right" valign="top">virtual const std::multimap<br class="typebreak"/>
< std::string, const <a class="el" href="a00007.html">Attribute</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a49f0dd6ab9e4ade0d04143bc9ac97486">getIndexedAttributes</a> () const =0</td></tr>
<tr class="memdesc:a49f0dd6ab9e4ade0d04143bc9ac97486"><td class="mdescLeft"> </td><td class="mdescRight">Returns the resolved attributes associated with the session, indexed by ID. <a href="#a49f0dd6ab9e4ade0d04143bc9ac97486">More...</a><br/></td></tr>
<tr class="separator:a49f0dd6ab9e4ade0d04143bc9ac97486"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d51ed3ba53bf0cf6625d9c9786a6da9"><td class="memItemLeft" align="right" valign="top">virtual const std::vector<br class="typebreak"/>
< const char * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a0d51ed3ba53bf0cf6625d9c9786a6da9">getAssertionIDs</a> () const =0</td></tr>
<tr class="memdesc:a0d51ed3ba53bf0cf6625d9c9786a6da9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the identifiers of the assertion(s) cached by the session. <a href="#a0d51ed3ba53bf0cf6625d9c9786a6da9">More...</a><br/></td></tr>
<tr class="separator:a0d51ed3ba53bf0cf6625d9c9786a6da9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6ba366a58ed903a99a7b556afbeaf67"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#ac6ba366a58ed903a99a7b556afbeaf67">addAttributes</a> (const std::vector< <a class="el" href="a00007.html">Attribute</a> * > &attributes)=0</td></tr>
<tr class="memdesc:ac6ba366a58ed903a99a7b556afbeaf67"><td class="mdescLeft"> </td><td class="mdescRight">Adds additional attributes to the session. <a href="#ac6ba366a58ed903a99a7b556afbeaf67">More...</a><br/></td></tr>
<tr class="separator:ac6ba366a58ed903a99a7b556afbeaf67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f28e194c289c7e7328c08949858d926"><td class="memItemLeft" align="right" valign="top">virtual const opensaml::Assertion * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a9f28e194c289c7e7328c08949858d926">getAssertion</a> (const char *id) const =0</td></tr>
<tr class="memdesc:a9f28e194c289c7e7328c08949858d926"><td class="mdescLeft"> </td><td class="mdescRight">Returns an assertion cached by the session. <a href="#a9f28e194c289c7e7328c08949858d926">More...</a><br/></td></tr>
<tr class="separator:a9f28e194c289c7e7328c08949858d926"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a294cae41918eca72182fe3abc27afdf5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a294cae41918eca72182fe3abc27afdf5">addAssertion</a> (opensaml::Assertion *assertion)=0</td></tr>
<tr class="memdesc:a294cae41918eca72182fe3abc27afdf5"><td class="mdescLeft"> </td><td class="mdescRight">Stores an assertion in the session. <a href="#a294cae41918eca72182fe3abc27afdf5">More...</a><br/></td></tr>
<tr class="separator:a294cae41918eca72182fe3abc27afdf5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Encapsulates access to a user's security session. </p>
<p>The <a class="el" href="a00046.html" title="Creates and manages user sessions. ">SessionCache</a> does not itself require locking to manage concurrency, but access to each <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> is generally exclusive or at least controlled, and the caller must unlock a <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> to dispose of it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a294cae41918eca72182fe3abc27afdf5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::Session::addAssertion </td>
<td>(</td>
<td class="paramtype">opensaml::Assertion * </td>
<td class="paramname"><em>assertion</em></td><td>)</td>
<td></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>Stores an assertion in the session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">assertion</td><td>pointer to an assertion to cache (will be freed by cache) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac6ba366a58ed903a99a7b556afbeaf67"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void shibsp::Session::addAttributes </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="a00007.html">Attribute</a> * > & </td>
<td class="paramname"><em>attributes</em></td><td>)</td>
<td></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>Adds additional attributes to the session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attributes</td><td>reference to an array of Attributes to cache (will be freed by cache) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6db41060041ce25a8f78f3ebb232964a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getApplicationID </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 session's application ID. </p>
<dl class="section return"><dt>Returns</dt><dd>unique ID of application bound to session </dd></dl>
</div>
</div>
<a class="anchor" id="a9f28e194c289c7e7328c08949858d926"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const opensaml::Assertion* shibsp::Session::getAssertion </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em></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 an assertion cached by the session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>identifier of the assertion to retrieve </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to assertion, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a0d51ed3ba53bf0cf6625d9c9786a6da9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::vector<const char*>& shibsp::Session::getAssertionIDs </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 identifiers of the assertion(s) cached by the session. </p>
<p>The SSO assertion is guaranteed to be first in the set.</p>
<dl class="section return"><dt>Returns</dt><dd>an immutable array of AssertionID values </dd></dl>
</div>
</div>
<a class="anchor" id="ac7ad803a93094577220cf4fd969efddb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::vector<<a class="el" href="a00007.html">Attribute</a>*>& shibsp::Session::getAttributes </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 resolved attributes associated with the session. </p>
<dl class="section return"><dt>Returns</dt><dd>an immutable array of attributes </dd></dl>
</div>
</div>
<a class="anchor" id="ae5b25094d8f0a388a7b1dd57b17ee686"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getAuthnContextClassRef </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 a URI containing an AuthnContextClassRef provided with the session. </p>
<p>SAML 1.x AuthenticationMethods will be returned as class references.</p>
<dl class="section return"><dt>Returns</dt><dd>a URI identifying the authentication context class </dd></dl>
</div>
</div>
<a class="anchor" id="ac5aa3a348b66e31f25ba42a9ad5df3a5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getAuthnContextDeclRef </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 a URI containing an AuthnContextDeclRef provided with the session. </p>
<dl class="section return"><dt>Returns</dt><dd>a URI identifying the authentication context declaration </dd></dl>
</div>
</div>
<a class="anchor" id="ae21062bd75f57c66590aec54532620a5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getAuthnInstant </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 UTC timestamp on the authentication event at the IdP. </p>
<dl class="section return"><dt>Returns</dt><dd>the UTC authentication timestamp </dd></dl>
</div>
</div>
<a class="anchor" id="a695bb0053f208670e322a0c691542139"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getClientAddress </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 address of the client associated with the session. </p>
<dl class="section return"><dt>Returns</dt><dd>the client's network address </dd></dl>
</div>
</div>
<a class="anchor" id="a995e6181aecfb3afba8702086ad72e93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getEntityID </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 entityID of the IdP that initiated the session. </p>
<dl class="section return"><dt>Returns</dt><dd>the IdP's entityID </dd></dl>
</div>
</div>
<a class="anchor" id="aaa57f353290b5f817f22157351751c30"></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 shibsp::Session::getExpiration </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 session expiration. </p>
<dl class="section return"><dt>Returns</dt><dd>the session's expiration time or 0 for none </dd></dl>
</div>
</div>
<a class="anchor" id="a34acd69829462a89c22fbc22592cc9dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::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 session key. </p>
<dl class="section return"><dt>Returns</dt><dd>unique ID of session </dd></dl>
</div>
</div>
<a class="anchor" id="a49f0dd6ab9e4ade0d04143bc9ac97486"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::multimap<std::string,const <a class="el" href="a00007.html">Attribute</a>*>& shibsp::Session::getIndexedAttributes </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 resolved attributes associated with the session, indexed by ID. </p>
<dl class="section return"><dt>Returns</dt><dd>an immutable map of attributes keyed by attribute ID </dd></dl>
</div>
</div>
<a class="anchor" id="ac86753a8065074afbace8cb00497f306"></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 shibsp::Session::getLastAccess </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 last access time of the session. </p>
<dl class="section return"><dt>Returns</dt><dd>the session's last access time </dd></dl>
</div>
</div>
<a class="anchor" id="a18ea15f559779988453e737b8f0bc851"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const opensaml::saml2::NameID* shibsp::Session::getNameID </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 NameID associated with a session. </p>
<p>SAML 1.x identifiers will be promoted to the 2.0 type.</p>
<dl class="section return"><dt>Returns</dt><dd>a SAML 2.0 NameID associated with the session, if any </dd></dl>
</div>
</div>
<a class="anchor" id="a94f44c65b37586dd938ce6949e09f5fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getProtocol </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 protocol family used to initiate the session. </p>
<dl class="section return"><dt>Returns</dt><dd>the protocol constant that represents the general SSO protocol used </dd></dl>
</div>
</div>
<a class="anchor" id="a5eeed91c87e84773e46b1e9cc34d9faa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* shibsp::Session::getSessionIndex </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 SessionIndex provided with the session. </p>
<dl class="section return"><dt>Returns</dt><dd>the SessionIndex from the original SSO assertion, if any </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/<a class="el" href="a00108.html">SessionCache.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="a00127.html">shibsp</a></li><li class="navelem"><a class="el" href="a00045.html">Session</a></li>
<li class="footer">Generated on Thu Dec 5 2013 22:10:44 for shibboleth-2.5.3 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>
