<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>opensaml-2.5.2: opensaml::CommonDomainCookie Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">opensaml-2.5.2 </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a00014.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="a00152.html">List of all members</a> </div> <div class="headertitle"> <div class="title">opensaml::CommonDomainCookie Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Helper class for maintaining discovery cookie. <a href="a00014.html#details">More...</a></p> <p><code>#include <saml/util/CommonDomainCookie.h></code></p> <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:a135af27e35b9aad96aa28b7ecc77fec0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#a135af27e35b9aad96aa28b7ecc77fec0">CommonDomainCookie</a> (const char *cookie)</td></tr> <tr class="memdesc:a135af27e35b9aad96aa28b7ecc77fec0"><td class="mdescLeft"> </td><td class="mdescRight">Parses a cookie for reading or writing. <a href="#a135af27e35b9aad96aa28b7ecc77fec0">More...</a><br/></td></tr> <tr class="separator:a135af27e35b9aad96aa28b7ecc77fec0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aba0b8a1c55fdaac08e7b41318ae72fa4"><td class="memItemLeft" align="right" valign="top">const std::vector< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#aba0b8a1c55fdaac08e7b41318ae72fa4">get</a> () const </td></tr> <tr class="memdesc:aba0b8a1c55fdaac08e7b41318ae72fa4"><td class="mdescLeft"> </td><td class="mdescRight">Returns list of IdPs stored in cookie. <a href="#aba0b8a1c55fdaac08e7b41318ae72fa4">More...</a><br/></td></tr> <tr class="separator:aba0b8a1c55fdaac08e7b41318ae72fa4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a497f0330c607ec0659d5dd87484d73fa"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#a497f0330c607ec0659d5dd87484d73fa">set</a> (const char *entityID)</td></tr> <tr class="memdesc:a497f0330c607ec0659d5dd87484d73fa"><td class="mdescLeft"> </td><td class="mdescRight">Adds/moves an IdP to the front of the list. <a href="#a497f0330c607ec0659d5dd87484d73fa">More...</a><br/></td></tr> <tr class="separator:a497f0330c607ec0659d5dd87484d73fa"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> Static Public Attributes</h2></td></tr> <tr class="memitem:aad414706ad5ccc8873cec1bb58d4b365"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad414706ad5ccc8873cec1bb58d4b365"></a> static const char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#aad414706ad5ccc8873cec1bb58d4b365">CDCName</a> []</td></tr> <tr class="memdesc:aad414706ad5ccc8873cec1bb58d4b365"><td class="mdescLeft"> </td><td class="mdescRight">Name of cookie ("_saml_idp") <br/></td></tr> <tr class="separator:aad414706ad5ccc8873cec1bb58d4b365"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Helper class for maintaining discovery cookie. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a135af27e35b9aad96aa28b7ecc77fec0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">opensaml::CommonDomainCookie::CommonDomainCookie </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>cookie</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Parses a cookie for reading or writing. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cookie</td><td>the raw cookie value </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aba0b8a1c55fdaac08e7b41318ae72fa4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::vector<std::string>& opensaml::CommonDomainCookie::get </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns list of IdPs stored in cookie. </p> <dl class="section return"><dt>Returns</dt><dd>reference to vector of entityIDs </dd></dl> </div> </div> <a class="anchor" id="a497f0330c607ec0659d5dd87484d73fa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* opensaml::CommonDomainCookie::set </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>entityID</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Adds/moves an IdP to the front of the list. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">entityID</td><td>name of IdP to add </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>new value of cookie </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>saml/util/<a class="el" href="a00116.html">CommonDomainCookie.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a00119.html">opensaml</a></li><li class="navelem"><a class="el" href="a00014.html">CommonDomainCookie</a></li> <li class="footer">Generated on Sat Oct 19 2013 08:32:21 for opensaml-2.5.2 by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> </body> </html>