<!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/handler/SessionInitiator.h File 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File 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('a00092.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SessionInitiator.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Licensed to the University Corporation for Advanced Internet Development, Inc.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="a00087.html">shibsp/handler/Handler.h</a>></code><br/>
<code>#include <map></code><br/>
<code>#include <set></code><br/>
<code>#include <string></code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00048.html">shibsp::SessionInitiator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Pluggable runtime functionality that handles initiating sessions. <a href="a00048.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:a00127"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html">shibsp</a></td></tr>
<tr class="memdesc:a00127"><td class="mdescLeft"> </td><td class="mdescRight">Shibboleth Service Provider Library. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adeaaa287ac8dc693ffef23589150d74b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#adeaaa287ac8dc693ffef23589150d74b">CHAINING_SESSION_INITIATOR</a>   "Chaining"</td></tr>
<tr class="memdesc:adeaaa287ac8dc693ffef23589150d74b"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that iterates through a set of protocol-specific versions. <a href="#adeaaa287ac8dc693ffef23589150d74b">More...</a><br/></td></tr>
<tr class="separator:adeaaa287ac8dc693ffef23589150d74b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8be14e5c6454a5f4c59c07b3a6e71206"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a8be14e5c6454a5f4c59c07b3a6e71206">SAML2_SESSION_INITIATOR</a>   "SAML2"</td></tr>
<tr class="memdesc:a8be14e5c6454a5f4c59c07b3a6e71206"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that supports SAML 2.0 AuthnRequests. <a href="#a8be14e5c6454a5f4c59c07b3a6e71206">More...</a><br/></td></tr>
<tr class="separator:a8be14e5c6454a5f4c59c07b3a6e71206"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaaf3090a81b63d4354f6a22b4b7015b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#aaaf3090a81b63d4354f6a22b4b7015b1">SAMLDS_SESSION_INITIATOR</a>   "SAMLDS"</td></tr>
<tr class="memdesc:aaaf3090a81b63d4354f6a22b4b7015b1"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that supports SAML Discovery Service protocol. <a href="#aaaf3090a81b63d4354f6a22b4b7015b1">More...</a><br/></td></tr>
<tr class="separator:aaaf3090a81b63d4354f6a22b4b7015b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a377b64ca94c5924ab095d64a3daf0883"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a377b64ca94c5924ab095d64a3daf0883">SHIB1_SESSION_INITIATOR</a>   "Shib1"</td></tr>
<tr class="memdesc:a377b64ca94c5924ab095d64a3daf0883"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that supports Shibboleth V1 AuthnRequest redirects. <a href="#a377b64ca94c5924ab095d64a3daf0883">More...</a><br/></td></tr>
<tr class="separator:a377b64ca94c5924ab095d64a3daf0883"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42c38964e67d783b474bee36ed1a05fe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a42c38964e67d783b474bee36ed1a05fe">WAYF_SESSION_INITIATOR</a>   "WAYF"</td></tr>
<tr class="memdesc:a42c38964e67d783b474bee36ed1a05fe"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that supports Shibboleth V1 WAYF redirects when no IdP is supplied. <a href="#a42c38964e67d783b474bee36ed1a05fe">More...</a><br/></td></tr>
<tr class="separator:a42c38964e67d783b474bee36ed1a05fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e66b87632a8fb779ac3d1c00a87d6fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a9e66b87632a8fb779ac3d1c00a87d6fb">TRANSFORM_SESSION_INITIATOR</a>   "Transform"</td></tr>
<tr class="memdesc:a9e66b87632a8fb779ac3d1c00a87d6fb"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that attempts a sequence of transforms of an input until an entityID is found. <a href="#a9e66b87632a8fb779ac3d1c00a87d6fb">More...</a><br/></td></tr>
<tr class="separator:a9e66b87632a8fb779ac3d1c00a87d6fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83639994467d802afb5dfa11ab6790fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a83639994467d802afb5dfa11ab6790fb">FORM_SESSION_INITIATOR</a>   "Form"</td></tr>
<tr class="memdesc:a83639994467d802afb5dfa11ab6790fb"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that uses HTML form submission from the user. <a href="#a83639994467d802afb5dfa11ab6790fb">More...</a><br/></td></tr>
<tr class="separator:a83639994467d802afb5dfa11ab6790fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c59597f7ac4ae5872c1745b41f63c2b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00092.html#a6c59597f7ac4ae5872c1745b41f63c2b">COOKIE_SESSION_INITIATOR</a>   "Cookie"</td></tr>
<tr class="memdesc:a6c59597f7ac4ae5872c1745b41f63c2b"><td class="mdescLeft"> </td><td class="mdescRight">SessionInitiator that reads the CDC. <a href="#a6c59597f7ac4ae5872c1745b41f63c2b">More...</a><br/></td></tr>
<tr class="separator:a6c59597f7ac4ae5872c1745b41f63c2b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9fa087eb1a36e489433fb29826c930bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00127.html#a9fa087eb1a36e489433fb29826c930bf">shibsp::registerSessionInitiators</a> ()</td></tr>
<tr class="memdesc:a9fa087eb1a36e489433fb29826c930bf"><td class="mdescLeft"> </td><td class="mdescRight">Registers <a class="el" href="a00048.html" title="Pluggable runtime functionality that handles initiating sessions. ">SessionInitiator</a> implementations. <a href="#a9fa087eb1a36e489433fb29826c930bf">More...</a><br/></td></tr>
<tr class="separator:a9fa087eb1a36e489433fb29826c930bf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Licensed to the University Corporation for Advanced Internet Development, Inc. </p>
<p>(UCAID) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership.</p>
<p>UCAID licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at</p>
<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
<p>Pluggable runtime functionality that handles initiating sessions. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="adeaaa287ac8dc693ffef23589150d74b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHAINING_SESSION_INITIATOR   "Chaining"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that iterates through a set of protocol-specific versions. </p>
</div>
</div>
<a class="anchor" id="a6c59597f7ac4ae5872c1745b41f63c2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COOKIE_SESSION_INITIATOR   "Cookie"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that reads the CDC. </p>
</div>
</div>
<a class="anchor" id="a83639994467d802afb5dfa11ab6790fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FORM_SESSION_INITIATOR   "Form"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that uses HTML form submission from the user. </p>
</div>
</div>
<a class="anchor" id="a8be14e5c6454a5f4c59c07b3a6e71206"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SAML2_SESSION_INITIATOR   "SAML2"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that supports SAML 2.0 AuthnRequests. </p>
</div>
</div>
<a class="anchor" id="aaaf3090a81b63d4354f6a22b4b7015b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SAMLDS_SESSION_INITIATOR   "SAMLDS"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that supports SAML Discovery Service protocol. </p>
</div>
</div>
<a class="anchor" id="a377b64ca94c5924ab095d64a3daf0883"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SHIB1_SESSION_INITIATOR   "Shib1"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that supports Shibboleth V1 AuthnRequest redirects. </p>
</div>
</div>
<a class="anchor" id="a9e66b87632a8fb779ac3d1c00a87d6fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TRANSFORM_SESSION_INITIATOR   "Transform"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that attempts a sequence of transforms of an input until an entityID is found. </p>
</div>
</div>
<a class="anchor" id="a42c38964e67d783b474bee36ed1a05fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define WAYF_SESSION_INITIATOR   "WAYF"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SessionInitiator that supports Shibboleth V1 WAYF redirects when no IdP is supplied. </p>
</div>
</div>
</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="dir_9005c7b20a99b4f4685820dfc04044a9.html">shibsp</a></li><li class="navelem"><a class="el" href="dir_d96dd7be744024b8e97974393bb83127.html">handler</a></li><li class="navelem"><a class="el" href="a00092.html">SessionInitiator.h</a></li>
<li class="footer">Generated on Thu Dec 5 2013 22:10:43 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>
