Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
pyxmlsec / docs / html / xmlsec.KeyInfoCtx-class.html
Size: Mime:
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>xmlsec.KeyInfoCtx</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">

<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <font size="-1"><b class="breadcrumbs">
        <a href="xmlsec-module.html">Module&nbsp;xmlsec</a> ::
        Class&nbsp;KeyInfoCtx
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="xmlsec.KeyInfoCtx-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class KeyInfoCtx</h2>

<hr/>


<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>mngr</span>,
          <span class=summary-sig-arg>_obj</span>)</span></code>
<br />
Creates and initializes &lt;dsig:KeyInfo/&gt; element processing context.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="__setattr__"></a><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>name</span>,
          <span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#copyUserPref" class="summary-sig-name"><code>copyUserPref</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>dst</span>)</span></code>
<br />
Copies user preferences context to dst context.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#createEncCtx" class="summary-sig-name"><code>createEncCtx</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Creates encryption context form processing &lt;enc:EncryptedKey/&gt; child of
&lt;dsig:KeyInfo/&gt; element.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#debugDump" class="summary-sig-name"><code>debugDump</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>output</span>)</span></code>
<br />
Prints user settings and current context state to output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#debugXmlDump" class="summary-sig-name"><code>debugXmlDump</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>output</span>)</span></code>
<br />
Prints user settings and current context state in XML format to output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Destroys the keyInfoCtx object...</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#finalize" class="summary-sig-name"><code>finalize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Cleans up the keyInfoCtx initialized.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#initialize" class="summary-sig-name"><code>initialize</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>mngr</span>)</span></code>
<br />
Initializes &lt;dsig:KeyInfo/&gt; element processing context.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="xmlsec.KeyInfoCtx-class.html#reset" class="summary-sig-name"><code>reset</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Resets the keyInfoCtx state.</td></tr>
</table><br />


<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Method Details</th></tr>
</table>

<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>mngr</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>_obj</span>=<span class=sig-default>None</span>)</span>
    <br /><i>(Constructor)</i>
  </h3>
<pre class="literalblock">
Creates and initializes &lt;dsig:KeyInfo/&gt; element processing context.
Caller is responsible for freeing it by calling destroy method.
mngr    : the keys manager (may be None).
Returns : the newly object or None if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="copyUserPref"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">copyUserPref</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>dst</span>)</span>
  </h3>
<pre class="literalblock">
Copies user preferences context to dst context.
dst     : the destination context object.
Returns : 0 on success and a negative value if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="createEncCtx"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">createEncCtx</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<pre class="literalblock">
Creates encryption context form processing &lt;enc:EncryptedKey/&gt; child of
&lt;dsig:KeyInfo/&gt; element.
Returns : 0 on success and a negative value if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="debugDump"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">debugDump</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>output</span>)</span>
  </h3>
<pre class="literalblock">
Prints user settings and current context state to output.
output : the output file.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="debugXmlDump"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">debugXmlDump</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>output</span>)</span>
  </h3>
<pre class="literalblock">
Prints user settings and current context state in XML format to output.
output : the output file.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="destroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">destroy</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<pre class="literalblock">
Destroys the keyInfoCtx object
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="finalize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">finalize</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<pre class="literalblock">
Cleans up the keyInfoCtx initialized.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="initialize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">initialize</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>mngr</span>=<span class=sig-default>None</span>)</span>
  </h3>
<pre class="literalblock">
Initializes &lt;dsig:KeyInfo/&gt; element processing context. Caller is
responsible for cleaning it up by finalize method.
mngr    : the keys manager (may be None).
Returns : 0 on success and a negative value if an error occurs.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="reset"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">reset</span>(<span class=sig-arg>self</span>)</span>
  </h3>
<pre class="literalblock">
Resets the keyInfoCtx state. User settings are not changed.
</pre>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
  <tr>
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Jan  1 18:42:41 2006</font></td>
    <td align="right"><a href="http://epydoc.sourceforge.net"
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
  </tr>
</table>
</body>
</html>