ICredential.html 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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:58 EDT 2022 -->
  6. <title>ICredential</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="ICredential";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":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/IBoundingSetProvider.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/IDisplayObject.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/ICredential.html" target="_top">Frames</a></li>
  56. <li><a href="ICredential.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 ="ICredential" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface ICredential" class="title" id="Header1">Interface ICredential</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <hr>
  103. <br>
  104. <pre>public interface <span class="typeNameLabel">ICredential</span></pre>
  105. <div class="block">Defines the interface to use for implementing an IBM Cognos credential.
  106. A credential is a set of name-value pairs that represent authentication
  107. information, such as a username or password. A credential is transient,
  108. and can be used to provide single signon to a database that is sharing
  109. the same credentials as the current security infrastructure.</div>
  110. </li>
  111. </ul>
  112. </div>
  113. <div class="summary">
  114. <ul class="blockList">
  115. <li class="blockList">
  116. <!-- ========== METHOD SUMMARY =========== -->
  117. <ul class="blockList">
  118. <li class="blockList"><a name="method.summary">
  119. <!-- -->
  120. </a>
  121. <h3>Method Summary</h3>
  122. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  123. <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>
  124. <tr>
  125. <th class="colFirst" scope="col">Modifier and Type</th>
  126. <th class="colLast" scope="col">Method and Description</th>
  127. </tr>
  128. <tr id="i0" class="altColor">
  129. <td class="colFirst"><code>java.lang.String[]</code></td>
  130. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/ICredential.html#getCredentialNames--">getCredentialNames</a></span>()</code>
  131. <div class="block">Returns the name portion of the name-value pairs within this credential.</div>
  132. </td>
  133. </tr>
  134. <tr id="i1" class="rowColor">
  135. <td class="colFirst"><code>java.lang.String[]</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/ICredential.html#getCredentialValue-java.lang.String-">getCredentialValue</a></span>(java.lang.String&nbsp;theName)</code>
  137. <div class="block">Return the corresponding value for the specified name portion of a
  138. name-value pair in this credential.</div>
  139. </td>
  140. </tr>
  141. </table>
  142. </li>
  143. </ul>
  144. </li>
  145. </ul>
  146. </div>
  147. <div class="details">
  148. <ul class="blockList">
  149. <li class="blockList">
  150. <!-- ============ METHOD DETAIL ========== -->
  151. <ul class="blockList">
  152. <li class="blockList"><a name="method.detail">
  153. <!-- -->
  154. </a>
  155. <h3>Method Detail</h3>
  156. <a name="getCredentialNames--">
  157. <!-- -->
  158. </a>
  159. <ul class="blockList">
  160. <li class="blockList">
  161. <h4>getCredentialNames</h4>
  162. <pre>java.lang.String[]&nbsp;getCredentialNames()</pre>
  163. <div class="block">Returns the name portion of the name-value pairs within this credential.
  164. Returns null if none exists.</div>
  165. <dl>
  166. <dt><span class="returnLabel">Returns:</span></dt>
  167. <dd>An array containing the name portion of all name-value pairs
  168. in this credential.</dd>
  169. </dl>
  170. </li>
  171. </ul>
  172. <a name="getCredentialValue-java.lang.String-">
  173. <!-- -->
  174. </a>
  175. <ul class="blockListLast">
  176. <li class="blockList">
  177. <h4>getCredentialValue</h4>
  178. <pre>java.lang.String[]&nbsp;getCredentialValue(java.lang.String&nbsp;theName)</pre>
  179. <div class="block">Return the corresponding value for the specified name portion of a
  180. name-value pair in this credential.
  181. Returns null if no value exists.</div>
  182. <dl>
  183. <dt><span class="paramLabel">Parameters:</span></dt>
  184. <dd><code>theName</code> - The name portion of the required name-value pair.</dd>
  185. <dt><span class="returnLabel">Returns:</span></dt>
  186. <dd>An array containing all the values for the specified name.</dd>
  187. </dl>
  188. </li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </li>
  193. </ul>
  194. </div>
  195. </div>
  196. <!-- ========= END OF CLASS DATA ========= -->
  197. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  198. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  199. <div class="bottomNav"><a name="navbar.bottom">
  200. <!-- -->
  201. </a>
  202. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  203. <a name="navbar.bottom.firstrow">
  204. <!-- -->
  205. </a>
  206. <ul class="navList" title="Navigation">
  207. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  208. <li class="navBarCell1Rev">Class</li>
  209. <li><a href="package-tree.html">Tree</a></li>
  210. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  211. <li><a href="../../../../index-all.html">Index</a></li>
  212. <li><a href="../../../../help-doc.html">Help</a></li>
  213. </ul>
  214. </div>
  215. <div class="subNav">
  216. <ul class="navList">
  217. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IBoundingSetProvider.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  218. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  219. </ul>
  220. <ul class="navList">
  221. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/ICredential.html" target="_top">Frames</a></li>
  222. <li><a href="ICredential.html" target="_top">No&nbsp;Frames</a></li>
  223. </ul>
  224. <ul class="navList" id="allclasses_navbar_bottom">
  225. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  226. </ul>
  227. <div>
  228. <script type="text/javascript"><!--
  229. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  230. if(window==top) {
  231. allClassesLink.style.display = "block";
  232. }
  233. else {
  234. allClassesLink.style.display = "none";
  235. }
  236. //-->
  237. </script>
  238. </div>
  239. <div>
  240. <ul class="subNavList">
  241. <li>Summary:&nbsp;</li>
  242. <li>Nested&nbsp;|&nbsp;</li>
  243. <li>Field&nbsp;|&nbsp;</li>
  244. <li>Constr&nbsp;|&nbsp;</li>
  245. <li><a href="#method.summary">Method</a></li>
  246. </ul>
  247. <ul class="subNavList">
  248. <li>Detail:&nbsp;</li>
  249. <li>Field&nbsp;|&nbsp;</li>
  250. <li>Constr&nbsp;|&nbsp;</li>
  251. <li><a href="#method.detail">Method</a></li>
  252. </ul>
  253. </div>
  254. <a name="skip.navbar.bottom">
  255. <!-- -->
  256. </a></div>
  257. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  258. </body>
  259. </html>