GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
							<!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:58 EDT 2022 -->
<title>IBiBusHeader</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="IBiBusHeader";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/IBaseClass.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/IBiBusHeader2.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/IBiBusHeader.html" target="_top">Frames</a></li>
<li><a href="IBiBusHeader.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 ="IBiBusHeader" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">com.cognos.CAM_AAA.authentication</div>
<h2 title="Interface IBiBusHeader" class="title" id="Header1">Interface IBiBusHeader</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/IBiBusHeader2.html" title="interface in com.cognos.CAM_AAA.authentication">IBiBusHeader2</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/ITrustedSignonRequest.html" title="interface in com.cognos.CAM_AAA.authentication">ITrustedSignonRequest</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IBiBusHeader</span></pre>
<div class="block">Defines the interface to use for accessing an IBM Cognos
 biBusHeader. Only the properties used for authentication are accessible.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#consumeFormField-java.lang.String-">consumeFormField</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Removes the specified form field variable from the biBusheader object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Locale</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getContentLocale--">getContentLocale</a></span>()</code>
<div class="block">Returns the preferred content locale for the session.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getCookieValue-java.lang.String-">getCookieValue</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Returns all the values for the specified cookie variable.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getCredentialValue-java.lang.String-">getCredentialValue</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Returns all the values for the specified name portion of the
 name-value pairs in the credential.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getEnvVarValue-java.lang.String-">getEnvVarValue</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Returns all the values for the specified environment variable or null
 if it does not exist.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getFormFieldValue-java.lang.String-">getFormFieldValue</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Returns all the values for the specified form field variable.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Locale</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getProductLocale--">getProductLocale</a></span>()</code>
<div class="block">Returns the preferred product locale for the session.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#getTrustedEnvVarValue-java.lang.String-">getTrustedEnvVarValue</a></span>(java.lang.String&nbsp;theName)</code>
<div class="block">Returns all the values for the specified trusted environment variable, 
 or null if it does not exist.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html#setCookie-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-boolean-">setCookie</a></span>(java.lang.String&nbsp;theName,
         java.lang.String&nbsp;theValue,
         int&nbsp;theMaxAge,
         java.lang.String&nbsp;thePath,
         java.lang.String&nbsp;theDomain,
         boolean&nbsp;theSecureFlag)</code>
<div class="block">Sets a cookie value in the biBusHeader object.</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="getCredentialValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredentialValue</h4>
<pre>java.lang.String[]&nbsp;getCredentialValue(java.lang.String&nbsp;theName)</pre>
<div class="block">Returns all the values for the specified name portion of the
 name-value pairs in the credential. Returns null if none exists.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name portion of the required name-value pairs in the 
            credential.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of all values corresponding to the specified name.</dd>
</dl>
</li>
</ul>
<a name="getFormFieldValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormFieldValue</h4>
<pre>java.lang.String[]&nbsp;getFormFieldValue(java.lang.String&nbsp;theName)</pre>
<div class="block">Returns all the values for the specified form field variable.
 Returns null if none exists.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the form field variable to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array containing all the values of the specified
          form field variable.</dd>
</dl>
</li>
</ul>
<a name="getCookieValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCookieValue</h4>
<pre>java.lang.String[]&nbsp;getCookieValue(java.lang.String&nbsp;theName)</pre>
<div class="block">Returns all the values for the specified cookie variable.
 Returns null if none exists.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the cookie variable to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the cookie variable.</dd>
</dl>
</li>
</ul>
<a name="getEnvVarValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvVarValue</h4>
<pre>java.lang.String[]&nbsp;getEnvVarValue(java.lang.String&nbsp;theName)</pre>
<div class="block">Returns all the values for the specified environment variable or null
 if it does not exist. Not all environment variables are transmitted on
 the biBusHeader.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the environment variable to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the environment variable.</dd>
</dl>
</li>
</ul>
<a name="getTrustedEnvVarValue-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTrustedEnvVarValue</h4>
<pre>java.lang.String[]&nbsp;getTrustedEnvVarValue(java.lang.String&nbsp;theName)</pre>
<div class="block">Returns all the values for the specified trusted environment variable, 
 or null if it does not exist. A trusted environment variable is an
 environment variable that has been set by a trusted party (i.e. a Cognos
 gateway, the dispatcher or a trusted signon namespace). 
 The required variable is identified in a SystemRecoverableException,
 which an authentication provider throws when there is missing information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the trusted environment variable to retrieve.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of the trusted environment variable.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><code>SystemRecoverableException</code></a></dd>
</dl>
</li>
</ul>
<a name="consumeFormField-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumeFormField</h4>
<pre>void&nbsp;consumeFormField(java.lang.String&nbsp;theName)</pre>
<div class="block">Removes the specified form field variable from the biBusheader object.
 Form fields variables that are no longer required, especially sensitive
 information such as usernames and passwords, should be removed
 from the biBusHeader.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the form field variable to remove.</dd>
</dl>
</li>
</ul>
<a name="setCookie-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCookie</h4>
<pre>void&nbsp;setCookie(java.lang.String&nbsp;theName,
               java.lang.String&nbsp;theValue,
               int&nbsp;theMaxAge,
               java.lang.String&nbsp;thePath,
               java.lang.String&nbsp;theDomain,
               boolean&nbsp;theSecureFlag)</pre>
<div class="block">Sets a cookie value in the biBusHeader object. This class supports
 Version 0 of the Netscape cookie specification</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theName</code> - The name of the cookie.</dd>
<dd><code>theValue</code> - The value to assign to the cookie.</dd>
<dd><code>theMaxAge</code> - A date string that specifies the valid life time of
            the cookie. Once theMaxAge is reached, the cookie will
            expire. If this value is set to 0, the cookie will last 
            for the duration of the browser session. If the value 
            is set to -1, then the cookie has expired.</dd>
<dd><code>thePath</code> - Specifies the subset of URLs in a domain for which the
            cookie is valid.</dd>
<dd><code>theDomain</code> - Specifies the domain in which the cookie will be visible.
            The default value of domain is the host name of the 
            server that generated the cookie response.</dd>
<dd><code>theSecureFlag</code> - Specifies whether the cookie should be secured.
            If true, the browser will not pass the cookie to the Web 
            server unless the Web page is being viewed over a secure
            connection. Currently this means that secure cookies will only be sent to
            HTTPS (HTTP over SSL) servers.</dd>
</dl>
</li>
</ul>
<a name="getProductLocale--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProductLocale</h4>
<pre>java.util.Locale&nbsp;getProductLocale()</pre>
<div class="block">Returns the preferred product locale for the session. The product locale
 determines the language and data format for the user interface.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The product locale for the session.</dd>
</dl>
</li>
</ul>
<a name="getContentLocale--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContentLocale</h4>
<pre>java.util.Locale&nbsp;getContentLocale()</pre>
<div class="block">Returns the preferred content locale for the session. The content locale
 determines the language and data format of the returned content.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The content locale for the session.</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/IBaseClass.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/IBiBusHeader2.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/IBiBusHeader.html" target="_top">Frames</a></li>
<li><a href="IBiBusHeader.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>