INamespaceAuthenticationProvider.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0-internal) on Thu Mar 24 15:48:59 EDT 2022 -->
  6. <title>INamespaceAuthenticationProvider</title>
  7. <meta name="date" content="2022-03-24">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="INamespaceAuthenticationProvider";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../../index-all.html">Index</a></li>
  46. <li><a href="../../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider2.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider.html" target="_top">Frames</a></li>
  56. <li><a href="INamespaceAuthenticationProvider.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li>Nested&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li>Constr&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li>Constr&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div role="main" title ="INamespaceAuthenticationProvider" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface INamespaceAuthenticationProvider" class="title" id="Header1">Interface INamespaceAuthenticationProvider</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication">INamespace</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProviderBase</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <span class="typeNameLabel">INamespaceAuthenticationProvider</span>
  109. extends <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProviderBase</a></pre>
  110. <div class="block">Defines the interface to use for implementing an IBM Cognos custom
  111. authentication provider.</div>
  112. </li>
  113. </ul>
  114. </div>
  115. <div class="summary">
  116. <ul class="blockList">
  117. <li class="blockList">
  118. <!-- =========== FIELD SUMMARY =========== -->
  119. <ul class="blockList">
  120. <li class="blockList"><a name="field.summary">
  121. <!-- -->
  122. </a>
  123. <h3>Field Summary</h3>
  124. <ul class="blockList">
  125. <li class="blockList"><a name="fields.inherited.from.class.com.cognos.CAM_AAA.authentication.INamespace">
  126. <!-- -->
  127. </a>
  128. <h3>Fields inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication">INamespace</a></h3>
  129. <code><a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityCaseSensitive">CapabilityCaseSensitive</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityContains">CapabilityContains</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityEndsWith">CapabilityEndsWith</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityEquals">CapabilityEquals</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityNotBrowsable">CapabilityNotBrowsable</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilitySort">CapabilitySort</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#CapabilityStartsWith">CapabilityStartsWith</a></code></li>
  130. </ul>
  131. </li>
  132. </ul>
  133. <!-- ========== METHOD SUMMARY =========== -->
  134. <ul class="blockList">
  135. <li class="blockList"><a name="method.summary">
  136. <!-- -->
  137. </a>
  138. <h3>Method Summary</h3>
  139. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  140. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  141. <tr>
  142. <th class="colFirst" scope="col">Modifier and Type</th>
  143. <th class="colLast" scope="col">Method and Description</th>
  144. </tr>
  145. <tr id="i0" class="altColor">
  146. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a></code></td>
  147. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider.html#logon-com.cognos.CAM_AAA.authentication.IBiBusHeader-">logon</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)</code>
  148. <div class="block">Logs on the user to this authentication namespace.</div>
  149. </td>
  150. </tr>
  151. </table>
  152. <ul class="blockList">
  153. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.INamespaceAuthenticationProviderBase">
  154. <!-- -->
  155. </a>
  156. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProviderBase</a></h3>
  157. <code><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html#logoff-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IBiBusHeader-">logoff</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html#search-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IQuery-">search</a></code></li>
  158. </ul>
  159. <ul class="blockList">
  160. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.INamespace">
  161. <!-- -->
  162. </a>
  163. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication">INamespace</a></h3>
  164. <code><a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#destroy--">destroy</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#getCapabilities--">getCapabilities</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#getNamespaceFormat--">getNamespaceFormat</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#init-com.cognos.CAM_AAA.authentication.INamespaceConfiguration-">init</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html#setNamespaceFormat-java.lang.String-">setNamespaceFormat</a></code></li>
  165. </ul>
  166. <ul class="blockList">
  167. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IUiClass">
  168. <!-- -->
  169. </a>
  170. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></h3>
  171. <code><a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getAvailableDescriptionLocales--">getAvailableDescriptionLocales</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getDescription-java.util.Locale-">getDescription</a></code></li>
  172. </ul>
  173. <ul class="blockList">
  174. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IBaseClass">
  175. <!-- -->
  176. </a>
  177. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a></h3>
  178. <code><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAncestors--">getAncestors</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAvailableNameLocales--">getAvailableNameLocales</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getHasChildren--">getHasChildren</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getName-java.util.Locale-">getName</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getObjectID--">getObjectID</a></code></li>
  179. </ul>
  180. </li>
  181. </ul>
  182. </li>
  183. </ul>
  184. </div>
  185. <div class="details">
  186. <ul class="blockList">
  187. <li class="blockList">
  188. <!-- ============ METHOD DETAIL ========== -->
  189. <ul class="blockList">
  190. <li class="blockList"><a name="method.detail">
  191. <!-- -->
  192. </a>
  193. <h3>Method Detail</h3>
  194. <a name="logon-com.cognos.CAM_AAA.authentication.IBiBusHeader-">
  195. <!-- -->
  196. </a>
  197. <ul class="blockListLast">
  198. <li class="blockList">
  199. <h4>logon</h4>
  200. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a>&nbsp;logon(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)
  201. throws <a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a>,
  202. <a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a>,
  203. <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
  204. <div class="block">Logs on the user to this authentication namespace.</div>
  205. <dl>
  206. <dt><span class="paramLabel">Parameters:</span></dt>
  207. <dd><code>theBiBusHeader</code> - The biBusHeader that contains the information used to authenticate
  208. the user.</dd>
  209. <dt><span class="returnLabel">Returns:</span></dt>
  210. <dd>A visa that grants access to the authentication namespace.</dd>
  211. <dt><span class="throwsLabel">Throws:</span></dt>
  212. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a></code> - Indicates that authentication is not possible
  213. using the available information. It may be possible to
  214. authenticate after interacting with the user.</dd>
  215. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a></code> - Indicates that authentication is not possible
  216. using the available information. It may be possible to
  217. authenticate after interacting with the system.</dd>
  218. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></code> - Indicates that an exception has occurred that interferes with the
  219. normal operation of the namespace.</dd>
  220. </dl>
  221. </li>
  222. </ul>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. </div>
  228. </div>
  229. <!-- ========= END OF CLASS DATA ========= -->
  230. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  231. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  232. <div class="bottomNav"><a name="navbar.bottom">
  233. <!-- -->
  234. </a>
  235. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  236. <a name="navbar.bottom.firstrow">
  237. <!-- -->
  238. </a>
  239. <ul class="navList" title="Navigation">
  240. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  241. <li class="navBarCell1Rev">Class</li>
  242. <li><a href="package-tree.html">Tree</a></li>
  243. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  244. <li><a href="../../../../index-all.html">Index</a></li>
  245. <li><a href="../../../../help-doc.html">Help</a></li>
  246. </ul>
  247. </div>
  248. <div class="subNav">
  249. <ul class="navList">
  250. <li><a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  251. <li><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider2.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  252. </ul>
  253. <ul class="navList">
  254. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider.html" target="_top">Frames</a></li>
  255. <li><a href="INamespaceAuthenticationProvider.html" target="_top">No&nbsp;Frames</a></li>
  256. </ul>
  257. <ul class="navList" id="allclasses_navbar_bottom">
  258. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  259. </ul>
  260. <div>
  261. <script type="text/javascript"><!--
  262. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  263. if(window==top) {
  264. allClassesLink.style.display = "block";
  265. }
  266. else {
  267. allClassesLink.style.display = "none";
  268. }
  269. //-->
  270. </script>
  271. </div>
  272. <div>
  273. <ul class="subNavList">
  274. <li>Summary:&nbsp;</li>
  275. <li>Nested&nbsp;|&nbsp;</li>
  276. <li>Field&nbsp;|&nbsp;</li>
  277. <li>Constr&nbsp;|&nbsp;</li>
  278. <li><a href="#method.summary">Method</a></li>
  279. </ul>
  280. <ul class="subNavList">
  281. <li>Detail:&nbsp;</li>
  282. <li>Field&nbsp;|&nbsp;</li>
  283. <li>Constr&nbsp;|&nbsp;</li>
  284. <li><a href="#method.detail">Method</a></li>
  285. </ul>
  286. </div>
  287. <a name="skip.navbar.bottom">
  288. <!-- -->
  289. </a></div>
  290. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  291. </body>
  292. </html>