Google Git
Sign in
apache / axis-site / fa0d4e6b47a177bc9bae492f8ae4bef6b6563e1f / . / axis2 / c / rampart / api / html / group__rampart__handler__util.html
blob: a7cea172f6f9daf5c7025f7cd86db4039161d22e [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: Handler Utilities</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>Handler Utilities<br>
<small>
[<a class="el" href="group__rampart__utils.html">Rampart Utilities</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axiom_node_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rampart__handler__util.html#g4271bc459b7ab28f660dc6bce26dffe5">rampart_get_security_header</a> (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, axiom_soap_header_t *soap_header)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rampart__handler__util.html#gfda73f87a103c63e82115422339bc2a4">rampart_create_fault_envelope</a> (const axutil_env_t *env, const axis2_char_t *sub_code, const axis2_char_t *reason_text, const axis2_char_t *detail_node_text, axis2_msg_ctx_t *msg_ctx)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rampart__handler__util.html#g1c6ad559cf3d9cb7afa212aa198bf5b6">rampart_get_rampart_configuration</a> (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, axis2_char_t *param_name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">AXIS2_EXTERN axis2_bool_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rampart__handler__util.html#g970b108e184a96a09b15b11769d3422c">rampart_is_rampart_engaged</a> (const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gfda73f87a103c63e82115422339bc2a4"></a><!-- doxytag: member="rampart_handler_util.h::rampart_create_fault_envelope" ref="gfda73f87a103c63e82115422339bc2a4" args="(const axutil_env_t *env, const axis2_char_t *sub_code, const axis2_char_t *reason_text, const axis2_char_t *detail_node_text, axis2_msg_ctx_t *msg_ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN void rampart_create_fault_envelope </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 axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>sub_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>reason_text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>detail_node_text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_msg_ctx_t *&nbsp;</td>
<td class="paramname"> <em>msg_ctx</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>
Creates a SOAP fault based on params described below and store in msg_ctx <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 environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sub_code</em>&nbsp;</td><td>the text of the Subcode element of a SOAP fault message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason_text</em>&nbsp;</td><td>the text in soapenv:Reason element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>detail_node_text</em>&nbsp;</td><td>the text in the soapenv:Detail element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg_ctx</em>&nbsp;</td><td>the msg_ctx </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
</div>
</div><p>
<a class="anchor" name="g1c6ad559cf3d9cb7afa212aa198bf5b6"></a><!-- doxytag: member="rampart_handler_util.h::rampart_get_rampart_configuration" ref="g1c6ad559cf3d9cb7afa212aa198bf5b6" args="(const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, axis2_char_t *param_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN void* rampart_get_rampart_configuration </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">axis2_msg_ctx_t *&nbsp;</td>
<td class="paramname"> <em>msg_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axis2_char_t *&nbsp;</td>
<td class="paramname"> <em>param_name</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>
Get rampart configurations from the message context <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 environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg_ctx</em>&nbsp;</td><td>message context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>param_name</em>&nbsp;</td><td>name of the parameter of the configuration </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the loaded configuration params </dd></dl>
</div>
</div><p>
<a class="anchor" name="g4271bc459b7ab28f660dc6bce26dffe5"></a><!-- doxytag: member="rampart_handler_util.h::rampart_get_security_header" ref="g4271bc459b7ab28f660dc6bce26dffe5" args="(const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, axiom_soap_header_t *soap_header)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axiom_node_t* rampart_get_security_header </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">axis2_msg_ctx_t *&nbsp;</td>
<td class="paramname"> <em>msg_ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">axiom_soap_header_t *&nbsp;</td>
<td class="paramname"> <em>soap_header</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>
Get the security header from the header block <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 environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg_ctx</em>&nbsp;</td><td>message context </td></tr>
<tr><td valign="top"></td><td valign="top"><em>soap_header</em>&nbsp;</td><td>header block </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>security soap header node </dd></dl>
</div>
</div><p>
<a class="anchor" name="g970b108e184a96a09b15b11769d3422c"></a><!-- doxytag: member="rampart_handler_util.h::rampart_is_rampart_engaged" ref="g970b108e184a96a09b15b11769d3422c" args="(const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AXIS2_EXTERN axis2_bool_t rampart_is_rampart_engaged </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">axis2_msg_ctx_t *&nbsp;</td>
<td class="paramname"> <em>msg_ctx</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>
Check wether rampart is engaged or not <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 environment struct </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg_ctx</em>&nbsp;</td><td>message context </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>if engaged returns AXIS2_TRUE, else returns AXIS2_FALSE </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 13 10:52:55 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>