SystemRecoverableException.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402
  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:49:01 EDT 2022 -->
  6. <title>SystemRecoverableException</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="SystemRecoverableException";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/SingleSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html" title="class 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/SystemRecoverableException.html" target="_top">Frames</a></li>
  56. <li><a href="SystemRecoverableException.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 ="SystemRecoverableException" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Class SystemRecoverableException" class="title" id="Header1">Class SystemRecoverableException</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>java.lang.Throwable</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>java.lang.Exception</li>
  107. <li>
  108. <ul class="inheritance">
  109. <li><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">com.cognos.CAM_AAA.authentication.UnrecoverableException</a></li>
  110. <li>
  111. <ul class="inheritance">
  112. <li>com.cognos.CAM_AAA.authentication.SystemRecoverableException</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. </ul>
  120. </li>
  121. </ul>
  122. <div class="description">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <dl>
  126. <dt>All Implemented Interfaces:</dt>
  127. <dd>java.io.Serializable</dd>
  128. </dl>
  129. <hr>
  130. <br>
  131. <pre>public class <span class="typeNameLabel">SystemRecoverableException</span>
  132. extends <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
  133. <div class="block">Indicates that the authentication failed but recovery is
  134. possible following interaction with the system.</div>
  135. <dl>
  136. <dt><span class="seeLabel">See Also:</span></dt>
  137. <dd><a href="../../../../serialized-form.html#com.cognos.CAM_AAA.authentication.SystemRecoverableException">Serialized Form</a></dd>
  138. </dl>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="constructor.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Constructor Summary</h3>
  151. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  152. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colOne" scope="col">Constructor and Description</th>
  155. </tr>
  156. <tr class="altColor">
  157. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html#SystemRecoverableException-java.lang.String-byte:A-">SystemRecoverableException</a></span>(java.lang.String&nbsp;theMessage,
  158. byte[]&nbsp;theSecurityContext)</code>
  159. <div class="block">Creates a system recoverable exception with a Kerberos authentication
  160. token.</div>
  161. </td>
  162. </tr>
  163. <tr class="rowColor">
  164. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html#SystemRecoverableException-java.lang.String-java.lang.String-">SystemRecoverableException</a></span>(java.lang.String&nbsp;theMessage,
  165. java.lang.String&nbsp;theRequestedVars)</code>
  166. <div class="block">Creates a system recoverable exception to request a single trusted
  167. environment variable.</div>
  168. </td>
  169. </tr>
  170. <tr class="altColor">
  171. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html#SystemRecoverableException-java.lang.String-java.lang.String:A-">SystemRecoverableException</a></span>(java.lang.String&nbsp;theMessage,
  172. java.lang.String[]&nbsp;theRequestedVars)</code>
  173. <div class="block">Creates a system recoverable exception to request multiple trusted
  174. environment variables.</div>
  175. </td>
  176. </tr>
  177. </table>
  178. </li>
  179. </ul>
  180. <!-- ========== METHOD SUMMARY =========== -->
  181. <ul class="blockList">
  182. <li class="blockList"><a name="method.summary">
  183. <!-- -->
  184. </a>
  185. <h3>Method Summary</h3>
  186. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  187. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  188. <tr>
  189. <th class="colFirst" scope="col">Modifier and Type</th>
  190. <th class="colLast" scope="col">Method and Description</th>
  191. </tr>
  192. <tr id="i0" class="altColor">
  193. <td class="colFirst"><code>java.lang.String[]</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html#getRequestedVars--">getRequestedVars</a></span>()</code>
  195. <div class="block">Returns all the names of the environment variables being requested or
  196. null if none is being requested.</div>
  197. </td>
  198. </tr>
  199. <tr id="i1" class="rowColor">
  200. <td class="colFirst"><code>byte[]</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html#getSecurityContext--">getSecurityContext</a></span>()</code>
  202. <div class="block">Returns the Kerberos token that is being trasmitted with this exception
  203. or null if none is being sent.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. <ul class="blockList">
  208. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.UnrecoverableException">
  209. <!-- -->
  210. </a>
  211. <h3>Methods inherited from class&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></h3>
  212. <code><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addCaption-java.lang.String-">addCaption</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessage-java.lang.String-">addMessage</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessageOnTop-java.lang.String-">addMessageOnTop</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getCaptions--">getCaptions</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getMessages--">getMessages</a></code></li>
  213. </ul>
  214. <ul class="blockList">
  215. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
  216. <!-- -->
  217. </a>
  218. <h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
  219. <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
  220. </ul>
  221. <ul class="blockList">
  222. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  223. <!-- -->
  224. </a>
  225. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  226. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  227. </ul>
  228. </li>
  229. </ul>
  230. </li>
  231. </ul>
  232. </div>
  233. <div class="details">
  234. <ul class="blockList">
  235. <li class="blockList">
  236. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  237. <ul class="blockList">
  238. <li class="blockList"><a name="constructor.detail">
  239. <!-- -->
  240. </a>
  241. <h3>Constructor Detail</h3>
  242. <a name="SystemRecoverableException-java.lang.String-byte:A-">
  243. <!-- -->
  244. </a>
  245. <ul class="blockList">
  246. <li class="blockList">
  247. <h4>SystemRecoverableException</h4>
  248. <pre>public&nbsp;SystemRecoverableException(java.lang.String&nbsp;theMessage,
  249. byte[]&nbsp;theSecurityContext)</pre>
  250. <div class="block">Creates a system recoverable exception with a Kerberos authentication
  251. token.</div>
  252. <dl>
  253. <dt><span class="paramLabel">Parameters:</span></dt>
  254. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  255. <dd><code>theSecurityContext</code> - The Kerberos token to send to the other party.</dd>
  256. </dl>
  257. </li>
  258. </ul>
  259. <a name="SystemRecoverableException-java.lang.String-java.lang.String:A-">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>SystemRecoverableException</h4>
  265. <pre>public&nbsp;SystemRecoverableException(java.lang.String&nbsp;theMessage,
  266. java.lang.String[]&nbsp;theRequestedVars)</pre>
  267. <div class="block">Creates a system recoverable exception to request multiple trusted
  268. environment variables.</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  272. <dd><code>theRequestedVars</code> - An array containing the name of each environment variable
  273. being requested.</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. <a name="SystemRecoverableException-java.lang.String-java.lang.String-">
  278. <!-- -->
  279. </a>
  280. <ul class="blockListLast">
  281. <li class="blockList">
  282. <h4>SystemRecoverableException</h4>
  283. <pre>public&nbsp;SystemRecoverableException(java.lang.String&nbsp;theMessage,
  284. java.lang.String&nbsp;theRequestedVars)</pre>
  285. <div class="block">Creates a system recoverable exception to request a single trusted
  286. environment variable.</div>
  287. <dl>
  288. <dt><span class="paramLabel">Parameters:</span></dt>
  289. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  290. <dd><code>theRequestedVars</code> - The name of the environment variable being requested.</dd>
  291. </dl>
  292. </li>
  293. </ul>
  294. </li>
  295. </ul>
  296. <!-- ============ METHOD DETAIL ========== -->
  297. <ul class="blockList">
  298. <li class="blockList"><a name="method.detail">
  299. <!-- -->
  300. </a>
  301. <h3>Method Detail</h3>
  302. <a name="getRequestedVars--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>getRequestedVars</h4>
  308. <pre>public&nbsp;java.lang.String[]&nbsp;getRequestedVars()</pre>
  309. <div class="block">Returns all the names of the environment variables being requested or
  310. null if none is being requested.</div>
  311. <dl>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>An array containing the name of each environment variable being
  314. requested.</dd>
  315. </dl>
  316. </li>
  317. </ul>
  318. <a name="getSecurityContext--">
  319. <!-- -->
  320. </a>
  321. <ul class="blockListLast">
  322. <li class="blockList">
  323. <h4>getSecurityContext</h4>
  324. <pre>public&nbsp;byte[]&nbsp;getSecurityContext()</pre>
  325. <div class="block">Returns the Kerberos token that is being trasmitted with this exception
  326. or null if none is being sent.</div>
  327. <dl>
  328. <dt><span class="returnLabel">Returns:</span></dt>
  329. <dd>The Kerberos token being transmitted with this exception.</dd>
  330. </dl>
  331. </li>
  332. </ul>
  333. </li>
  334. </ul>
  335. </li>
  336. </ul>
  337. </div>
  338. </div>
  339. <!-- ========= END OF CLASS DATA ========= -->
  340. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  341. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  342. <div class="bottomNav"><a name="navbar.bottom">
  343. <!-- -->
  344. </a>
  345. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  346. <a name="navbar.bottom.firstrow">
  347. <!-- -->
  348. </a>
  349. <ul class="navList" title="Navigation">
  350. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  351. <li class="navBarCell1Rev">Class</li>
  352. <li><a href="package-tree.html">Tree</a></li>
  353. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  354. <li><a href="../../../../index-all.html">Index</a></li>
  355. <li><a href="../../../../help-doc.html">Help</a></li>
  356. </ul>
  357. </div>
  358. <div class="subNav">
  359. <ul class="navList">
  360. <li><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  361. <li><a href="../../../../com/cognos/CAM_AAA/authentication/TextDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  362. </ul>
  363. <ul class="navList">
  364. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" target="_top">Frames</a></li>
  365. <li><a href="SystemRecoverableException.html" target="_top">No&nbsp;Frames</a></li>
  366. </ul>
  367. <ul class="navList" id="allclasses_navbar_bottom">
  368. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  369. </ul>
  370. <div>
  371. <script type="text/javascript"><!--
  372. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  373. if(window==top) {
  374. allClassesLink.style.display = "block";
  375. }
  376. else {
  377. allClassesLink.style.display = "none";
  378. }
  379. //-->
  380. </script>
  381. </div>
  382. <div>
  383. <ul class="subNavList">
  384. <li>Summary:&nbsp;</li>
  385. <li>Nested&nbsp;|&nbsp;</li>
  386. <li>Field&nbsp;|&nbsp;</li>
  387. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  388. <li><a href="#method.summary">Method</a></li>
  389. </ul>
  390. <ul class="subNavList">
  391. <li>Detail:&nbsp;</li>
  392. <li>Field&nbsp;|&nbsp;</li>
  393. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  394. <li><a href="#method.detail">Method</a></li>
  395. </ul>
  396. </div>
  397. <a name="skip.navbar.bottom">
  398. <!-- -->
  399. </a></div>
  400. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  401. </body>
  402. </html>