<!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.3.1"/>
<title>dmlite: include/dmlite/cpp/base.h Source File</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="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">dmlite
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.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><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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c6836824bdef15bafab59627cccf2d55.html">dmlite</a></li><li class="navelem"><a class="el" href="dir_5eb0003806ff55b9e42d6823777110d1.html">cpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">base.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="base_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/// @file include/dmlite/cpp/base.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span><span class="comment">/// @brief Base interfaces.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span><span class="comment">/// @author Alejandro Álvarez Ayllón <aalvarez@cern.ch></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span><span class="preprocessor">#ifndef DMLITE_CPP_BASE_H</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor"></span><span class="preprocessor">#define DMLITE_CPP_BASE_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../common/config.h"</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="exceptions_8h.html" title="Exceptions used by the API.">exceptions.h</a>"</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span>dmlite {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <span class="comment">// Forward declarations.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">class </span>StackInstance;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keyword">class </span>SecurityContext;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> /// Base class for interfaces.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="code" href="classdmlite_1_1_base_interface.html"> 18</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_base_interface.html" title="Base class for interfaces.">BaseInterface</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> /// Virtual destructor</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_interface.html#aa82626772a719539b4d0e6879be9ea24" title="Virtual destructor.">~BaseInterface</a>();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// String ID of the implementation.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string <a class="code" href="classdmlite_1_1_base_interface.html#ae0e80ad4ec0d1bb810673db69ffdaf6c" title="String ID of the implementation.">getImplId</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> <span class="keywordflow">throw</span>() = 0;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="classdmlite_1_1_base_interface.html#a7653c7bbf485a8f140d1c9d112a59ad9"> 27</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_stack_instance.html">StackInstance</a>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// Set the StackInstance.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// Some plugins may need to access other stacks (i.e. the pool may need the catalog)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// However, at construction time not all the stacks have been populated, so this will</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// be called once all are instantiated.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_base_interface.html#a504c790858cddad86b0f74257e895af4">setStackInstance</a>(<a class="code" href="classdmlite_1_1_stack_instance.html">StackInstance</a>* si) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// Set the security context.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_base_interface.html#a07d4e485215cf05cc4d06500c2900e5b" title="Set the security context.">setSecurityContext</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_security_context.html" title="Security context. To be created by the Authn.">SecurityContext</a>* ctx) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// These method allows plugins to call other plugins setStackInstance and setSecurityContext</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_base_interface.html#a504c790858cddad86b0f74257e895af4">setStackInstance</a>(<a class="code" href="classdmlite_1_1_base_interface.html" title="Base class for interfaces.">BaseInterface</a>* i,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classdmlite_1_1_stack_instance.html">StackInstance</a>* si) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_base_interface.html#a07d4e485215cf05cc4d06500c2900e5b" title="Set the security context.">setSecurityContext</a>(<a class="code" href="classdmlite_1_1_base_interface.html" title="Base class for interfaces.">BaseInterface</a>* i,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">const</span> <a class="code" href="structdmlite_1_1_security_context.html" title="Security context. To be created by the Authn.">SecurityContext</a>* ctx) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  };</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// Base class for factories.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="classdmlite_1_1_base_factory.html"> 48</a></span> <span class="comment"></span> <span class="keyword">class </span><a class="code" href="classdmlite_1_1_base_factory.html" title="Base class for factories.">BaseFactory</a> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// Virtual destructor</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classdmlite_1_1_base_factory.html#a26922ed8ed380d8f36c7972467b92c18" title="Virtual destructor.">~BaseFactory</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /// Set a configuration parameter</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// @param key The configuration parameter</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// @param value The value for the configuration parameter</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_base_factory.html#a6e7e86ea4adf9c79d38bec63047cda25">configure</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> std::string& value) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif // DMLITE_CPP_BASE_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 12 2013 07:34:22 for dmlite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
