<!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_265) on Tue Aug 25 19:30:52 UTC 2020 -->
<title>AuthUtil (MetaCat API)</title>
<meta name="date" content="2020-08-25">
<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="AuthUtil (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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 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="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AuthUtil.html">Use</a></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>Prev Class</li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/util/ConfigurationUtil.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/util/AuthUtil.html" target="_top">Frames</a></li>
<li><a href="AuthUtil.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </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 class="header">
<div class="subTitle">edu.ucsb.nceas.metacat.util</div>
<h2 title="Class AuthUtil" class="title">Class AuthUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.util.AuthUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AuthUtil</span>
extends java.lang.Object</pre>
</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#DELIMITER">DELIMITER</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#ESCAPECHAR">ESCAPECHAR</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static org.apache.log4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#logMetacat">logMetacat</a></span></code> </td>
</tr>
</table>
</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#canInsertOrUpdate-java.lang.String-java.lang.String:A-">canInsertOrUpdate</a></span>(java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Check if the specified user can insert the document</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#createLDAPString-java.lang.String-java.lang.String-java.util.Vector-">createLDAPString</a></span>(java.lang.String username,
java.lang.String organization,
java.util.Vector<java.lang.String> dnList)</code>
<div class="block">Creates an ldap credentail string from the username, organization
and dn list.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getAdministrators--">getAdministrators</a></span>()</code>
<div class="block">Get the administrators from metacat.properties</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getAllowedSubmitters--">getAllowedSubmitters</a></span>()</code>
<div class="block">Get the allowed submitters from metacat.properties</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getDeniedSubmitters--">getDeniedSubmitters</a></span>()</code>
<div class="block">Get the denied submitters from metacat.properties</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getGroupNames-javax.servlet.http.HttpServletRequest-">getGroupNames</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">Gets the user group names from the login session on the http request</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getModerators--">getModerators</a></span>()</code>
<div class="block">Get the moderators from metacat.properties</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#getUserName-javax.servlet.http.HttpServletRequest-">getUserName</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">Gets the user name from the login session on the http request</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isAdministrator-java.lang.String-java.lang.String:A-">isAdministrator</a></span>(java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Check if the specified user is part of the administrators list</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isAllowedSubmitter-java.lang.String-java.lang.String:A-">isAllowedSubmitter</a></span>(java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Check if the specified user is part of the moderators list</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isAuthConfigured--">isAuthConfigured</a></span>()</code>
<div class="block">Reports whether LDAP is fully configured.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isDeniedSubmitter-java.lang.String-java.lang.String:A-">isDeniedSubmitter</a></span>(java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Check if the specified user is part of the moderators list</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isModerator-java.lang.String-java.lang.String:A-">isModerator</a></span>(java.lang.String username,
java.lang.String[] groups)</code>
<div class="block">Check if the specified user is part of the moderators list</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isUserLoggedIn-javax.servlet.http.HttpServletRequest-">isUserLoggedIn</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">Checks to see if the user is logged in by grabbing the session from the
request and seeing if it exists in the global session list.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#isUserLoggedInAsAdmin-javax.servlet.http.HttpServletRequest-">isUserLoggedInAsAdmin</a></span>(javax.servlet.http.HttpServletRequest request)</code>
<div class="block">Checks to see if the user is logged in as admin by first checking if the
user is logged in and then seeing if the user's account is on the
administrators list in metacat.properties.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#logUserIn-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">logUserIn</a></span>(javax.servlet.http.HttpServletRequest request,
java.lang.String userName,
java.lang.String password)</code>
<div class="block">log the user in against ldap.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static java.util.Vector<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/util/AuthUtil.html#split-java.lang.String-java.lang.String-java.lang.String-">split</a></span>(java.lang.String text,
java.lang.String delimiter,
java.lang.String escapeChar)</code>
<div class="block">Convert a delimited string to a Vector by splitting on a particular character</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="logMetacat">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logMetacat</h4>
<pre>public static org.apache.log4j.Logger logMetacat</pre>
</li>
</ul>
<a name="DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELIMITER</h4>
<pre>public static java.lang.String DELIMITER</pre>
</li>
</ul>
<a name="ESCAPECHAR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ESCAPECHAR</h4>
<pre>public static java.lang.String ESCAPECHAR</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAdministrators--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAdministrators</h4>
<pre>public static java.util.Vector<java.lang.String> getAdministrators()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Get the administrators from metacat.properties</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of Strings holding the administrators</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAllowedSubmitters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowedSubmitters</h4>
<pre>public static java.util.Vector<java.lang.String> getAllowedSubmitters()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Get the allowed submitters from metacat.properties</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of Strings holding the submitters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDeniedSubmitters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeniedSubmitters</h4>
<pre>public static java.util.Vector<java.lang.String> getDeniedSubmitters()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Get the denied submitters from metacat.properties</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of Strings holding the denied submitters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="getModerators--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModerators</h4>
<pre>public static java.util.Vector<java.lang.String> getModerators()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Get the moderators from metacat.properties</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Vector of Strings holding the moderators</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="logUserIn-javax.servlet.http.HttpServletRequest-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logUserIn</h4>
<pre>public static boolean logUserIn(javax.servlet.http.HttpServletRequest request,
java.lang.String userName,
java.lang.String password)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">log the user in against ldap. If the login is successful, add
the session information to the session list in SessionUtil.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the http request.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isUserLoggedIn-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUserLoggedIn</h4>
<pre>public static boolean isUserLoggedIn(javax.servlet.http.HttpServletRequest request)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Checks to see if the user is logged in by grabbing the session from the
request and seeing if it exists in the global session list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the http request that holds the login session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean that is true if the user is logged in, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isUserLoggedInAsAdmin-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUserLoggedInAsAdmin</h4>
<pre>public static boolean isUserLoggedInAsAdmin(javax.servlet.http.HttpServletRequest request)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Checks to see if the user is logged in as admin by first checking if the
user is logged in and then seeing if the user's account is on the
administrators list in metacat.properties.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the http request that holds the login session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>boolean that is true if the user is logged in as admin, false
otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="getUserName-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
<pre>public static java.lang.String getUserName(javax.servlet.http.HttpServletRequest request)</pre>
<div class="block">Gets the user name from the login session on the http request</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the http request that holds the login session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String that holds the user name</dd>
</dl>
</li>
</ul>
<a name="getGroupNames-javax.servlet.http.HttpServletRequest-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupNames</h4>
<pre>public static java.lang.String[] getGroupNames(javax.servlet.http.HttpServletRequest request)</pre>
<div class="block">Gets the user group names from the login session on the http request</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the http request that holds the login session</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String array that holds the user groups</dd>
</dl>
</li>
</ul>
<a name="createLDAPString-java.lang.String-java.lang.String-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createLDAPString</h4>
<pre>public static java.lang.String createLDAPString(java.lang.String username,
java.lang.String organization,
java.util.Vector<java.lang.String> dnList)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Creates an ldap credentail string from the username, organization
and dn list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user name</dd>
<dd><code>organization</code> - the organization</dd>
<dd><code>dnList</code> - a list of dns</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String holding the ldap login string</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isAuthConfigured--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAuthConfigured</h4>
<pre>public static boolean isAuthConfigured()
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Reports whether LDAP is fully configured.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a boolean that is true if all sections are configured and false
otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isAdministrator-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAdministrator</h4>
<pre>public static boolean isAdministrator(java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Check if the specified user is part of the administrators list</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user login credentails</dd>
<dd><code>groups</code> - a list of the user's groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isModerator-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isModerator</h4>
<pre>public static boolean isModerator(java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Check if the specified user is part of the moderators list</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user login credentails</dd>
<dd><code>groups</code> - a list of the user's groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isAllowedSubmitter-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllowedSubmitter</h4>
<pre>public static boolean isAllowedSubmitter(java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Check if the specified user is part of the moderators list</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user login credentails</dd>
<dd><code>groups</code> - a list of the user's groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="isDeniedSubmitter-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDeniedSubmitter</h4>
<pre>public static boolean isDeniedSubmitter(java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Check if the specified user is part of the moderators list</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user login credentails</dd>
<dd><code>groups</code> - a list of the user's groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="canInsertOrUpdate-java.lang.String-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canInsertOrUpdate</h4>
<pre>public static boolean canInsertOrUpdate(java.lang.String username,
java.lang.String[] groups)
throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></pre>
<div class="block">Check if the specified user can insert the document</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - the user login credentails</dd>
<dd><code>groups</code> - a list of the user's groups</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/MetacatUtilException.html" title="class in edu.ucsb.nceas.metacat.shared">MetacatUtilException</a></code></dd>
</dl>
</li>
</ul>
<a name="split-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>split</h4>
<pre>public static java.util.Vector<java.lang.String> split(java.lang.String text,
java.lang.String delimiter,
java.lang.String escapeChar)</pre>
<div class="block">Convert a delimited string to a Vector by splitting on a particular character</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - the text to be split into components</dd>
<dd><code>delimiter</code> - the string to specify the delimiter</dd>
<dd><code>escapeChar</code> - the string to escape a delimiter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a vector holding the values. An empty vector will be returned if the text is null or empty.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AuthUtil.html">Use</a></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>Prev Class</li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/util/ConfigurationUtil.html" title="class in edu.ucsb.nceas.metacat.util"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/util/AuthUtil.html" target="_top">Frames</a></li>
<li><a href="AuthUtil.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p>
</body>
</html>