<!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_362) on Wed Apr 24 00:28:38 UTC 2024 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (d1_portal 2.3.3 API)</title>
<meta name="date" content="2024-04-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="Index (d1_portal 2.3.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<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="org/dataone/portal/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/dataone/portal/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All 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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:C">C</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a name="I:C">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#closeLoggers--">closeLoggers()</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">To prevent .lck files from persisting, we close the loggers when shutting down the system
http://stackoverflow.com/questions/2723280/why-is-my-program-creating-empty-lck-files</div>
</dd>
</dl>
<a name="I:F">
<!-- -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#fetchServerCertificate--">fetchServerCertificate()</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd>
<div class="block">fetches the server certificates from the remote CN using the configured CN baseurl from
d1_libclient_java.</div>
</dd>
</dl>
<a name="I:G">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getCertificate-javax.servlet.http.HttpServletRequest-">getCertificate(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Get the certificate from the store, based on the cookie (if present)</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getConfigFile--">getConfigFile()</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Gets the current configuration file path</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getCookie-javax.servlet.http.HttpServletRequest-">getCookie(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Retrieves the certificate Cookie from the request</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getCredentials-java.lang.String-">getCredentials(String)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Get the credentials from the store, based on the token/identifier</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getCredentials-javax.servlet.http.HttpServletRequest-">getCredentials(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Get the credentials from the store, based on the cookie (if present)</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getInstance--">getInstance()</a></span> - Static method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#getInstance--">getInstance()</a></span> - Static method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#getJWT-java.lang.String-java.lang.String-">getJWT(String, String)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getPrivateKey-javax.servlet.http.HttpServletRequest-">getPrivateKey(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Get the private key from the store, based on the cookie (if present)</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#getSession-javax.servlet.http.HttpServletRequest-">getSession(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Gets the requests Session, either the X509 Certificate if there is one,
or by checking for Authorization headers.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#getSession-java.lang.String-">getSession(String)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd>
<div class="block">Uses configured public keys to verify provided token.</div>
</dd>
</dl>
<a name="I:L">
<!-- -->
</a>
<h2 class="title">L</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#log">log</a></span> - Static variable in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#log">log</a></span> - Static variable in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd> </dd>
</dl>
<a name="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd>
<div class="block">For generating custom tokens outside the portal workflow.</div>
</dd>
</dl>
<a name="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><a href="org/dataone/portal/package-summary.html">org.dataone.portal</a> - package org.dataone.portal</dt>
<dd> </dd>
</dl>
<a name="I:P">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal"><span class="typeNameLink">PortalCertificateManager</span></a> - Class in <a href="org/dataone/portal/package-summary.html">org.dataone.portal</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#PortalCertificateManager--">PortalCertificateManager()</a></span> - Constructor for class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#PortalCertificateManager-java.lang.String-">PortalCertificateManager(String)</a></span> - Constructor for class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#publicKeys">publicKeys</a></span> - Static variable in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#putPortalCertificateOnRequest-javax.servlet.http.HttpServletRequest-">putPortalCertificateOnRequest(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
</dl>
<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#registerPortalCertificateAndPlaceOnRequest-javax.servlet.http.HttpServletRequest-">registerPortalCertificateAndPlaceOnRequest(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#registerPortalCertificateWithCertificateManger-javax.servlet.http.HttpServletRequest-">registerPortalCertificateWithCertificateManger(HttpServletRequest)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#removeCookie-javax.servlet.http.HttpServletResponse-">removeCookie(HttpServletResponse)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Removes the certificate cookie, essentially logging out the user</div>
</dd>
</dl>
<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#setConfigFile-java.lang.String-">setConfigFile(String)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Sets the client configuration file path</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/PortalCertificateManager.html#setCookie-java.lang.String-javax.servlet.http.HttpServletResponse-">setCookie(String, HttpServletResponse)</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/PortalCertificateManager.html" title="class in org.dataone.portal">PortalCertificateManager</a></dt>
<dd>
<div class="block">Sets the certificate Cookie on the response.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/dataone/portal/TokenGenerator.html#setPublicKeys--">setPublicKeys()</a></span> - Method in class org.dataone.portal.<a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal">TokenGenerator</a></dt>
<dd> </dd>
</dl>
<a name="I:T">
<!-- -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><a href="org/dataone/portal/TokenGenerator.html" title="class in org.dataone.portal"><span class="typeNameLink">TokenGenerator</span></a> - Class in <a href="org/dataone/portal/package-summary.html">org.dataone.portal</a></dt>
<dd>
<div class="block">Class for generating JSON web tokens for authenticated users.</div>
</dd>
</dl>
<a href="#I:C">C</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> </div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<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="org/dataone/portal/package-summary.html">Package</a></li>
<li>Class</li>
<li>Use</li>
<li><a href="org/dataone/portal/package-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All 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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2024. All rights reserved.</small></p>
</body>
</html>