<!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::TransactionLog::Event 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('a00020.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="a00185.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shibsp::TransactionLog::Event Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Callback interface that outputs an event record to a stream using formatting tokens.
<a href="a00020.html#details">More...</a></p>
<p><code>#include <shibsp/TransactionLog.h></code></p>
<div class="dynheader">
Inheritance diagram for shibsp::TransactionLog::Event:</div>
<div class="dyncontent">
<div class="center">
<img src="a00020.png" usemap="#shibsp::TransactionLog::Event_map" alt=""/>
<map id="shibsp::TransactionLog::Event_map" name="shibsp::TransactionLog::Event_map">
<area href="a00012.html" alt="shibsp::AuthnRequestEvent" shape="rect" coords="0,56,179,80"/>
<area href="a00027.html" alt="shibsp::LoginEvent" shape="rect" coords="189,56,368,80"/>
<area href="a00028.html" alt="shibsp::LogoutEvent" shape="rect" coords="378,56,557,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:a9034985c1863676655b3dc4255bb404b"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a9034985c1863676655b3dc4255bb404b">getType</a> () const =0</td></tr>
<tr class="memdesc:a9034985c1863676655b3dc4255bb404b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a type string to be used for the log category in the event log. <a href="#a9034985c1863676655b3dc4255bb404b">More...</a><br/></td></tr>
<tr class="separator:a9034985c1863676655b3dc4255bb404b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b2bb7e844146a3a14806689cd50afd5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a5b2bb7e844146a3a14806689cd50afd5">write</a> (std::ostream &out, const char *field, const char *absent) const </td></tr>
<tr class="memdesc:a5b2bb7e844146a3a14806689cd50afd5"><td class="mdescLeft"> </td><td class="mdescRight">Outputs an event record to a stream based on the defined formatting string. <a href="#a5b2bb7e844146a3a14806689cd50afd5">More...</a><br/></td></tr>
<tr class="separator:a5b2bb7e844146a3a14806689cd50afd5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9b5557a97b84c78fd724439970678af4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b5557a97b84c78fd724439970678af4"></a>
const std::exception * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a9b5557a97b84c78fd724439970678af4">m_exception</a></td></tr>
<tr class="memdesc:a9b5557a97b84c78fd724439970678af4"><td class="mdescLeft"> </td><td class="mdescRight">Exception. <br/></td></tr>
<tr class="separator:a9b5557a97b84c78fd724439970678af4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0929d5aa27e0eec3e5fe607929115248"><td class="memItemLeft" align="right" valign="top">const xmltooling::GenericRequest * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a0929d5aa27e0eec3e5fe607929115248">m_request</a></td></tr>
<tr class="memdesc:a0929d5aa27e0eec3e5fe607929115248"><td class="mdescLeft"> </td><td class="mdescRight">Request object associated with event. <a href="#a0929d5aa27e0eec3e5fe607929115248">More...</a><br/></td></tr>
<tr class="separator:a0929d5aa27e0eec3e5fe607929115248"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15f3b399f009df7567d75c2f250a0bf7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00004.html">Application</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a15f3b399f009df7567d75c2f250a0bf7">m_app</a></td></tr>
<tr class="memdesc:a15f3b399f009df7567d75c2f250a0bf7"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> object associated with event. <a href="#a15f3b399f009df7567d75c2f250a0bf7">More...</a><br/></td></tr>
<tr class="separator:a15f3b399f009df7567d75c2f250a0bf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee88119256402a2765f5f844da308ca4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#aee88119256402a2765f5f844da308ca4">m_sessionID</a></td></tr>
<tr class="memdesc:aee88119256402a2765f5f844da308ca4"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> identifier. <a href="#aee88119256402a2765f5f844da308ca4">More...</a><br/></td></tr>
<tr class="separator:aee88119256402a2765f5f844da308ca4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27de1c30d748c84dc134453e6f546dd3"><td class="memItemLeft" align="right" valign="top">const <br class="typebreak"/>
opensaml::saml2md::EntityDescriptor * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a27de1c30d748c84dc134453e6f546dd3">m_peer</a></td></tr>
<tr class="memdesc:a27de1c30d748c84dc134453e6f546dd3"><td class="mdescLeft"> </td><td class="mdescRight">Peer entity associated with event. <a href="#a27de1c30d748c84dc134453e6f546dd3">More...</a><br/></td></tr>
<tr class="separator:a27de1c30d748c84dc134453e6f546dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b86116f13edd78d7b70bffda5a404b3"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a8b86116f13edd78d7b70bffda5a404b3">m_protocol</a></td></tr>
<tr class="memdesc:a8b86116f13edd78d7b70bffda5a404b3"><td class="mdescLeft"> </td><td class="mdescRight">Protocol associated with event. <a href="#a8b86116f13edd78d7b70bffda5a404b3">More...</a><br/></td></tr>
<tr class="separator:a8b86116f13edd78d7b70bffda5a404b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03131c25836cef51c1fe0b101467289d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a03131c25836cef51c1fe0b101467289d">m_binding</a></td></tr>
<tr class="memdesc:a03131c25836cef51c1fe0b101467289d"><td class="mdescLeft"> </td><td class="mdescRight">Protocol binding associated with event. <a href="#a03131c25836cef51c1fe0b101467289d">More...</a><br/></td></tr>
<tr class="separator:a03131c25836cef51c1fe0b101467289d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c6da9b217a742d4a17694fb8750e14a"><td class="memItemLeft" align="right" valign="top">const opensaml::saml2::NameID * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a1c6da9b217a742d4a17694fb8750e14a">m_nameID</a></td></tr>
<tr class="memdesc:a1c6da9b217a742d4a17694fb8750e14a"><td class="mdescLeft"> </td><td class="mdescRight">SAML 2.0 NameID. <a href="#a1c6da9b217a742d4a17694fb8750e14a">More...</a><br/></td></tr>
<tr class="separator:a1c6da9b217a742d4a17694fb8750e14a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a63093cc1a95fae8cb5e238b2c30f0ad4"><td class="memItemLeft" align="right" valign="top">typedef bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a63093cc1a95fae8cb5e238b2c30f0ad4">handler_fn</a> )(const <a class="el" href="a00020.html">Event</a> &e, std::ostream &)</td></tr>
<tr class="memdesc:a63093cc1a95fae8cb5e238b2c30f0ad4"><td class="mdescLeft"> </td><td class="mdescRight">Function that handles a formatting token. <a href="#a63093cc1a95fae8cb5e238b2c30f0ad4">More...</a><br/></td></tr>
<tr class="separator:a63093cc1a95fae8cb5e238b2c30f0ad4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a49a5b5e3583986af600ed3a121e8e476"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49a5b5e3583986af600ed3a121e8e476"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a49a5b5e3583986af600ed3a121e8e476">Event</a> ()</td></tr>
<tr class="memdesc:a49a5b5e3583986af600ed3a121e8e476"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr class="separator:a49a5b5e3583986af600ed3a121e8e476"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a8d59d9023344aa543cfd491fc45ce2cd"><td class="memItemLeft" align="right" valign="top">std::map< std::string, <a class="el" href="a00020.html#a63093cc1a95fae8cb5e238b2c30f0ad4">handler_fn</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00020.html#a8d59d9023344aa543cfd491fc45ce2cd">m_handlers</a></td></tr>
<tr class="memdesc:a8d59d9023344aa543cfd491fc45ce2cd"><td class="mdescLeft"> </td><td class="mdescRight">Map of tokens to handlers. <a href="#a8d59d9023344aa543cfd491fc45ce2cd">More...</a><br/></td></tr>
<tr class="separator:a8d59d9023344aa543cfd491fc45ce2cd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Callback interface that outputs an event record to a stream using formatting tokens. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a63093cc1a95fae8cb5e238b2c30f0ad4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef bool(* shibsp::TransactionLog::Event::handler_fn)(const <a class="el" href="a00020.html">Event</a> &e, std::ostream &)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function that handles a formatting token. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9034985c1863676655b3dc4255bb404b"></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::TransactionLog::Event::getType </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 type string to be used for the log category in the event log. </p>
<dl class="section return"><dt>Returns</dt><dd>type or category for the event </dd></dl>
<p>Implemented in <a class="el" href="a00012.html#a43f4a4fe76d189637288bcd2f27dcb6e">shibsp::AuthnRequestEvent</a>, <a class="el" href="a00028.html#acf45fa9044a4aa75e222248f4249bcec">shibsp::LogoutEvent</a>, and <a class="el" href="a00027.html#a0caa5e8c2d763bc9e79596956398c68b">shibsp::LoginEvent</a>.</p>
</div>
</div>
<a class="anchor" id="a5b2bb7e844146a3a14806689cd50afd5"></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::TransactionLog::Event::write </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>absent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</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>Outputs an event record to a stream based on the defined formatting string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>stream to use </td></tr>
<tr><td class="paramname">field</td><td>field to output </td></tr>
<tr><td class="paramname">absent</td><td>string to output if the field is empty </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the field was recognized and substituted </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a15f3b399f009df7567d75c2f250a0bf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00004.html">Application</a>* shibsp::TransactionLog::Event::m_app</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00004.html" title="Interface to a Shibboleth Application instance. ">Application</a> object associated with event. </p>
</div>
</div>
<a class="anchor" id="a03131c25836cef51c1fe0b101467289d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* shibsp::TransactionLog::Event::m_binding</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol binding associated with event. </p>
</div>
</div>
<a class="anchor" id="a8d59d9023344aa543cfd491fc45ce2cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::map<std::string, <a class="el" href="a00020.html#a63093cc1a95fae8cb5e238b2c30f0ad4">handler_fn</a>> shibsp::TransactionLog::Event::m_handlers</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Map of tokens to handlers. </p>
</div>
</div>
<a class="anchor" id="a1c6da9b217a742d4a17694fb8750e14a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const opensaml::saml2::NameID* shibsp::TransactionLog::Event::m_nameID</td>
</tr>
</table>
</div><div class="memdoc">
<p>SAML 2.0 NameID. </p>
</div>
</div>
<a class="anchor" id="a27de1c30d748c84dc134453e6f546dd3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const opensaml::saml2md::EntityDescriptor* shibsp::TransactionLog::Event::m_peer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Peer entity associated with event. </p>
</div>
</div>
<a class="anchor" id="a8b86116f13edd78d7b70bffda5a404b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* shibsp::TransactionLog::Event::m_protocol</td>
</tr>
</table>
</div><div class="memdoc">
<p>Protocol associated with event. </p>
</div>
</div>
<a class="anchor" id="a0929d5aa27e0eec3e5fe607929115248"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const xmltooling::GenericRequest* shibsp::TransactionLog::Event::m_request</td>
</tr>
</table>
</div><div class="memdoc">
<p>Request object associated with event. </p>
</div>
</div>
<a class="anchor" id="aee88119256402a2765f5f844da308ca4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* shibsp::TransactionLog::Event::m_sessionID</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00045.html" title="Encapsulates access to a user's security session. ">Session</a> identifier. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>shibsp/<a class="el" href="a00112.html">TransactionLog.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="a00055.html">TransactionLog</a></li><li class="navelem"><a class="el" href="a00020.html">Event</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>
