GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
							<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0-internal) on Thu Mar 24 15:49:00 EDT 2022 -->
<title>IVisa</title>
<meta name="date" content="2022-03-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="IVisa";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/IVerifyTextNoEchoDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/cognos/CAM_AAA/authentication/MultiSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IVisa.html" target="_top">Frames</a></li>
<li><a href="IVisa.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div role="main" title ="IVisa" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">com.cognos.CAM_AAA.authentication</div>
<h2 title="Interface IVisa" class="title" id="Header1">Interface IVisa</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../com/cognos/CAM_AAA/authentication/IRestorableVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IRestorableVisa</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IVisa</span></pre>
<div class="block">Defines the interface to be used for implementing a visa. A visa is
 used to maintain state information for the logged on user. A visa is tied to
 a user's session.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ICredential.html" title="interface in com.cognos.CAM_AAA.authentication">ICredential</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#generateCredential-com.cognos.CAM_AAA.authentication.IBiBusHeader-">generateCredential</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)</code>
<div class="block">Generates credentials for the user.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ITrustedCredential.html" title="interface in com.cognos.CAM_AAA.authentication">ITrustedCredential</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#generateTrustedCredential-com.cognos.CAM_AAA.authentication.IBiBusHeader-">generateTrustedCredential</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)</code>
<div class="block">Generates trusted credentials for the user.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html" title="interface in com.cognos.CAM_AAA.authentication">IAccount</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#getAccount--">getAccount</a></span>()</code>
<div class="block">Returns information about the logged on user.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IGroup.html" title="interface in com.cognos.CAM_AAA.authentication">IGroup</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#getGroups--">getGroups</a></span>()</code>
<div class="block">Returns the groups of which the user is a member.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IRole.html" title="interface in com.cognos.CAM_AAA.authentication">IRole</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#getRoles--">getRoles</a></span>()</code>
<div class="block">Returns the roles of which the user is a member.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html#isValid--">isValid</a></span>()</code>
<div class="block">Verifies whether a visa is still valid.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="generateTrustedCredential-com.cognos.CAM_AAA.authentication.IBiBusHeader-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateTrustedCredential</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/ITrustedCredential.html" title="interface in com.cognos.CAM_AAA.authentication">ITrustedCredential</a>&nbsp;generateTrustedCredential(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)
                                      throws <a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a>,
                                             <a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a>,
                                             <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
<div class="block">Generates trusted credentials for the user. A trusted credential
 contains authentication information that is stored for a later usage
 and does not expire.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theBiBusHeader</code> - Request containing the information used to generate this
            trusted credential for the user.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Valid trusted credentials for the owner of the visa.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a></code> - Indicates that this trusted credential cannot be generated
             using the available information. It may be possible to 
             generate a trusted credential after interacting with the user.</dd>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a></code> - Indicates that this trusted credential cannot be generated
             using the available information.  It may be possible to 
             generate a trusted after interacting with the system.</dd>
<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
             normal operation of the namespace.</dd>
</dl>
</li>
</ul>
<a name="generateCredential-com.cognos.CAM_AAA.authentication.IBiBusHeader-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateCredential</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/ICredential.html" title="interface in com.cognos.CAM_AAA.authentication">ICredential</a>&nbsp;generateCredential(<a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)
                        throws <a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a>,
                               <a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a>,
                               <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
<div class="block">Generates credentials for the user. A credential contains authentication
 information that can be used to achieve SSO with the database system.
 Unlike trusted credentials, this type of credential is not stored anywhere
 and can expire.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theBiBusHeader</code> - Request containing the information used to generate the
            credential for the caller.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Valid credentials for the owner of the visa.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a></code> - Indicates that this trusted credential cannot be generated
             using the available information. It may be possible to 
             generate a trusted credential after interacting with the user.</dd>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a></code> - Indicates that this trusted credential cannot be generated
             using the available information.  It may be possible to 
             generate a trusted after interacting with the system.</dd>
<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
             normal operation of the namespace.</dd>
</dl>
</li>
</ul>
<a name="isValid--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>boolean&nbsp;isValid()</pre>
<div class="block">Verifies whether a visa is still valid.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A boolean to indicate whether the visa is valid.</dd>
</dl>
</li>
</ul>
<a name="getAccount--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAccount</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html" title="interface in com.cognos.CAM_AAA.authentication">IAccount</a>&nbsp;getAccount()</pre>
<div class="block">Returns information about the logged on user.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The account object for the logged on user.</dd>
</dl>
</li>
</ul>
<a name="getGroups--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/IGroup.html" title="interface in com.cognos.CAM_AAA.authentication">IGroup</a>[]&nbsp;getGroups()</pre>
<div class="block">Returns the groups of which the user is a member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The groups of which the user is a member.</dd>
</dl>
</li>
</ul>
<a name="getRoles--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRoles</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/IRole.html" title="interface in com.cognos.CAM_AAA.authentication">IRole</a>[]&nbsp;getRoles()</pre>
<div class="block">Returns the roles of which the user is a member.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The roles of which the user is a member.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/IVerifyTextNoEchoDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/cognos/CAM_AAA/authentication/MultiSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IVisa.html" target="_top">Frames</a></li>
<li><a href="IVisa.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>