PageRenderTime 29ms CodeModel.GetById 9ms RepoModel.GetById 0ms app.codeStats 0ms

/wso2-wsf-cpp-src-2.1.0/docs/api/html/classwso2wsf_1_1AuthenticationProvider.html

#
HTML | 301 lines | 287 code | 13 blank | 1 comment | 0 complexity | a039d66f26491dd4fc878c9b6705d193 MD5 | raw file
Possible License(s): Apache-2.0, GPL-3.0, MPL-2.0-no-copyleft-exception, BSD-3-Clause, CPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    3. 

  3. <title>WSF/CPP: wso2wsf::AuthenticationProvider Class Reference</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.7.1 -->
    8. 

  8. <div class="navigation" id="top">
    9. 

  9.   <div class="tabs">
    10. 

  10.     <ul>
    11. 

  11.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    12. 

  12.       <li><a href="modules.html"><span>Modules</span></a></li>
    13. 

  13.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    14. 

  14.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    15. 

  15.       <li><a href="files.html"><span>Files</span></a></li>
    16. 

  16.       <li><a href="dirs.html"><span>Directories</span></a></li>
    17. 

  17.     <li>
    18. 

  18.       <form action="search.php" method="get">
    19. 

  19.         <table cellspacing="0" cellpadding="0" border="0">
    20. 

  20.           <tr>
    21. 

  21.             <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
    22. 

  22.             <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
    23. 

  23.           </tr>
    24. 

  24.         </table>
    25. 

  25.       </form>
    26. 

  26.     </li>
    27. 

  27.     </ul>
    28. 

  28.   </div>
    29. 

  29.   <div class="tabs">
    30. 

  30.     <ul>
    31. 

  31.       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    32. 

  32.       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    33. 

  33.       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    34. 

  34.     </ul>
    35. 

  35.   </div>
    36. 

  36.   <div class="navpath"><a class="el" href="namespacewso2wsf.html">wso2wsf</a>::<a class="el" href="classwso2wsf_1_1AuthenticationProvider.html">AuthenticationProvider</a>
    37. 

  37.   </div>
    38. 

  38. </div>
    39. 

  39. <div class="contents">
    40. 

  40. <h1>wso2wsf::AuthenticationProvider Class Reference<br>
    41. 

  41. <small>
    42. 

  42. [<a class="el" href="group__AuthenticationProvider.html">AuthenticationProvider</a>]</small>
    43. 

  43. </h1><!-- doxytag: class="wso2wsf::AuthenticationProvider" -->class <a class="el" href="classwso2wsf_1_1AuthenticationProvider.html" title="class AuthenticationProvider Represents an interface needed implement any user specific...">AuthenticationProvider</a> Represents an interface needed implement any user specific authentication module. Extend from this class and implement the abstract methods defined here to implement a authentication provider.  
    44. 

  44. <a href="#_details">More...</a>
    45. 

  45. <p>
    46. 

  46. <code>#include &lt;<a class="el" href="AuthenticationProvider_8h-source.html">AuthenticationProvider.h</a>&gt;</code>
    47. 

  47. <p>
    48. 

  48. 

  49. <p>
    50. 

  50. <a href="classwso2wsf_1_1AuthenticationProvider-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
    51. 

  51. <tr><td></td></tr>
    52. 

  52. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    53. 

  53. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1AuthenticationProvider.html#c830e7491cdc44e20749a9362d7fd078">checkPassword</a> (std::string &amp;username, std::string &amp;password, <a class="el" href="classwso2wsf_1_1MessageContext.html">MessageContext</a> *msgctx)=0</td></tr>
    54. 

  54. 

  55. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1AuthenticationProvider.html#a14bf6e8363087ba0b4a6863283f582f">checkDigestPassword</a> (std::string &amp;username, std::string &amp;nonce, std::string &amp;created, std::string &amp;digest, <a class="el" href="classwso2wsf_1_1MessageContext.html">MessageContext</a> *msgctx)=0</td></tr>
    56. 

  56. 

  57. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual WSF_EXTERN&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1AuthenticationProvider.html#0d9dada0b078bc3763ab77921865ca85">~AuthenticationProvider</a> ()</td></tr>
    58. 

  58. 

  59. <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
    60. 

  60. <tr><td class="memItemLeft" nowrap align="right" valign="top">static WSF_EXTERN <br class="typebreak">
    61. 

  61. rampart_authn_provider_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1AuthenticationProvider.html#9053974d3b4faa901dfd59e6b341070d">callbackPasswordPlain</a> (rampart_authn_provider_t *authn_provider, const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *password)</td></tr>
    62. 

  62. 

  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">static WSF_EXTERN <br class="typebreak">
    64. 

  64. rampart_authn_provider_status_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwso2wsf_1_1AuthenticationProvider.html#98743b4cb6619b4359c8c42a1523ffd5">callbackPasswordDigest</a> (rampart_authn_provider_t *authn_provider, const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *nonce, const axis2_char_t *created, const char *digest)</td></tr>
    65. 

  65. 

  66. </table>
    67. 

  67. <hr><a name="_details"></a><h2>Detailed Description</h2>
    68. 

  68. class <a class="el" href="classwso2wsf_1_1AuthenticationProvider.html" title="class AuthenticationProvider Represents an interface needed implement any user specific...">AuthenticationProvider</a> Represents an interface needed implement any user specific authentication module. Extend from this class and implement the abstract methods defined here to implement a authentication provider. <hr><h2>Constructor &amp; Destructor Documentation</h2>
    69. 

  69. <a class="anchor" name="0d9dada0b078bc3763ab77921865ca85"></a><!-- doxytag: member="wso2wsf::AuthenticationProvider::~AuthenticationProvider" ref="0d9dada0b078bc3763ab77921865ca85" args="()" -->
    70. 

  70. <div class="memitem">
    71. 

  71. <div class="memproto">
    72. 

  72.       <table class="memname">
    73. 

  73.         <tr>
    74. 

  74.           <td class="memname">virtual WSF_EXTERN wso2wsf::AuthenticationProvider::~AuthenticationProvider           </td>
    75. 

  75.           <td>(</td>
    76. 

  76.           <td class="paramname">          </td>
    77. 

  77.           <td>&nbsp;)&nbsp;</td>
    78. 

  78.           <td><code> [virtual]</code></td>
    79. 

  79.         </tr>
    80. 

  80.       </table>
    81. 

  81. </div>
    82. 

  82. <div class="memdoc">
    83. 

  83. 

  84. <p>
    85. 

  85. destructor that can be overridden. 
    86. 

  86. </div>
    87. 

  87. </div><p>
    88. 

  88. <hr><h2>Member Function Documentation</h2>
    89. 

  89. <a class="anchor" name="98743b4cb6619b4359c8c42a1523ffd5"></a><!-- doxytag: member="wso2wsf::AuthenticationProvider::callbackPasswordDigest" ref="98743b4cb6619b4359c8c42a1523ffd5" args="(rampart_authn_provider_t *authn_provider, const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *nonce, const axis2_char_t *created, const char *digest)" -->
    90. 

  90. <div class="memitem">
    91. 

  91. <div class="memproto">
    92. 

  92.       <table class="memname">
    93. 

  93.         <tr>
    94. 

  94.           <td class="memname">static WSF_EXTERN rampart_authn_provider_status_t wso2wsf::AuthenticationProvider::callbackPasswordDigest           </td>
    95. 

  95.           <td>(</td>
    96. 

  96.           <td class="paramtype">rampart_authn_provider_t *&nbsp;</td>
    97. 

  97.           <td class="paramname"> <em>authn_provider</em>, </td>
    98. 

  98.         </tr>
    99. 

  99.         <tr>
    100. 

  100.           <td class="paramkey"></td>
    101. 

  101.           <td></td>
    102. 

  102.           <td class="paramtype">const axutil_env_t *&nbsp;</td>
    103. 

  103.           <td class="paramname"> <em>env</em>, </td>
    104. 

  104.         </tr>
    105. 

  105.         <tr>
    106. 

  106.           <td class="paramkey"></td>
    107. 

  107.           <td></td>
    108. 

  108.           <td class="paramtype">axis2_msg_ctx_t *&nbsp;</td>
    109. 

  109.           <td class="paramname"> <em>msg_ctx</em>, </td>
    110. 

  110.         </tr>
    111. 

  111.         <tr>
    112. 

  112.           <td class="paramkey"></td>
    113. 

  113.           <td></td>
    114. 

  114.           <td class="paramtype">const axis2_char_t *&nbsp;</td>
    115. 

  115.           <td class="paramname"> <em>username</em>, </td>
    116. 

  116.         </tr>
    117. 

  117.         <tr>
    118. 

  118.           <td class="paramkey"></td>
    119. 

  119.           <td></td>
    120. 

  120.           <td class="paramtype">const axis2_char_t *&nbsp;</td>
    121. 

  121.           <td class="paramname"> <em>nonce</em>, </td>
    122. 

  122.         </tr>
    123. 

  123.         <tr>
    124. 

  124.           <td class="paramkey"></td>
    125. 

  125.           <td></td>
    126. 

  126.           <td class="paramtype">const axis2_char_t *&nbsp;</td>
    127. 

  127.           <td class="paramname"> <em>created</em>, </td>
    128. 

  128.         </tr>
    129. 

  129.         <tr>
    130. 

  130.           <td class="paramkey"></td>
    131. 

  131.           <td></td>
    132. 

  132.           <td class="paramtype">const char *&nbsp;</td>
    133. 

  133.           <td class="paramname"> <em>digest</em></td><td>&nbsp;</td>
    134. 

  134.         </tr>
    135. 

  135.         <tr>
    136. 

  136.           <td></td>
    137. 

  137.           <td>)</td>
    138. 

  138.           <td></td><td></td><td><code> [static]</code></td>
    139. 

  139.         </tr>
    140. 

  140.       </table>
    141. 

  141. </div>
    142. 

  142. <div class="memdoc">
    143. 

  143. 

  144. <p>
    145. 

  145. Static Handler to be invoked to check digest password 
    146. 

  146. </div>
    147. 

  147. </div><p>
    148. 

  148. <a class="anchor" name="9053974d3b4faa901dfd59e6b341070d"></a><!-- doxytag: member="wso2wsf::AuthenticationProvider::callbackPasswordPlain" ref="9053974d3b4faa901dfd59e6b341070d" args="(rampart_authn_provider_t *authn_provider, const axutil_env_t *env, axis2_msg_ctx_t *msg_ctx, const axis2_char_t *username, const axis2_char_t *password)" -->
    149. 

  149. <div class="memitem">
    150. 

  150. <div class="memproto">
    151. 

  151.       <table class="memname">
    152. 

  152.         <tr>
    153. 

  153.           <td class="memname">static WSF_EXTERN rampart_authn_provider_status_t wso2wsf::AuthenticationProvider::callbackPasswordPlain           </td>
    154. 

  154.           <td>(</td>
    155. 

  155.           <td class="paramtype">rampart_authn_provider_t *&nbsp;</td>
    156. 

  156.           <td class="paramname"> <em>authn_provider</em>, </td>
    157. 

  157.         </tr>
    158. 

  158.         <tr>
    159. 

  159.           <td class="paramkey"></td>
    160. 

  160.           <td></td>
    161. 

  161.           <td class="paramtype">const axutil_env_t *&nbsp;</td>
    162. 

  162.           <td class="paramname"> <em>env</em>, </td>
    163. 

  163.         </tr>
    164. 

  164.         <tr>
    165. 

  165.           <td class="paramkey"></td>
    166. 

  166.           <td></td>
    167. 

  167.           <td class="paramtype">axis2_msg_ctx_t *&nbsp;</td>
    168. 

  168.           <td class="paramname"> <em>msg_ctx</em>, </td>
    169. 

  169.         </tr>
    170. 

  170.         <tr>
    171. 

  171.           <td class="paramkey"></td>
    172. 

  172.           <td></td>
    173. 

  173.           <td class="paramtype">const axis2_char_t *&nbsp;</td>
    174. 

  174.           <td class="paramname"> <em>username</em>, </td>
    175. 

  175.         </tr>
    176. 

  176.         <tr>
    177. 

  177.           <td class="paramkey"></td>
    178. 

  178.           <td></td>
    179. 

  179.           <td class="paramtype">const axis2_char_t *&nbsp;</td>
    180. 

  180.           <td class="paramname"> <em>password</em></td><td>&nbsp;</td>
    181. 

  181.         </tr>
    182. 

  182.         <tr>
    183. 

  183.           <td></td>
    184. 

  184.           <td>)</td>
    185. 

  185.           <td></td><td></td><td><code> [static]</code></td>
    186. 

  186.         </tr>
    187. 

  187.       </table>
    188. 

  188. </div>
    189. 

  189. <div class="memdoc">
    190. 

  190. 

  191. <p>
    192. 

  192. Static Handler to be invoked to check plain password 
    193. 

  193. </div>
    194. 

  194. </div><p>
    195. 

  195. <a class="anchor" name="a14bf6e8363087ba0b4a6863283f582f"></a><!-- doxytag: member="wso2wsf::AuthenticationProvider::checkDigestPassword" ref="a14bf6e8363087ba0b4a6863283f582f" args="(std::string &amp;username, std::string &amp;nonce, std::string &amp;created, std::string &amp;digest, MessageContext *msgctx)=0" -->
    196. 

  196. <div class="memitem">
    197. 

  197. <div class="memproto">
    198. 

  198.       <table class="memname">
    199. 

  199.         <tr>
    200. 

  200.           <td class="memname">virtual bool wso2wsf::AuthenticationProvider::checkDigestPassword           </td>
    201. 

  201.           <td>(</td>
    202. 

  202.           <td class="paramtype">std::string &amp;&nbsp;</td>
    203. 

  203.           <td class="paramname"> <em>username</em>, </td>
    204. 

  204.         </tr>
    205. 

  205.         <tr>
    206. 

  206.           <td class="paramkey"></td>
    207. 

  207.           <td></td>
    208. 

  208.           <td class="paramtype">std::string &amp;&nbsp;</td>
    209. 

  209.           <td class="paramname"> <em>nonce</em>, </td>
    210. 

  210.         </tr>
    211. 

  211.         <tr>
    212. 

  212.           <td class="paramkey"></td>
    213. 

  213.           <td></td>
    214. 

  214.           <td class="paramtype">std::string &amp;&nbsp;</td>
    215. 

  215.           <td class="paramname"> <em>created</em>, </td>
    216. 

  216.         </tr>
    217. 

  217.         <tr>
    218. 

  218.           <td class="paramkey"></td>
    219. 

  219.           <td></td>
    220. 

  220.           <td class="paramtype">std::string &amp;&nbsp;</td>
    221. 

  221.           <td class="paramname"> <em>digest</em>, </td>
    222. 

  222.         </tr>
    223. 

  223.         <tr>
    224. 

  224.           <td class="paramkey"></td>
    225. 

  225.           <td></td>
    226. 

  226.           <td class="paramtype"><a class="el" href="classwso2wsf_1_1MessageContext.html">MessageContext</a> *&nbsp;</td>
    227. 

  227.           <td class="paramname"> <em>msgctx</em></td><td>&nbsp;</td>
    228. 

  228.         </tr>
    229. 

  229.         <tr>
    230. 

  230.           <td></td>
    231. 

  231.           <td>)</td>
    232. 

  232.           <td></td><td></td><td><code> [pure virtual]</code></td>
    233. 

  233.         </tr>
    234. 

  234.       </table>
    235. 

  235. </div>
    236. 

  236. <div class="memdoc">
    237. 

  237. 

  238. <p>
    239. 

  239. Handler to be invoked to check digest password <dl compact><dt><b>Parameters:</b></dt><dd>
    240. 

  240.   <table border="0" cellspacing="2" cellpadding="0">
    241. 

  241.     <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>Username </td></tr>
    242. 

  242.     <tr><td valign="top"></td><td valign="top"><em>nonce</em>&nbsp;</td><td>nonce value </td></tr>
    243. 

  243.     <tr><td valign="top"></td><td valign="top"><em>created</em>&nbsp;</td><td>created time </td></tr>
    244. 

  244.     <tr><td valign="top"></td><td valign="top"><em>digest</em>&nbsp;</td><td>digest value </td></tr>
    245. 

  245.     <tr><td valign="top"></td><td valign="top"><em>msgctx</em>&nbsp;</td><td>pointer to message context </td></tr>
    246. 

  246.   </table>
    247. 

  247. </dl>
    248. 

  248. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if successful, false otherwise </dd></dl>
    249. 

  249. 

  250. </div>
    251. 

  251. </div><p>
    252. 

  252. <a class="anchor" name="c830e7491cdc44e20749a9362d7fd078"></a><!-- doxytag: member="wso2wsf::AuthenticationProvider::checkPassword" ref="c830e7491cdc44e20749a9362d7fd078" args="(std::string &amp;username, std::string &amp;password, MessageContext *msgctx)=0" -->
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">virtual bool wso2wsf::AuthenticationProvider::checkPassword           </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramtype">std::string &amp;&nbsp;</td>
    260. 

  260.           <td class="paramname"> <em>username</em>, </td>
    261. 

  261.         </tr>
    262. 

  262.         <tr>
    263. 

  263.           <td class="paramkey"></td>
    264. 

  264.           <td></td>
    265. 

  265.           <td class="paramtype">std::string &amp;&nbsp;</td>
    266. 

  266.           <td class="paramname"> <em>password</em>, </td>
    267. 

  267.         </tr>
    268. 

  268.         <tr>
    269. 

  269.           <td class="paramkey"></td>
    270. 

  270.           <td></td>
    271. 

  271.           <td class="paramtype"><a class="el" href="classwso2wsf_1_1MessageContext.html">MessageContext</a> *&nbsp;</td>
    272. 

  272.           <td class="paramname"> <em>msgctx</em></td><td>&nbsp;</td>
    273. 

  273.         </tr>
    274. 

  274.         <tr>
    275. 

  275.           <td></td>
    276. 

  276.           <td>)</td>
    277. 

  277.           <td></td><td></td><td><code> [pure virtual]</code></td>
    278. 

  278.         </tr>
    279. 

  279.       </table>
    280. 

  280. </div>
    281. 

  281. <div class="memdoc">
    282. 

  282. 

  283. <p>
    284. 

  284. Handler to be invoked to check plain password <dl compact><dt><b>Parameters:</b></dt><dd>
    285. 

  285.   <table border="0" cellspacing="2" cellpadding="0">
    286. 

  286.     <tr><td valign="top"></td><td valign="top"><em>username</em>&nbsp;</td><td>username </td></tr>
    287. 

  287.     <tr><td valign="top"></td><td valign="top"><em>password</em>&nbsp;</td><td>password </td></tr>
    288. 

  288.   </table>
    289. 

  289. </dl>
    290. 

  290. <dl class="return" compact><dt><b>Returns:</b></dt><dd>msgctx pointer to message context </dd></dl>
    291. 

  291. 

  292. </div>
    293. 

  293. </div><p>
    294. 

  294. <hr>The documentation for this class was generated from the following file:<ul>
    295. 

  295. <li><a class="el" href="AuthenticationProvider_8h-source.html">AuthenticationProvider.h</a></ul>
    296. 

  296. </div>
    297. 

  297. <hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 14 00:43:25 2009 for WSF/CPP by&nbsp;
    298. 

  298. <a href="http://www.doxygen.org/index.html">
    299. 

  299. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
    300. 

  300. </body>
    301. 

  301. </html>
    302. 

  302.