<!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>xmltooling: xmltooling::CredentialResolver 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">xmltooling  <span id="projectnumber">1.5.3</span> </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('a00026.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="a00267.html">List of all members</a> </div> <div class="headertitle"> <div class="title">xmltooling::CredentialResolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>An API for resolving keys and certificates based on application criteria. <a href="a00026.html#details">More...</a></p> <p><code>#include <xmltooling/security/CredentialResolver.h></code></p> <div class="dynheader"> Inheritance diagram for xmltooling::CredentialResolver:</div> <div class="dyncontent"> <div class="center"> <img src="a00026.png" usemap="#xmltooling::CredentialResolver_map" alt=""/> <map id="xmltooling::CredentialResolver_map" name="xmltooling::CredentialResolver_map"> <area href="a00049.html" title="Abstract mixin interface for interfaces that support locking. " alt="xmltooling::Lockable" shape="rect" coords="0,0,181,24"/> </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:a223a3d2a975a284eec1ca16292d4be97"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a223a3d2a975a284eec1ca16292d4be97">resolve</a> (const <a class="el" href="a00025.html">CredentialCriteria</a> *criteria=0) const =0</td></tr> <tr class="memdesc:a223a3d2a975a284eec1ca16292d4be97"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single <a class="el" href="a00023.html" title="Wraps keys and related functionality. ">Credential</a> according to the supplied criteria. <a href="#a223a3d2a975a284eec1ca16292d4be97">More...</a><br/></td></tr> <tr class="separator:a223a3d2a975a284eec1ca16292d4be97"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adebf733d00784488367e8bf34ee5b299"><td class="memItemLeft" align="right" valign="top">virtual std::vector< const <br class="typebreak"/> <a class="el" href="a00023.html">Credential</a> * >::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#adebf733d00784488367e8bf34ee5b299">resolve</a> (std::vector< const <a class="el" href="a00023.html">Credential</a> * > &results, const <a class="el" href="a00025.html">CredentialCriteria</a> *criteria=0) const =0</td></tr> <tr class="memdesc:adebf733d00784488367e8bf34ee5b299"><td class="mdescLeft"> </td><td class="mdescRight">Returns all matching Credentials according to the supplied criteria. <a href="#adebf733d00784488367e8bf34ee5b299">More...</a><br/></td></tr> <tr class="separator:adebf733d00784488367e8bf34ee5b299"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_a00049"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00049')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00049.html">xmltooling::Lockable</a></td></tr> <tr class="memitem:a86337f8560d321f90662de5751764759 inherit pub_methods_a00049"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00049.html">Lockable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00049.html#a86337f8560d321f90662de5751764759">lock</a> ()=0</td></tr> <tr class="memdesc:a86337f8560d321f90662de5751764759 inherit pub_methods_a00049"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00048.html" title="RAII wrapper for a mutex lock. ">Lock</a> the associated object for exclusive access. <a href="#a86337f8560d321f90662de5751764759">More...</a><br/></td></tr> <tr class="separator:a86337f8560d321f90662de5751764759 inherit pub_methods_a00049"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a04bef17b2138bf6820bde7507c4d8111 inherit pub_methods_a00049"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04bef17b2138bf6820bde7507c4d8111"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00049.html#a04bef17b2138bf6820bde7507c4d8111">unlock</a> ()=0</td></tr> <tr class="memdesc:a04bef17b2138bf6820bde7507c4d8111 inherit pub_methods_a00049"><td class="mdescLeft"> </td><td class="mdescRight">Unlock the associated object from exclusive access. <br/></td></tr> <tr class="separator:a04bef17b2138bf6820bde7507c4d8111 inherit pub_methods_a00049"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>An API for resolving keys and certificates based on application criteria. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a223a3d2a975a284eec1ca16292d4be97"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="a00023.html">Credential</a>* xmltooling::CredentialResolver::resolve </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00025.html">CredentialCriteria</a> * </td> <td class="paramname"><em>criteria</em> = <code>0</code></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 single <a class="el" href="a00023.html" title="Wraps keys and related functionality. ">Credential</a> according to the supplied criteria. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">criteria</td><td>an optional <a class="el" href="a00025.html" title="Class for specifying criteria by which a CredentialResolver should resolve credentials. ">CredentialCriteria</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="a00023.html" title="Wraps keys and related functionality. ">Credential</a>, or nullptr if none could be found </dd></dl> </div> </div> <a class="anchor" id="adebf733d00784488367e8bf34ee5b299"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual std::vector<const <a class="el" href="a00023.html">Credential</a>*>::size_type xmltooling::CredentialResolver::resolve </td> <td>(</td> <td class="paramtype">std::vector< const <a class="el" href="a00023.html">Credential</a> * > & </td> <td class="paramname"><em>results</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00025.html">CredentialCriteria</a> * </td> <td class="paramname"><em>criteria</em> = <code>0</code> </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">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns all matching Credentials according to the supplied criteria. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">results</td><td>array to store matching Credentials </td></tr> <tr><td class="paramname">criteria</td><td>an optional <a class="el" href="a00025.html" title="Class for specifying criteria by which a CredentialResolver should resolve credentials. ">CredentialCriteria</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>number of credentials found </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>xmltooling/security/<a class="el" href="a00155.html">CredentialResolver.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="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00026.html">CredentialResolver</a></li> <li class="footer">Generated on Wed Sep 2 2015 18:20:35 for xmltooling 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>