GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
							<!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:48:59 EDT 2022 -->
<title>INamespaceAuthenticationProviderBase</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="INamespaceAuthenticationProviderBase";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":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/INamespaceAuthenticationProvider2.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/INamespaceConfiguration.html" title="interface 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/INamespaceAuthenticationProviderBase.html" target="_top">Frames</a></li>
<li><a href="INamespaceAuthenticationProviderBase.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 ="INamespaceAuthenticationProviderBase" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">com.cognos.CAM_AAA.authentication</div>
<h2 title="Interface INamespaceAuthenticationProviderBase" class="title" id="Header1">Interface INamespaceAuthenticationProviderBase</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<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/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProvider</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider2.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProvider2</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">INamespaceAuthenticationProviderBase</span>
extends <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication">INamespace</a></pre>
<div class="block">Defines the base interface to use for implementing an IBM Cognos custom
 authentication provider.
 
 This interface should not be directly implemented, use the subclasses instead.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.cognos.CAM_AAA.authentication.INamespace">
<!--   -->
</a>
<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>
<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>
</ul>
</li>
</ul>
<!-- ========== 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html#logoff-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IBiBusHeader-">logoff</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a>&nbsp;theVisa,
      <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">Logs off the user from this authentication namespace.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryResult.html" title="interface in com.cognos.CAM_AAA.authentication">IQueryResult</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html#search-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IQuery-">search</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a>&nbsp;theVisa,
      <a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html" title="interface in com.cognos.CAM_AAA.authentication">IQuery</a>&nbsp;theQuery)</code>
<div class="block">Retrieves a set of objects that exist within the
 current authentication namespace.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.INamespace">
<!--   -->
</a>
<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>
<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>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IUiClass">
<!--   -->
</a>
<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>
<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>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IBaseClass">
<!--   -->
</a>
<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>
<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>
</ul>
</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="logoff-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IBiBusHeader-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logoff</h4>
<pre>void&nbsp;logoff(<a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a>&nbsp;theVisa,
            <a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader</a>&nbsp;theBiBusHeader)</pre>
<div class="block">Logs off the user from this authentication namespace. After this call
 this visa will no longer be used by the system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theVisa</code> - A visa that grants access to this authentication namespace.
            This visa was previously issued by this authentication
            namespace using the logon method.</dd>
<dd><code>theBiBusHeader</code> - The biBusHeader that contains the information used to
            authenticate the user. The biBusHeader can be modified to
            remove existing cookies, form fields, and so on.</dd>
</dl>
</li>
</ul>
<a name="search-com.cognos.CAM_AAA.authentication.IVisa-com.cognos.CAM_AAA.authentication.IQuery-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>search</h4>
<pre><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryResult.html" title="interface in com.cognos.CAM_AAA.authentication">IQueryResult</a>&nbsp;search(<a href="../../../../com/cognos/CAM_AAA/authentication/IVisa.html" title="interface in com.cognos.CAM_AAA.authentication">IVisa</a>&nbsp;theVisa,
                    <a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html" title="interface in com.cognos.CAM_AAA.authentication">IQuery</a>&nbsp;theQuery)
             throws <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
<div class="block">Retrieves a set of objects that exist within the
 current authentication namespace. The result only contains the
 objects that the user has the appropriate permissions for.
 If the user is not authenticated, the result will only contain
 the information visible to an anonymous user.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theVisa</code> - A visa that grants access to this authentication namespace,
            and identifies the user performing this search. This parameter
            will be null if the user is not authenticated in this
            namespace.</dd>
<dd><code>theQuery</code> - The details about which objects to return.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result of the query.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></code> - An exception has occurred that interferes with the
             normal operation of the namespace.</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/INamespaceAuthenticationProvider2.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/INamespaceConfiguration.html" title="interface 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/INamespaceAuthenticationProviderBase.html" target="_top">Frames</a></li>
<li><a href="INamespaceAuthenticationProviderBase.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>