<!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:50 UTC 2020 -->
<title>AuthInterface (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="AuthInterface (MetaCat API)";
        }
    }
    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 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/AuthInterface.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><a href="../../../../edu/ucsb/nceas/metacat/AssociateAccessPolicy.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../edu/ucsb/nceas/metacat/AuthLdap.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/metacat/AuthInterface.html" target="_top">Frames</a></li>
<li><a href="AuthInterface.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 class="header">
<div class="subTitle">edu.ucsb.nceas.metacat</div>
<h2 title="Interface AuthInterface" class="title">Interface AuthInterface</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../edu/ucsb/nceas/metacat/authentication/AuthFile.html" title="class in edu.ucsb.nceas.metacat.authentication">AuthFile</a>, <a href="../../../../edu/ucsb/nceas/metacat/AuthLdap.html" title="class in edu.ucsb.nceas.metacat">AuthLdap</a>, <a href="../../../../edu/ucsb/nceas/metacat/AuthStub.html" title="class in edu.ucsb.nceas.metacat">AuthStub</a>, <a href="../../../../edu/ucsb/nceas/metacat/AuthTest.html" title="class in edu.ucsb.nceas.metacat">AuthTest</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AuthInterface</span></pre>
<div class="block">An interface representing the methods that should be
 implemented by an authentication service.  The authentication service is
 used to determine if a user is authenticated, and whether they are a member
 of a particular group.</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>
<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">&nbsp;</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 short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#GROUPDESINDEX">GROUPDESINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#GROUPNAMEINDEX">GROUPNAMEINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERCNINDEX">USERCNINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERDNINDEX">USERDNINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USEREMAILINDEX">USEREMAILINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERINFOCNINDEX">USERINFOCNINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERINFOEMAILINDEX">USERINFOEMAILINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERINFOORGANIDEX">USERINFOORGANIDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERORGINDEX">USERORGINDEX</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#USERORGUNITINDEX">USERORGUNITINDEX</a></span></code>&nbsp;</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">&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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#authenticate-java.lang.String-java.lang.String-">authenticate</a></span>(java.lang.String&nbsp;user,
            java.lang.String&nbsp;password)</code>
<div class="block">Determine if a user/password are valid according to the authentication
 service.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.HashMap&lt;java.lang.String,java.util.Vector&lt;java.lang.String&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getAttributes-java.lang.String-">getAttributes</a></span>(java.lang.String&nbsp;foruser)</code>
<div class="block">Get attributes describing a user or group</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.HashMap&lt;java.lang.String,java.util.Vector&lt;java.lang.String&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getAttributes-java.lang.String-java.lang.String-java.lang.String-">getAttributes</a></span>(java.lang.String&nbsp;user,
             java.lang.String&nbsp;password,
             java.lang.String&nbsp;foruser)</code>
<div class="block">Get attributes describing a user or group</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="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getGroups-java.lang.String-java.lang.String-">getGroups</a></span>(java.lang.String&nbsp;user,
         java.lang.String&nbsp;password)</code>
<div class="block">Get all groups from the authentication service</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="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getGroups-java.lang.String-java.lang.String-java.lang.String-">getGroups</a></span>(java.lang.String&nbsp;user,
         java.lang.String&nbsp;password,
         java.lang.String&nbsp;foruser)</code>
<div class="block">Get the groups for a particular user from the authentication service</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="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getPrincipals-java.lang.String-java.lang.String-">getPrincipals</a></span>(java.lang.String&nbsp;user,
             java.lang.String&nbsp;password)</code>
<div class="block">Get all groups and users from authentication service.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getUserInfo-java.lang.String-java.lang.String-">getUserInfo</a></span>(java.lang.String&nbsp;user,
           java.lang.String&nbsp;password)</code>
<div class="block">Get information for a user - name, organization and email address.</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="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getUsers-java.lang.String-java.lang.String-">getUsers</a></span>(java.lang.String&nbsp;user,
        java.lang.String&nbsp;password)</code>
<div class="block">Get all users from the authentication service</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/AuthInterface.html#getUsers-java.lang.String-java.lang.String-java.lang.String-">getUsers</a></span>(java.lang.String&nbsp;user,
        java.lang.String&nbsp;password,
        java.lang.String&nbsp;group)</code>
