<!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::SessionCacheEx 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('a00047.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00181.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::SessionCacheEx Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Extended <a class="el" href="a00046.html" title="Creates and manages user sessions. ">SessionCache</a> API with additional capabilities.
<a href="a00047.html#details">More...</a></p>
<p><code>#include <shibsp/SessionCacheEx.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::SessionCacheEx:</div>
<div class="dyncontent">
<div class="center">
<img src="a00047.png" usemap="#shibsp::SessionCacheEx_map" alt=""/>
<map id="shibsp::SessionCacheEx_map" name="shibsp::SessionCacheEx_map">
<area href="a00046.html" title="Creates and manages user sessions. " alt="shibsp::SessionCache" shape="rect" coords="0,0,149,24"/>
</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:a212d8cbcce29f95843ce58e5b3c9e7b6"><td class="memItemLeft" align="right" valign="top">virtual std::vector<br class="typebreak"/>
< std::string >::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a212d8cbcce29f95843ce58e5b3c9e7b6">logout</a> (const <a class="el" href="a00004.html">Application</a> &application, const opensaml::saml2md::EntityDescriptor *issuer, const opensaml::saml2::NameID &nameid, const std::set< std::string > *indexes, time_t expires, std::vector< std::string > &sessions)=0</td></tr>
<tr class="memdesc:a212d8cbcce29f95843ce58e5b3c9e7b6"><td class="mdescLeft"> </td><td class="mdescRight">Returns active sessions that match particular parameters and records the logout to prevent race conditions. <a href="#a212d8cbcce29f95843ce58e5b3c9e7b6">More...</a><br/></td></tr>
<tr class="separator:a212d8cbcce29f95843ce58e5b3c9e7b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48ff631f876912006c2ba36bed808dde"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00045.html">Session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a48ff631f876912006c2ba36bed808dde">find</a> (const <a class="el" href="a00004.html">Application</a> &application, const char *key, const char *client_addr=nullptr, time_t *timeout=nullptr)=0</td></tr>
<tr class="memdesc:a48ff631f876912006c2ba36bed808dde"><td class="mdescLeft"> </td><td class="mdescRight">Locates an existing session by ID. <a href="#a48ff631f876912006c2ba36bed808dde">More...</a><br/></td></tr>
<tr class="separator:a48ff631f876912006c2ba36bed808dde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ceb8a2295e306f352d25f60f5bd8c80"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a1ceb8a2295e306f352d25f60f5bd8c80">remove</a> (const <a class="el" href="a00004.html">Application</a> &application, const char *key)=0</td></tr>
<tr class="memdesc:a1ceb8a2295e306f352d25f60f5bd8c80"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an existing session. <a href="#a1ceb8a2295e306f352d25f60f5bd8c80">More...</a><br/></td></tr>
<tr class="separator:a1ceb8a2295e306f352d25f60f5bd8c80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_a00046"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00046')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00046.html">shibsp::SessionCache</a></td></tr>
<tr class="memitem:a8f04a735451173ed201a993c19a48ea8 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a8f04a735451173ed201a993c19a48ea8">insert</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &httpRequest, xmltooling::HTTPResponse &httpResponse, time_t expires, const opensaml::saml2md::EntityDescriptor *issuer=nullptr, const XMLCh *protocol=nullptr, const opensaml::saml2::NameID *nameid=nullptr, const XMLCh *authn_instant=nullptr, const XMLCh *session_index=nullptr, const XMLCh *authncontext_class=nullptr, const XMLCh *authncontext_decl=nullptr, const std::vector< const opensaml::Assertion * > *tokens=nullptr, const std::vector< <a class="el" href="a00007.html">Attribute</a> * > *attributes=nullptr)=0</td></tr>
<tr class="separator:a8f04a735451173ed201a993c19a48ea8 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dba0ff63621a08c32d57d75ab97a625 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a3dba0ff63621a08c32d57d75ab97a625">insert</a> (std::string &sessionID, const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &httpRequest, xmltooling::HTTPResponse &httpResponse, time_t expires, const opensaml::saml2md::EntityDescriptor *issuer=nullptr, const XMLCh *protocol=nullptr, const opensaml::saml2::NameID *nameid=nullptr, const XMLCh *authn_instant=nullptr, const XMLCh *session_index=nullptr, const XMLCh *authncontext_class=nullptr, const XMLCh *authncontext_decl=nullptr, const std::vector< const opensaml::Assertion * > *tokens=nullptr, const std::vector< <a class="el" href="a00007.html">Attribute</a> * > *attributes=nullptr)</td></tr>
<tr class="memdesc:a3dba0ff63621a08c32d57d75ab97a625 inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a new session into the cache and binds the session to the outgoing client response. <a href="#a3dba0ff63621a08c32d57d75ab97a625">More...</a><br/></td></tr>
<tr class="separator:a3dba0ff63621a08c32d57d75ab97a625 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaa8f738aa3e4aae897812e96d910696 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#aeaa8f738aa3e4aae897812e96d910696">matches</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, const opensaml::saml2md::EntityDescriptor *issuer, const opensaml::saml2::NameID &nameid, const std::set< std::string > *indexes)=0</td></tr>
<tr class="memdesc:aeaa8f738aa3e4aae897812e96d910696 inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> bound to a client request matches a set of input criteria. <a href="#aeaa8f738aa3e4aae897812e96d910696">More...</a><br/></td></tr>
<tr class="separator:aeaa8f738aa3e4aae897812e96d910696 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9980e5fc8a8ded05d1e7964b3dd9a43 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9980e5fc8a8ded05d1e7964b3dd9a43"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#aa9980e5fc8a8ded05d1e7964b3dd9a43">test</a> ()=0</td></tr>
<tr class="memdesc:aa9980e5fc8a8ded05d1e7964b3dd9a43 inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Executes a test of the cache's general health. <br/></td></tr>
<tr class="separator:aa9980e5fc8a8ded05d1e7964b3dd9a43 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48ff340447088737458857f990d514a inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#af48ff340447088737458857f990d514a">active</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request)=0</td></tr>
<tr class="memdesc:af48ff340447088737458857f990d514a inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the session bound to the specified client request, if possible. <a href="#af48ff340447088737458857f990d514a">More...</a><br/></td></tr>
<tr class="separator:af48ff340447088737458857f990d514a inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae54870d4668f352f17d90942e1580923 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00045.html">Session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#ae54870d4668f352f17d90942e1580923">find</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, const char *client_addr=nullptr, time_t *timeout=nullptr)=0</td></tr>
<tr class="memdesc:ae54870d4668f352f17d90942e1580923 inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Locates an existing session bound to a request. <a href="#ae54870d4668f352f17d90942e1580923">More...</a><br/></td></tr>
<tr class="separator:ae54870d4668f352f17d90942e1580923 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9976abc6a05c2b5bf5b193027c7c633a inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00045.html">Session</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a9976abc6a05c2b5bf5b193027c7c633a">find</a> (const <a class="el" href="a00004.html">Application</a> &application, xmltooling::HTTPRequest &request, const char *client_addr=nullptr, time_t *timeout=nullptr)</td></tr>
<tr class="memdesc:a9976abc6a05c2b5bf5b193027c7c633a inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Locates an existing session bound to a request. <a href="#a9976abc6a05c2b5bf5b193027c7c633a">More...</a><br/></td></tr>
<tr class="separator:a9976abc6a05c2b5bf5b193027c7c633a inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88d09faddb4943b46769fdb70d35e862 inherit pub_methods_a00046"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#a88d09faddb4943b46769fdb70d35e862">remove</a> (const <a class="el" href="a00004.html">Application</a> &application, const xmltooling::HTTPRequest &request, xmltooling::HTTPResponse *response=nullptr)=0</td></tr>
<tr class="memdesc:a88d09faddb4943b46769fdb70d35e862 inherit pub_methods_a00046"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an existing session bound to a request. <a href="#a88d09faddb4943b46769fdb70d35e862">More...</a><br/></td></tr>
<tr class="separator:a88d09faddb4943b46769fdb70d35e862 inherit pub_methods_a00046"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Extended <a class="el" href="a00046.html" title="Creates and manages user sessions. ">SessionCache</a> API with additional capabilities. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a48ff631f876912006c2ba36bed808dde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00045.html">Session</a>* shibsp::SessionCacheEx::find </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>application</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>client_addr</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t * </td>
<td class="paramname"><em>timeout</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</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>Locates an existing session by ID. </p>
<p>If the client address is supplied, then a check will be performed against the address recorded in the record.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">application</td><td>reference to <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> that owns the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> </td></tr>
<tr><td class="paramname">key</td><td>session key </td></tr>
<tr><td class="paramname">client_addr</td><td>network address of client (if known) </td></tr>
<tr><td class="paramname">timeout</td><td>inactivity timeout to enforce (0 for none, nullptr to bypass check/update of last access) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to locked <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a>, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a212d8cbcce29f95843ce58e5b3c9e7b6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::vector<std::string>::size_type shibsp::SessionCacheEx::logout </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>application</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2md::EntityDescriptor * </td>
<td class="paramname"><em>issuer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2::NameID & </td>
<td class="paramname"><em>nameid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::set< std::string > * </td>
<td class="paramname"><em>indexes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">time_t </td>
<td class="paramname"><em>expires</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>sessions</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Returns active sessions that match particular parameters and records the logout to prevent race conditions. </p>
<p>On exit, the mapping between these sessions and the associated information MAY be removed by the cache, so subsequent calls to this method may not return anything.</p>
<p>Until logout expiration, any attempt to create a session with the same parameters will be blocked by the cache.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">application</td><td>reference to <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> that owns the session(s) </td></tr>
<tr><td class="paramname">issuer</td><td>source of session(s) </td></tr>
<tr><td class="paramname">nameid</td><td>name identifier associated with the session(s) to terminate </td></tr>
<tr><td class="paramname">indexes</td><td>indexes of sessions, or nullptr for all sessions associated with other parameters </td></tr>
<tr><td class="paramname">expires</td><td>logout expiration </td></tr>
<tr><td class="paramname">sessions</td><td>on exit, contains the IDs of the matching sessions found </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ceb8a2295e306f352d25f60f5bd8c80"></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::SessionCacheEx::remove </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00004.html">Application</a> & </td>
<td class="paramname"><em>application</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>Deletes an existing session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">application</td><td>reference to <a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> that owns the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> </td></tr>
<tr><td class="paramname">key</td><td>session key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/<a class="el" href="a00109.html">SessionCacheEx.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="a00047.html">SessionCacheEx</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>
