Google Git
Sign in
apache / axis-site / fa0d4e6b47a177bc9bae492f8ae4bef6b6563e1f / . / axis2 / c / rampart / api / html / group__oxs__c14n.html
blob: 91ed0529223f9f0b3ce0323840a38ad41818faa1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Rampart/C: C14N</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>C14N<br>
<small>
[<a class="el" href="group__oxs.html">OMXMLSecurity</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="oxs__c14n_8h.html">oxs_c14n.h</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cannonicalization implementation for OMXMLSecurity. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__c14n.html#g16b9264cc86737e346a83bcb0b192043">oxs_c14n_apply_stream_algo</a> (const axutil_env_t *env, const axiom_document_t *doc, axutil_stream_t *stream, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node, const axis2_char_t *algo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__c14n.html#g7f4889c878463dd92df35bafc6e1d6ed">oxs_c14n_apply_algo</a> (const axutil_env_t *env, const axiom_document_t *doc, axis2_char_t **outbuf, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node, const axis2_char_t *algo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__c14n.html#gaad8c0004071c224c50d6a4162e19bb1">oxs_c14n_apply_stream</a> (const axutil_env_t *env, const axiom_document_t *doc, axis2_bool_t comments, axutil_stream_t *stream, const axis2_bool_t exclusive, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__oxs__c14n.html#gf29a49dd9a48994edf4b3f260b6a57fe">oxs_c14n_apply</a> (const axutil_env_t *env, const axiom_document_t *doc, const axis2_bool_t comments, axis2_char_t **outbuf, const axis2_bool_t exclusive, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
XML Canonicalization (XML-C14N). <hr><h2>Function Documentation</h2>
<a class="anchor" name="gf29a49dd9a48994edf4b3f260b6a57fe"></a><!-- doxytag: member="oxs_c14n.h::oxs_c14n_apply" ref="gf29a49dd9a48994edf4b3f260b6a57fe" args="(const axutil_env_t *env, const axiom_document_t *doc, const axis2_bool_t comments, axis2_char_t **outbuf, const axis2_bool_t exclusive, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_c14n_apply </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_document_t *&nbsp;</td>
<td class="paramname"> <em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_bool_t&nbsp;</td>
<td class="paramname"> <em>comments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t **&nbsp;</td>
<td class="paramname"> <em>outbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_bool_t&nbsp;</td>
<td class="paramname"> <em>exclusive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axutil_array_list_t *&nbsp;</td>
<td class="paramname"> <em>ns_prefixes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_node_t *&nbsp;</td>
<td class="paramname"> <em>node</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform given XML-Canonicalization (XML-C14N) method and returns the result as an <pre>axis2_char_t</pre> buffer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>Pointer to the Axis2/C environment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>doc</em>&nbsp;</td><td>Document on which the canonicalization is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td><pre>TRUE</pre> if comments should be included in the output; <pre>FALSE</pre> otherwise. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outbuf</em>&nbsp;</td><td>Output buffer. A new buffer is allocated by the function, should be free'd by the caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ns_prefixes</em>&nbsp;</td><td>List of inclusive namespace prefixes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>exclusive</em>&nbsp;</td><td><pre>TRUE</pre> if exclusive cannonicalization should be used; <pre>FALSE</pre> otherwise. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>Node that defines the subdocument to be canonicalized. When it is <pre>NULL</pre> the whole document will be canonicalized. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g7f4889c878463dd92df35bafc6e1d6ed"></a><!-- doxytag: member="oxs_c14n.h::oxs_c14n_apply_algo" ref="g7f4889c878463dd92df35bafc6e1d6ed" args="(const axutil_env_t *env, const axiom_document_t *doc, axis2_char_t **outbuf, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node, const axis2_char_t *algo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_c14n_apply_algo </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_document_t *&nbsp;</td>
<td class="paramname"> <em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t **&nbsp;</td>
<td class="paramname"> <em>outbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axutil_array_list_t *&nbsp;</td>
<td class="paramname"> <em>ns_prefixes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_node_t *&nbsp;</td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>algo</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform given XML-Canonicalization (XML-C14N) method and returns the result as an <pre>axis2_char_t</pre> buffer.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>Pointer to the Axis2/C environment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>doc</em>&nbsp;</td><td>Document on which the canonicalization is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outbuf</em>&nbsp;</td><td>Output buffer. A new buffer is allocated by the function, should be free'd by the caller. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ns_prefixes</em>&nbsp;</td><td>List of inclusive namespace prefixes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>Node that defines the subdocument to be canonicalized. When it is <pre>NULL</pre> the whole document will be canonicalized. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algo</em>&nbsp;</td><td>Canonicalization method to be used. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gaad8c0004071c224c50d6a4162e19bb1"></a><!-- doxytag: member="oxs_c14n.h::oxs_c14n_apply_stream" ref="gaad8c0004071c224c50d6a4162e19bb1" args="(const axutil_env_t *env, const axiom_document_t *doc, axis2_bool_t comments, axutil_stream_t *stream, const axis2_bool_t exclusive, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_c14n_apply_stream </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_document_t *&nbsp;</td>
<td class="paramname"> <em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_bool_t&nbsp;</td>
<td class="paramname"> <em>comments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axutil_stream_t *&nbsp;</td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_bool_t&nbsp;</td>
<td class="paramname"> <em>exclusive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axutil_array_list_t *&nbsp;</td>
<td class="paramname"> <em>ns_prefixes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_node_t *&nbsp;</td>
<td class="paramname"> <em>node</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform given XML-Canonicalization (XML-C14N) method and returns the result as an <pre>axutil_stream</pre>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>Pointer to the Axis2/C environment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>doc</em>&nbsp;</td><td>Document on which the canonicalization is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td><pre>TRUE</pre> if comments should be included in the output; <pre>FALSE</pre> otherwise. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>Output stream. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ns_prefixes</em>&nbsp;</td><td>List of inclusive namespace prefixes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>exclusive</em>&nbsp;</td><td><pre>TRUE</pre> if exclusive cannonicalization should be used; <pre>FALSE</pre> otherwise. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>Node that defines the subdocument to be canonicalized. When it is <pre>NULL</pre> the whole document will be canonicalized. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g16b9264cc86737e346a83bcb0b192043"></a><!-- doxytag: member="oxs_c14n.h::oxs_c14n_apply_stream_algo" ref="g16b9264cc86737e346a83bcb0b192043" args="(const axutil_env_t *env, const axiom_document_t *doc, axutil_stream_t *stream, const axutil_array_list_t *ns_prefixes, const axiom_node_t *node, const axis2_char_t *algo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_status_t oxs_c14n_apply_stream_algo </td>
<td>(</td>
<td class="paramtype">const axutil_env_t *&nbsp;</td>
<td class="paramname"> <em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_document_t *&nbsp;</td>
<td class="paramname"> <em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axutil_stream_t *&nbsp;</td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axutil_array_list_t *&nbsp;</td>
<td class="paramname"> <em>ns_prefixes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axiom_node_t *&nbsp;</td>
<td class="paramname"> <em>node</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>algo</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform given XML-Canonicalization (XML-C14N) method and returns the result as an <pre>axutil_stream</pre>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>env</em>&nbsp;</td><td>Pointer to the Axis2/C environment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>doc</em>&nbsp;</td><td>Document on which the canonicalization is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>Output stream. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ns_prefixes</em>&nbsp;</td><td>List of inclusive namespace prefixes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>Node that defines the subdocument to be canonicalized. When it is <pre>NULL</pre> the whole document will be canonicalized. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>algo</em>&nbsp;</td><td>Canonicalization method to be used. </td></tr>
</table>
</dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 13 10:52:54 2009 for Rampart/C by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>