<div class="block">Get the users for a particular group from the authentication service</div>
</td>
</tr>
</table>
</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="USERDNINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERDNINDEX</h4>
<pre>static final&nbsp;short USERDNINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERDNINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERCNINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERCNINDEX</h4>
<pre>static final&nbsp;short USERCNINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERCNINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERORGINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERORGINDEX</h4>
<pre>static final&nbsp;short USERORGINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERORGINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERORGUNITINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERORGUNITINDEX</h4>
<pre>static final&nbsp;short USERORGUNITINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERORGUNITINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USEREMAILINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USEREMAILINDEX</h4>
<pre>static final&nbsp;short USEREMAILINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USEREMAILINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="GROUPNAMEINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GROUPNAMEINDEX</h4>
<pre>static final&nbsp;short GROUPNAMEINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.GROUPNAMEINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="GROUPDESINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GROUPDESINDEX</h4>
<pre>static final&nbsp;short GROUPDESINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.GROUPDESINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERINFOCNINDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERINFOCNINDEX</h4>
<pre>static final&nbsp;short USERINFOCNINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERINFOCNINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERINFOORGANIDEX">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>USERINFOORGANIDEX</h4>
<pre>static final&nbsp;short USERINFOORGANIDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERINFOORGANIDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="USERINFOEMAILINDEX">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>USERINFOEMAILINDEX</h4>
<pre>static final&nbsp;short USERINFOEMAILINDEX</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#edu.ucsb.nceas.metacat.AuthInterface.USERINFOEMAILINDEX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="authenticate-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre>boolean&nbsp;authenticate(java.lang.String&nbsp;user,
                     java.lang.String&nbsp;password)
              throws java.net.ConnectException</pre>
<div class="block">Determine if a user/password are valid according to the authentication
 service.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the name of the principal to authenticate</dd>
<dd><code>password</code> - the password to use for authentication</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getUsers-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre>java.lang.String[][]&nbsp;getUsers(java.lang.String&nbsp;user,
                              java.lang.String&nbsp;password)
                       throws java.net.ConnectException</pre>
<div class="block">Get all users from the authentication service</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getUserInfo-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserInfo</h4>
<pre>java.lang.String[]&nbsp;getUserInfo(java.lang.String&nbsp;user,
                               java.lang.String&nbsp;password)
                        throws java.net.ConnectException</pre>
<div class="block">Get information for a user - name, organization and email address.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getUsers-java.lang.String-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUsers</h4>
<pre>java.lang.String[]&nbsp;getUsers(java.lang.String&nbsp;user,
                            java.lang.String&nbsp;password,
                            java.lang.String&nbsp;group)
                     throws java.net.ConnectException</pre>
<div class="block">Get the users for a particular group from the authentication service</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getGroups-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre>java.lang.String[][]&nbsp;getGroups(java.lang.String&nbsp;user,
                               java.lang.String&nbsp;password)
                        throws java.net.ConnectException</pre>
<div class="block">Get all groups from the authentication service</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getGroups-java.lang.String-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroups</h4>
<pre>java.lang.String[][]&nbsp;getGroups(java.lang.String&nbsp;user,
                               java.lang.String&nbsp;password,
                               java.lang.String&nbsp;foruser)
                        throws java.net.ConnectException</pre>
<div class="block">Get the groups for a particular user from the authentication service</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getAttributes-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>java.util.HashMap&lt;java.lang.String,java.util.Vector&lt;java.lang.String&gt;&gt;&nbsp;getAttributes(java.lang.String&nbsp;foruser)
                                                                              throws java.net.ConnectException</pre>
<div class="block">Get attributes describing a user or group</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user for which the attribute list is requested</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getAttributes-java.lang.String-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>java.util.HashMap&lt;java.lang.String,java.util.Vector&lt;java.lang.String&gt;&gt;&nbsp;getAttributes(java.lang.String&nbsp;user,
                                                                                     java.lang.String&nbsp;password,
                                                                                     java.lang.String&nbsp;foruser)
                                                                              throws java.net.ConnectException</pre>
<div class="block">Get attributes describing a user or group</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user for which the attribute list is requested</dd>
<dd><code>authuser</code> - the user for authenticating against the service</dd>
<dd><code>password</code> - the password for authenticating against the service</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></dd>
</dl>
</li>
</ul>
<a name="getPrincipals-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPrincipals</h4>
<pre>java.lang.String&nbsp;getPrincipals(java.lang.String&nbsp;user,
                               java.lang.String&nbsp;password)
                        throws java.net.ConnectException</pre>
<div class="block">Get all groups and users from authentication service.
 The output is formatted in XML.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>user</code> - the user which requests the information</dd>
<dd><code>password</code> - the user's password</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.net.ConnectException</code></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/AuthInterface.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><a href="../../../../edu/ucsb/nceas/metacat/AssociateAccessPolicy.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../edu/ucsb/nceas/metacat/AuthLdap.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/metacat/AuthInterface.html" target="_top">Frames</a></li>
<li><a href="AuthInterface.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 ======= -->
<p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p>
</body>
</html>