<!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::KeyInfoResolver 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('a00047.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="a00269.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::KeyInfoResolver Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Resolves credentials from KeyInfo information.
<a href="a00047.html#details">More...</a></p>
<p><code>#include <xmltooling/security/KeyInfoResolver.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:aa069caeac7c4ed26aac4f2ca3e59b6b2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#aa069caeac7c4ed26aac4f2ca3e59b6b2">resolve</a> (const xmlsignature::KeyInfo *keyInfo, int types=0) const =0</td></tr>
<tr class="memdesc:aa069caeac7c4ed26aac4f2ca3e59b6b2"><td class="mdescLeft"> </td><td class="mdescRight">Returns a credential based on the supplied KeyInfo information. <a href="#aa069caeac7c4ed26aac4f2ca3e59b6b2">More...</a><br/></td></tr>
<tr class="separator:aa069caeac7c4ed26aac4f2ca3e59b6b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38fe0862f44ccefbc412cebae50b2ce3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a38fe0862f44ccefbc412cebae50b2ce3">resolve</a> (DSIGKeyInfoList *keyInfo, int types=0) const =0</td></tr>
<tr class="memdesc:a38fe0862f44ccefbc412cebae50b2ce3"><td class="mdescLeft"> </td><td class="mdescRight">Returns a credential based on the supplied KeyInfo information. <a href="#a38fe0862f44ccefbc412cebae50b2ce3">More...</a><br/></td></tr>
<tr class="separator:a38fe0862f44ccefbc412cebae50b2ce3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac52dcd047b554d60967d6c09cd8b3b5f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#ac52dcd047b554d60967d6c09cd8b3b5f">resolve</a> (<a class="el" href="a00046.html">KeyInfoCredentialContext</a> *context, int types=0) const =0</td></tr>
<tr class="memdesc:ac52dcd047b554d60967d6c09cd8b3b5f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a credential based on the KeyInfo information in the supplied context. <a href="#ac52dcd047b554d60967d6c09cd8b3b5f">More...</a><br/></td></tr>
<tr class="separator:ac52dcd047b554d60967d6c09cd8b3b5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1417a626aaf2681a01fc6ac738b6a152"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a1417a626aaf2681a01fc6ac738b6a152">resolve</a> (const <a class="el" href="a00075.html">xmlsignature::Signature</a> *sig, int types=0) const </td></tr>
<tr class="memdesc:a1417a626aaf2681a01fc6ac738b6a152"><td class="mdescLeft"> </td><td class="mdescRight">Returns a credential based on the supplied KeyInfo information. <a href="#a1417a626aaf2681a01fc6ac738b6a152">More...</a><br/></td></tr>
<tr class="separator:a1417a626aaf2681a01fc6ac738b6a152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fbf501f1359a8c53a4e82634596071c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00023.html">Credential</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00047.html#a1fbf501f1359a8c53a4e82634596071c">resolve</a> (const <a class="el" href="a00025.html">CredentialCriteria</a> &criteria, int types=0) const </td></tr>
<tr class="memdesc:a1fbf501f1359a8c53a4e82634596071c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a credential based on the KeyInfo information in the supplied criteria. <a href="#a1fbf501f1359a8c53a4e82634596071c">More...</a><br/></td></tr>
<tr class="separator:a1fbf501f1359a8c53a4e82634596071c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Resolves credentials from KeyInfo information. </p>
<p>Credential-specific bitmasks can be provided to control what to resolve.</p>
<p>Implementations should only establish KeyNames on the basis of explicit names within the KeyInfo object, never by extracting names out of physical credentials found within it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa069caeac7c4ed26aac4f2ca3e59b6b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00023.html">Credential</a>* xmltooling::KeyInfoResolver::resolve </td>
<td>(</td>
<td class="paramtype">const xmlsignature::KeyInfo * </td>
<td class="paramname"><em>keyInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>types</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 a credential based on the supplied KeyInfo information. </p>
<p>The caller must release the credential when done with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyInfo</td><td>the key information </td></tr>
<tr><td class="paramname">types</td><td>types of credentials to resolve, or 0 for any/all </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the resolved credential, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a38fe0862f44ccefbc412cebae50b2ce3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00023.html">Credential</a>* xmltooling::KeyInfoResolver::resolve </td>
<td>(</td>
<td class="paramtype">DSIGKeyInfoList * </td>
<td class="paramname"><em>keyInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>types</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 a credential based on the supplied KeyInfo information. </p>
<p>The caller must release the credential when done with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyInfo</td><td>the key information </td></tr>
<tr><td class="paramname">types</td><td>types of credentials to resolve, or 0 for any/all </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the resolved credential, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="ac52dcd047b554d60967d6c09cd8b3b5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00023.html">Credential</a>* xmltooling::KeyInfoResolver::resolve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00046.html">KeyInfoCredentialContext</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>types</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 a credential based on the KeyInfo information in the supplied context. </p>
<p>The caller must release the credential when done with it.</p>
<p>The context object will be owned by the <a class="el" href="a00023.html" title="Wraps keys and related functionality. ">Credential</a> and freed with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>context containing the key information </td></tr>
<tr><td class="paramname">types</td><td>types of credentials to resolve, or 0 for any/all </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the resolved credential, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a1417a626aaf2681a01fc6ac738b6a152"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html">Credential</a>* xmltooling::KeyInfoResolver::resolve </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00075.html">xmlsignature::Signature</a> * </td>
<td class="paramname"><em>sig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>types</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a credential based on the supplied KeyInfo information. </p>
<p>The caller must release the credential when done with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sig</td><td>signature containing the key information </td></tr>
<tr><td class="paramname">types</td><td>types of credentials to resolve, or 0 for any/all </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the resolved credential, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a1fbf501f1359a8c53a4e82634596071c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html">Credential</a>* xmltooling::KeyInfoResolver::resolve </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00025.html">CredentialCriteria</a> & </td>
<td class="paramname"><em>criteria</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>types</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a credential based on the KeyInfo information in the supplied criteria. </p>
<p>The caller must release the credential when done with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">criteria</td><td>criteria containing the key information </td></tr>
<tr><td class="paramname">types</td><td>types of credentials to resolve, or 0 for any/all </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the resolved credential, or nullptr </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/security/<a class="el" href="a00157.html">KeyInfoResolver.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="a00047.html">KeyInfoResolver</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>
