/usr/share/doc/libshibsp-doc/html/a00046.html is in libshibsp-doc 2.5.3+dfsg-2.1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 | <!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.9.1"/>
<title>shibboleth-2.5.3: shibsp::SessionCache 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="navtreedata.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.9.1 -->
<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('a00046.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00182.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::SessionCache Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Creates and manages user sessions.
<a href="a00046.html#details">More...</a></p>
<p><code>#include <shibsp/SessionCache.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::SessionCache:</div>
<div class="dyncontent">
<div class="center">
<img src="a00046.png" usemap="#shibsp::SessionCache_map" alt=""/>
<map id="shibsp::SessionCache_map" name="shibsp::SessionCache_map">
<area href="a00047.html" title="Extended SessionCache API with additional capabilities. " alt="shibsp::SessionCacheEx" shape="rect" coords="0,56,149,80"/>
</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:a8f04a735451173ed201a993c19a48ea8"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dba0ff63621a08c32d57d75ab97a625"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeaa8f738aa3e4aae897812e96d910696"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9980e5fc8a8ded05d1e7964b3dd9a43"><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"><td class="mdescLeft"> </td><td class="mdescRight">Executes a test of the cache's general health. <br /></td></tr>
<tr class="separator:aa9980e5fc8a8ded05d1e7964b3dd9a43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48ff340447088737458857f990d514a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae54870d4668f352f17d90942e1580923"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9976abc6a05c2b5bf5b193027c7c633a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88d09faddb4943b46769fdb70d35e862"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates and manages user sessions. </p>
<p>The cache abstracts a persistent (meaning across requests) cache of instances of the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> interface. Creation of new entries and entry lookup are confined to this interface to enable the implementation to remote and/or optimize calls by implementing custom versions of the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> interface as required. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af48ff340447088737458857f990d514a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string shibsp::SessionCache::active </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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>request</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 the ID of the session bound to the specified client request, if possible. </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">request</td><td>request from client containing session, or a reference to it </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ID of session, if any known, or an empty string </dd></dl>
</div>
</div>
<a class="anchor" id="ae54870d4668f352f17d90942e1580923"></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::SessionCache::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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>request</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 bound to a request. </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">request</td><td>request from client bound to session </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="a9976abc6a05c2b5bf5b193027c7c633a"></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::SessionCache::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">xmltooling::HTTPRequest & </td>
<td class="paramname"><em>request</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Locates an existing session bound to a request. </p>
<p>If the client address is supplied, then a check will be performed against the address recorded in the record.</p>
<p>If a bound session is found to have expired, be invalid, etc., and if the request can be used to "clear" the session from subsequent client requests, then it may be cleared.</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">request</td><td>request from client bound to session </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="a8f04a735451173ed201a993c19a48ea8"></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::SessionCache::insert </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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>httpRequest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmltooling::HTTPResponse & </td>
<td class="paramname"><em>httpResponse</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">const opensaml::saml2md::EntityDescriptor * </td>
<td class="paramname"><em>issuer</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>protocol</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2::NameID * </td>
<td class="paramname"><em>nameid</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authn_instant</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>session_index</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_class</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_decl</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< const opensaml::Assertion * > * </td>
<td class="paramname"><em>tokens</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00007.html">Attribute</a> * > * </td>
<td class="paramname"><em>attributes</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">
<dl class="deprecated"><dt><b><a class="el" href="a00134.html#_deprecated000011">Deprecated:</a></b></dt><dd>Inserts a new session into the cache and binds the session to the outgoing client response.</dd></dl>
<p>The SSO tokens and Attributes remain owned by the caller and are copied 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 <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> </td></tr>
<tr><td class="paramname">httpRequest</td><td>request that initiated session </td></tr>
<tr><td class="paramname">httpResponse</td><td>current response to client </td></tr>
<tr><td class="paramname">expires</td><td>expiration time of session </td></tr>
<tr><td class="paramname">issuer</td><td>issuing metadata of assertion issuer, if known </td></tr>
<tr><td class="paramname">protocol</td><td>protocol family used to initiate the session </td></tr>
<tr><td class="paramname">nameid</td><td>principal identifier, normalized to SAML 2, if any </td></tr>
<tr><td class="paramname">authn_instant</td><td>UTC timestamp of authentication at IdP, if known </td></tr>
<tr><td class="paramname">session_index</td><td>index of session between principal and IdP, if any </td></tr>
<tr><td class="paramname">authncontext_class</td><td>method/category of authentication event, if known </td></tr>
<tr><td class="paramname">authncontext_decl</td><td>specifics of authentication event, if known </td></tr>
<tr><td class="paramname">tokens</td><td>assertions to cache with session, if any </td></tr>
<tr><td class="paramname">attributes</td><td>optional array of resolved Attributes to cache with session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3dba0ff63621a08c32d57d75ab97a625"></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::SessionCache::insert </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>sessionID</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>httpRequest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmltooling::HTTPResponse & </td>
<td class="paramname"><em>httpResponse</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">const opensaml::saml2md::EntityDescriptor * </td>
<td class="paramname"><em>issuer</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>protocol</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const opensaml::saml2::NameID * </td>
<td class="paramname"><em>nameid</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authn_instant</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>session_index</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_class</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>authncontext_decl</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< const opensaml::Assertion * > * </td>
<td class="paramname"><em>tokens</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00007.html">Attribute</a> * > * </td>
<td class="paramname"><em>attributes</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts a new session into the cache and binds the session to the outgoing client response. </p>
<p>The newly created session ID is placed into the first parameter.</p>
<p>The SSO tokens and Attributes remain owned by the caller and are copied by the cache.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sessionID</td><td>reference to string to capture newly inserted session ID </td></tr>
<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">httpRequest</td><td>request that initiated session </td></tr>
<tr><td class="paramname">httpResponse</td><td>current response to client </td></tr>
<tr><td class="paramname">expires</td><td>expiration time of session </td></tr>
<tr><td class="paramname">issuer</td><td>issuing metadata of assertion issuer, if known </td></tr>
<tr><td class="paramname">protocol</td><td>protocol family used to initiate the session </td></tr>
<tr><td class="paramname">nameid</td><td>principal identifier, normalized to SAML 2, if any </td></tr>
<tr><td class="paramname">authn_instant</td><td>UTC timestamp of authentication at IdP, if known </td></tr>
<tr><td class="paramname">session_index</td><td>index of session between principal and IdP, if any </td></tr>
<tr><td class="paramname">authncontext_class</td><td>method/category of authentication event, if known </td></tr>
<tr><td class="paramname">authncontext_decl</td><td>specifics of authentication event, if known </td></tr>
<tr><td class="paramname">tokens</td><td>assertions to cache with session, if any </td></tr>
<tr><td class="paramname">attributes</td><td>optional array of resolved Attributes to cache with session </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeaa8f738aa3e4aae897812e96d910696"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool shibsp::SessionCache::matches </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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>request</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></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>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. </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">request</td><td>request in which to locate <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> </td></tr>
<tr><td class="paramname">issuer</td><td>required source of session(s) </td></tr>
<tr><td class="paramname">nameid</td><td>required name identifier </td></tr>
<tr><td class="paramname">indexes</td><td>session indexes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the <a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> exists and matches the input criteria </dd></dl>
</div>
</div>
<a class="anchor" id="a88d09faddb4943b46769fdb70d35e862"></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::SessionCache::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 xmltooling::HTTPRequest & </td>
<td class="paramname"><em>request</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmltooling::HTTPResponse * </td>
<td class="paramname"><em>response</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>Deletes an existing session bound to a request. </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">request</td><td>request from client containing session, or a reference to it </td></tr>
<tr><td class="paramname">response</td><td>optional response to client enabling removal of session or reference </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="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="a00046.html">SessionCache</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|