http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html new file mode 100644 index 0000000..4e9b890 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html @@ -0,0 +1,434 @@ +<!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_121) on Sat Mar 18 18:54:06 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConnectionRecord (guacamole-ext 0.9.12-incubating API)</title> +<meta name="date" content="2017-03-18"> +<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="ConnectionRecord (guacamole-ext 0.9.12-incubating 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/ConnectionRecord.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="../../../../../org/apache/guacamole/net/auth/ConnectionGroup.Type.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecord.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecord.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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">org.apache.guacamole.net.auth</div> +<h2 title="Interface ConnectionRecord" class="title">Interface ConnectionRecord</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ConnectionRecord</span></pre> +<div class="block">A logging record describing when a user started and ended usage of a + particular connection.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Jumper</dd> +</dl> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getConnectionIdentifier--">getConnectionIdentifier</a></span>()</code> +<div class="block">Returns the identifier of the connection associated with this + connection record.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getConnectionName--">getConnectionName</a></span>()</code> +<div class="block">Returns the name of the connection associated with this connection + record.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getEndDate--">getEndDate</a></span>()</code> +<div class="block">Returns the date and time the connection ended, if applicable.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getRemoteHost--">getRemoteHost</a></span>()</code> +<div class="block">Returns the hostname or IP address of the remote host that used the + connection associated with this record, if known.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getSharingProfileIdentifier--">getSharingProfileIdentifier</a></span>()</code> +<div class="block">Returns the identifier of the sharing profile that was used to access the + connection associated with this connection record.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getSharingProfileName--">getSharingProfileName</a></span>()</code> +<div class="block">Returns the name of the sharing profile that was used to access the + connection associated with this connection record.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getStartDate--">getStartDate</a></span>()</code> +<div class="block">Returns the date and time the connection began.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#getUsername--">getUsername</a></span>()</code> +<div class="block">Returns the name of the user who used or is using the connection at the + times given by this connection record.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html#isActive--">isActive</a></span>()</code> +<div class="block">Returns whether the connection associated with this record is still + active.</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="getConnectionIdentifier--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionIdentifier</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getConnectionIdentifier()</pre> +<div class="block">Returns the identifier of the connection associated with this + connection record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The identifier of the connection associated with this connection + record.</dd> +</dl> +</li> +</ul> +<a name="getConnectionName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionName</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getConnectionName()</pre> +<div class="block">Returns the name of the connection associated with this connection + record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The name of the connection associated with this connection record.</dd> +</dl> +</li> +</ul> +<a name="getSharingProfileIdentifier--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSharingProfileIdentifier</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSharingProfileIdentifier()</pre> +<div class="block">Returns the identifier of the sharing profile that was used to access the + connection associated with this connection record. If the connection was + accessed directly (without involving a sharing profile), this will be + null.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The identifier of the sharing profile used to access the connection + associated with this connection record, or null if the connection + was accessed directly.</dd> +</dl> +</li> +</ul> +<a name="getSharingProfileName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSharingProfileName</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSharingProfileName()</pre> +<div class="block">Returns the name of the sharing profile that was used to access the + connection associated with this connection record. If the connection was + accessed directly (without involving a sharing profile), this will be + null.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The name of the sharing profile used to access the connection + associated with this connection record, or null if the connection + was accessed directly.</dd> +</dl> +</li> +</ul> +<a name="getStartDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStartDate</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getStartDate()</pre> +<div class="block">Returns the date and time the connection began.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The date and time the connection began.</dd> +</dl> +</li> +</ul> +<a name="getEndDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEndDate</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getEndDate()</pre> +<div class="block">Returns the date and time the connection ended, if applicable.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The date and time the connection ended, or null if the + connection is still running or if the end time is unknown.</dd> +</dl> +</li> +</ul> +<a name="getRemoteHost--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemoteHost</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRemoteHost()</pre> +<div class="block">Returns the hostname or IP address of the remote host that used the + connection associated with this record, if known. If the hostname or IP + address is not known, null is returned.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The hostname or IP address of the remote host, or null if this + information is not available.</dd> +</dl> +</li> +</ul> +<a name="getUsername--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsername</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsername()</pre> +<div class="block">Returns the name of the user who used or is using the connection at the + times given by this connection record.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The name of the user who used or is using the associated + connection.</dd> +</dl> +</li> +</ul> +<a name="isActive--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isActive</h4> +<pre>boolean isActive()</pre> +<div class="block">Returns whether the connection associated with this record is still + active.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the connection associated with this record is still + active, false otherwise.</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/ConnectionRecord.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="../../../../../org/apache/guacamole/net/auth/ConnectionGroup.Type.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecord.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecord.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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>Copyright © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html new file mode 100644 index 0000000..185f6da --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html @@ -0,0 +1,352 @@ +<!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_121) on Sat Mar 18 18:54:06 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConnectionRecordSet.SortableProperty (guacamole-ext 0.9.12-incubating API)</title> +<meta name="date" content="2017-03-18"> +<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="ConnectionRecordSet.SortableProperty (guacamole-ext 0.9.12-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":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/ConnectionRecordSet.SortableProperty.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html" title="class in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecordSet.SortableProperty.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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">org.apache.guacamole.net.auth</div> +<h2 title="Enum ConnectionRecordSet.SortableProperty" class="title">Enum ConnectionRecordSet.SortableProperty</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.ConnectionRecordSet.SortableProperty</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">ConnectionRecordSet.SortableProperty</span> +extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a>></pre> +<div class="block">All properties of connection records which can be used as sorting + criteria.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html#START_DATE">START_DATE</a></span></code> +<div class="block">The date and time when the connection associated with the + connection record began.</div> +</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 <a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/ api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="START_DATE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>START_DATE</h4> +<pre>public static final <a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a> START_DATE</pre> +<div class="block">The date and time when the connection associated with the + connection record began.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ConnectionRecordSet.SortableProperty c : ConnectionRecordSet.SortableProperty.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a> valueOf(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</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/ConnectionRecordSet.SortableProperty.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html" title="class in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecordSet.SortableProperty.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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>Copyright © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html new file mode 100644 index 0000000..b67f338 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html @@ -0,0 +1,380 @@ +<!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_121) on Sat Mar 18 18:54:06 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConnectionRecordSet (guacamole-ext 0.9.12-incubating API)</title> +<meta name="date" content="2017-03-18"> +<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="ConnectionRecordSet (guacamole-ext 0.9.12-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":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/ConnectionRecordSet.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecordSet.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecordSet.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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">org.apache.guacamole.net.auth</div> +<h2 title="Interface ConnectionRecordSet" class="title">Interface ConnectionRecordSet</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/guacamole/net/auth/simple/SimpleConnectionRecordSet.html" title="class in org.apache.guacamole.net.auth.simple">SimpleConnectionRecordSet</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ConnectionRecordSet</span></pre> +<div class="block">The set of all available connection records, or a subset of those records.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Muehlner, Michael Jumper</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a></span></code> +<div class="block">All properties of connection records which can be used as sorting + criteria.</div> +</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecord</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html#asCollection--">asCollection</a></span>()</code> +<div class="block">Returns all connection records within this set as a standard Collection.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html#contains-java.lang.String-">contains</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> +<div class="block">Returns the subset of connection records to only those where the + connection name, user identifier, or any associated date field contain + the given value.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html#limit-int-">limit</a></span>(int limit)</code> +<div class="block">Returns the subset of connection history records containing only the + first <code>limit</code> records.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html#sort-org.apache.guacamole.net.auth.ConnectionRecordSet.SortableProperty-boolean-">sort</a></span>(<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a> property, + boolean desc)</code> +<div class="block">Returns a ConnectionRecordSet containing identically the records within + this set, sorted according to the specified criteria.</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="asCollection--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asCollection</h4> +<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecord</a>> asCollection() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block">Returns all connection records within this set as a standard Collection.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection containing all connection records within this set.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving the connection records within + this set.</dd> +</dl> +</li> +</ul> +<a name="contains-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a> contains(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value) + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block">Returns the subset of connection records to only those where the + connection name, user identifier, or any associated date field contain + the given value. This function may also affect the contents of the + current ConnectionRecordSet. The contents of the current + ConnectionRecordSet should NOT be relied upon after this function is + called.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The value which all connection records within the resulting subset + should contain within their associated connection name or user + identifier.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The subset of connection history records which contain the specified + value within their associated connection name or user identifier.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while restricting the current subset.</dd> +</dl> +</li> +</ul> +<a name="limit-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>limit</h4> +<pre><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a> limit(int limit) + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block">Returns the subset of connection history records containing only the + first <code>limit</code> records. If the subset has fewer than + <code>limit</code> records, then this function has no effect. This + function may also affect the contents of the current + ConnectionRecordSet. The contents of the current ConnectionRecordSet + should NOT be relied upon after this function is called.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - The maximum number of records that the new subset should contain.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The subset of connection history records that containing only the + first <code>limit</code> records.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while limiting the current subset.</dd> +</dl> +</li> +</ul> +<a name="sort-org.apache.guacamole.net.auth.ConnectionRecordSet.SortableProperty-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sort</h4> +<pre><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a> sort(<a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth">ConnectionRecordSet.SortableProperty</a> property, + boolean desc) + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block">Returns a ConnectionRecordSet containing identically the records within + this set, sorted according to the specified criteria. The sort operation + performed is guaranteed to be stable with respect to any past call to + sort(). This function may also affect the contents of the current + ConnectionRecordSet. The contents of the current ConnectionRecordSet + should NOT be relied upon after this function is called.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>property</code> - The property by which the connection records within the resulting + set should be sorted.</dd> +<dd><code>desc</code> - Whether the records should be sorted according to the specified + property in descending order. If false, records will be sorted + according to the specified property in ascending order.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ConnnectionRecordSet, sorted according to the specified + criteria.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while sorting the current subset.</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/ConnectionRecordSet.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ConnectionRecordSet.html" target="_top">Frames</a></li> +<li><a href="ConnectionRecordSet.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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>Copyright © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html new file mode 100644 index 0000000..a108a12 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html @@ -0,0 +1,551 @@ +<!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_121) on Sat Mar 18 18:54:06 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Credentials (guacamole-ext 0.9.12-incubating API)</title> +<meta name="date" content="2017-03-18"> +<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="Credentials (guacamole-ext 0.9.12-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/Credentials.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/Credentials.html" target="_top">Frames</a></li> +<li><a href="Credentials.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>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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">org.apache.guacamole.net.auth</div> +<h2 title="Class Credentials" class="title">Class Credentials</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.Credentials</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Credentials</span> +extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +<div class="block">Simple arbitrary set of credentials, including a username/password pair, + the HttpServletRequest associated with the request for authorization + (if any) and the HttpSession associated with that request. + + This class is used along with AuthenticationProvider to provide arbitrary + HTTP-based authentication for Guacamole.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Jumper</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.guacamole.net.auth.Credentials">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#Credentials--">Credentials</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getPassword--">getPassword</a></span>()</code> +<div class="block">Returns the password associated with this set of credentials.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getRemoteAddress--">getRemoteAddress</a></span>()</code> +<div class="block">Returns the address of the client end of the connection which provided + these credentials, if known.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getRemoteHostname--">getRemoteHostname</a></span>()</code> +<div class="block">Returns the hostname of the client end of the connection which provided + these credentials, if known.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>javax.servlet.http.HttpServletRequest</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getRequest--">getRequest</a></span>()</code> +<div class="block">Returns the HttpServletRequest associated with this set of credentials.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>javax.servlet.http.HttpSession</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getSession--">getSession</a></span>()</code> +<div class="block">Returns the HttpSession associated with this set of credentials.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#getUsername--">getUsername</a></span>()</code> +<div class="block">Returns the username associated with this set of credentials.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setPassword-java.lang.String-">setPassword</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</code> +<div class="block">Sets the password associated with this set of credentials.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setRemoteAddress-java.lang.String-">setRemoteAddress</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteAddress)</code> +<div class="block">Sets the address of the client end of the connection which provided + these credentials.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setRemoteHostname-java.lang.String-">setRemoteHostname</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteHostname)</code> +<div class="block">Sets the hostname of the client end of the connection which provided + these credentials, if known.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setRequest-javax.servlet.http.HttpServletRequest-">setRequest</a></span>(javax.servlet.http.HttpServletRequest request)</code> +<div class="block">Sets the HttpServletRequest associated with this set of credentials.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setSession-javax.servlet.http.HttpSession-">setSession</a></span>(javax.servlet.http.HttpSession session)</code> +<div class="block">Sets the HttpSession associated with this set of credentials.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Credentials.html#setUsername-java.lang.String-">setUsername</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username)</code> +<div class="block">Sets the username associated with this set of credentials.</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.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Credentials--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Credentials</h4> +<pre>public Credentials()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPassword--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPassword</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPassword()</pre> +<div class="block">Returns the password associated with this set of credentials.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The password associated with this username/password pair, or + null if no password has been set.</dd> +</dl> +</li> +</ul> +<a name="setPassword-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPassword</h4> +<pre>public void setPassword(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password)</pre> +<div class="block">Sets the password associated with this set of credentials.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>password</code> - The password to associate with this username/password + pair.</dd> +</dl> +</li> +</ul> +<a name="getUsername--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUsername</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUsername()</pre> +<div class="block">Returns the username associated with this set of credentials.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The username associated with this username/password pair, or + null if no username has been set.</dd> +</dl> +</li> +</ul> +<a name="setUsername-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUsername</h4> +<pre>public void setUsername(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username)</pre> +<div class="block">Sets the username associated with this set of credentials.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>username</code> - The username to associate with this username/password + pair.</dd> +</dl> +</li> +</ul> +<a name="getRequest--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequest</h4> +<pre>public javax.servlet.http.HttpServletRequest getRequest()</pre> +<div class="block">Returns the HttpServletRequest associated with this set of credentials.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The HttpServletRequest associated with this set of credentials, + or null if no such request exists.</dd> +</dl> +</li> +</ul> +<a name="setRequest-javax.servlet.http.HttpServletRequest-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequest</h4> +<pre>public void setRequest(javax.servlet.http.HttpServletRequest request)</pre> +<div class="block">Sets the HttpServletRequest associated with this set of credentials.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>request</code> - The HttpServletRequest to associated with this set of + credentials.</dd> +</dl> +</li> +</ul> +<a name="getSession--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSession</h4> +<pre>public javax.servlet.http.HttpSession getSession()</pre> +<div class="block">Returns the HttpSession associated with this set of credentials.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The HttpSession associated with this set of credentials, or null + if no such request exists.</dd> +</dl> +</li> +</ul> +<a name="setSession-javax.servlet.http.HttpSession-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSession</h4> +<pre>public void setSession(javax.servlet.http.HttpSession session)</pre> +<div class="block">Sets the HttpSession associated with this set of credentials.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>session</code> - The HttpSession to associated with this set of + credentials.</dd> +</dl> +</li> +</ul> +<a name="getRemoteAddress--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemoteAddress</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRemoteAddress()</pre> +<div class="block">Returns the address of the client end of the connection which provided + these credentials, if known.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The address of the client end of the connection which provided these + credentials, or null if the address is not known.</dd> +</dl> +</li> +</ul> +<a name="setRemoteAddress-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRemoteAddress</h4> +<pre>public void setRemoteAddress(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteAddress)</pre> +<div class="block">Sets the address of the client end of the connection which provided + these credentials.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>remoteAddress</code> - The address of the client end of the connection which provided these + credentials, or null if the address is not known.</dd> +</dl> +</li> +</ul> +<a name="getRemoteHostname--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemoteHostname</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRemoteHostname()</pre> +<div class="block">Returns the hostname of the client end of the connection which provided + these credentials, if known. If the hostname of the client cannot be + determined, but the address is known, the address may be returned + instead.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The hostname or address of the client end of the connection which + provided these credentials, or null if the hostname is not known.</dd> +</dl> +</li> +</ul> +<a name="setRemoteHostname-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setRemoteHostname</h4> +<pre>public void setRemoteHostname(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> remoteHostname)</pre> +<div class="block">Sets the hostname of the client end of the connection which provided + these credentials, if known. If the hostname of the client cannot be + determined, but the address is known, the address may be specified + instead.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>remoteHostname</code> - The hostname or address of the client end of the connection which + provided these credentials, or null if the hostname is not known.</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/Credentials.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="../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html" title="enum in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/Credentials.html" target="_top">Frames</a></li> +<li><a href="Credentials.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>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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>Copyright © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html>
