Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 553d1e1391b9f1acad517c925f34ae45 > files > 304

lib64xmltooling-devel-1.5.3-5.mga5.x86_64.rpm

<!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.8"/>
<title>xmltooling: xmlsignature::SignatureValidator 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
   &#160;<span id="projectnumber">1.5.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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('a00079.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="a00222.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">xmlsignature::SignatureValidator Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Validator for signatures based on a Credential.  
 <a href="a00079.html#details">More...</a></p>

<p><code>#include &lt;xmltooling/signature/SignatureValidator.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for xmlsignature::SignatureValidator:</div>
<div class="dyncontent">
 <div class="center">
  <img src="a00079.png" usemap="#xmlsignature::SignatureValidator_map" alt=""/>
  <map id="xmlsignature::SignatureValidator_map" name="xmlsignature::SignatureValidator_map">
<area href="a00099.html" title="An interface for classes that implement rules for checking the validity of XMLObjects. " alt="xmltooling::Validator" shape="rect" coords="0,0,193,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:a4fc148c5801891d90d6a795638eb18cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a4fc148c5801891d90d6a795638eb18cb">SignatureValidator</a> (XSECCryptoKey *key=0)</td></tr>
<tr class="memdesc:a4fc148c5801891d90d6a795638eb18cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor using a key.  <a href="#a4fc148c5801891d90d6a795638eb18cb">More...</a><br /></td></tr>
<tr class="separator:a4fc148c5801891d90d6a795638eb18cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43e6384eb13194b0468b3effbae8d1c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a43e6384eb13194b0468b3effbae8d1c6">SignatureValidator</a> (const <a class="el" href="a00023.html">xmltooling::Credential</a> *credential)</td></tr>
<tr class="memdesc:a43e6384eb13194b0468b3effbae8d1c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor using a Credential.  <a href="#a43e6384eb13194b0468b3effbae8d1c6">More...</a><br /></td></tr>
<tr class="separator:a43e6384eb13194b0468b3effbae8d1c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf6965d74a6813d3ec8c8a9432816f18"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#adf6965d74a6813d3ec8c8a9432816f18">validate</a> (const <a class="el" href="a00105.html">xmltooling::XMLObject</a> *xmlObject) const </td></tr>
<tr class="memdesc:adf6965d74a6813d3ec8c8a9432816f18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if an XMLObject is valid.  <a href="#adf6965d74a6813d3ec8c8a9432816f18">More...</a><br /></td></tr>
<tr class="separator:adf6965d74a6813d3ec8c8a9432816f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aada1271ddfe7a1e034a4a3f78d101c71"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#aada1271ddfe7a1e034a4a3f78d101c71">validate</a> (const <a class="el" href="a00075.html">Signature</a> *signature) const </td></tr>
<tr class="memdesc:aada1271ddfe7a1e034a4a3f78d101c71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type-safe validator.  <a href="#aada1271ddfe7a1e034a4a3f78d101c71">More...</a><br /></td></tr>
<tr class="separator:aada1271ddfe7a1e034a4a3f78d101c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcded407dd145394089f54b5072214b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#adcded407dd145394089f54b5072214b7">setKey</a> (XSECCryptoKey *key)</td></tr>
<tr class="memdesc:adcded407dd145394089f54b5072214b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the current key, if any, with a new one.  <a href="#adcded407dd145394089f54b5072214b7">More...</a><br /></td></tr>
<tr class="separator:adcded407dd145394089f54b5072214b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a992ae273d45070aa5ada3493ae198f30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a992ae273d45070aa5ada3493ae198f30">setCredential</a> (const <a class="el" href="a00023.html">xmltooling::Credential</a> *credential)</td></tr>
<tr class="memdesc:a992ae273d45070aa5ada3493ae198f30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the current Credential, if any, with a new one.  <a href="#a992ae273d45070aa5ada3493ae198f30">More...</a><br /></td></tr>
<tr class="separator:a992ae273d45070aa5ada3493ae198f30"><td class="memSeparator" colspan="2">&#160;</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:a513bfb3e48832f7f7db515e47e2353f8"><td class="memItemLeft" align="right" valign="top">XSECCryptoKey *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a513bfb3e48832f7f7db515e47e2353f8">m_key</a></td></tr>
<tr class="memdesc:a513bfb3e48832f7f7db515e47e2353f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verification key.  <a href="#a513bfb3e48832f7f7db515e47e2353f8">More...</a><br /></td></tr>
<tr class="separator:a513bfb3e48832f7f7db515e47e2353f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab271e6705a99acc77882c47ae2e982a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00023.html">xmltooling::Credential</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#aab271e6705a99acc77882c47ae2e982a">m_credential</a></td></tr>
<tr class="memdesc:aab271e6705a99acc77882c47ae2e982a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Verification credential.  <a href="#aab271e6705a99acc77882c47ae2e982a">More...</a><br /></td></tr>
<tr class="separator:aab271e6705a99acc77882c47ae2e982a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Validator for signatures based on a Credential. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4fc148c5801891d90d6a795638eb18cb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xmlsignature::SignatureValidator::SignatureValidator </td>
          <td>(</td>
          <td class="paramtype">XSECCryptoKey *&#160;</td>
          <td class="paramname"><em>key</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor using a key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>the key to use </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a43e6384eb13194b0468b3effbae8d1c6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xmlsignature::SignatureValidator::SignatureValidator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00023.html">xmltooling::Credential</a> *&#160;</td>
          <td class="paramname"><em>credential</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor using a Credential. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">credential</td><td>the credential to use </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a992ae273d45070aa5ada3493ae198f30"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xmlsignature::SignatureValidator::setCredential </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00023.html">xmltooling::Credential</a> *&#160;</td>
          <td class="paramname"><em>credential</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Replace the current Credential, if any, with a new one. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">credential</td><td>the Credential to attach </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="adcded407dd145394089f54b5072214b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xmlsignature::SignatureValidator::setKey </td>
          <td>(</td>
          <td class="paramtype">XSECCryptoKey *&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Replace the current key, if any, with a new one. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>the key to attach </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="adf6965d74a6813d3ec8c8a9432816f18"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void xmlsignature::SignatureValidator::validate </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00105.html">xmltooling::XMLObject</a> *&#160;</td>
          <td class="paramname"><em>xmlObject</em></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>Checks to see if an XMLObject is valid. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">xmlObject</td><td>the XMLObject to validate</td></tr>
  </table>
  </dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ValidationException</td><td>thrown if the element is not valid </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="a00099.html#a3489bcbbc5b4dc2e2850e82b28883bfc">xmltooling::Validator</a>.</p>

</div>
</div>
<a class="anchor" id="aada1271ddfe7a1e034a4a3f78d101c71"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void xmlsignature::SignatureValidator::validate </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00075.html">Signature</a> *&#160;</td>
          <td class="paramname"><em>signature</em></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>Type-safe validator. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">signature</td><td>object to validate </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aab271e6705a99acc77882c47ae2e982a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00023.html">xmltooling::Credential</a>* xmlsignature::SignatureValidator::m_credential</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>Verification credential. </p>

</div>
</div>
<a class="anchor" id="a513bfb3e48832f7f7db515e47e2353f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XSECCryptoKey* xmlsignature::SignatureValidator::m_key</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>Verification key. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/signature/<a class="el" href="a00173.html">SignatureValidator.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="a00205.html">xmlsignature</a></li><li class="navelem"><a class="el" href="a00079.html">SignatureValidator</a></li>
    <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>