blob: 40e26eff8ebdbe1338e8a2a42f59e59d0058addd [file] [log] [blame]
<!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 Wed Feb 08 21:18:37 NOVT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ISessionManager (Openmeetings DB 3.2.0 API)</title>
<meta name="date" content="2017-02-08">
<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="ISessionManager (Openmeetings DB 3.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":38,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/ISessionManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/openmeetings/db/dao/server/LdapConfigDao.html" title="class in org.apache.openmeetings.db.dao.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openmeetings/db/dao/server/ISessionManager.html" target="_top">Frames</a></li>
<li><a href="ISessionManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openmeetings.db.dao.server</div>
<h2 title="Interface ISessionManager" class="title">Interface ISessionManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ISessionManager</span></pre>
<div class="block">Methods to add/get/remove <a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room"><code>Client</code></a>s to the session</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>sebawagner</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">&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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#add-org.apache.openmeetings.db.entity.room.Client-org.apache.openmeetings.db.entity.server.Server-">add</a></span>(<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;c,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#addClientListItem-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">addClientListItem</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;scopeName,
int&nbsp;remotePort,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteAddress,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;swfUrl,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">add a new client item</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#clearCache--">clearCache</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getActiveRoomIdsByServer-org.apache.openmeetings.db.entity.server.Server-">getActiveRoomIdsByServer</a></span>(<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">Get a list of all servers of all rooms on that server, serverId = null
means it is a local session on the master.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientByPublicSID-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">getClientByPublicSID</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;publicSID,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">get a client by its publicSID and the server,</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/dto/server/ClientSessionInfo.html" title="class in org.apache.openmeetings.db.dto.server">ClientSessionInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientByPublicSIDAnyServer-java.lang.String-">getClientByPublicSIDAnyServer</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;publicSID)</code>
<div class="block">same as <code>#getClientByPublicSID(String, boolean, Server)</code> but it ignores
if the server part, so it will deliver any client just by its publicSID.<br/>
<br/>
<b>Note:</b>
This method requires more time to find the user, so under normal circumstances
you should use <code>#getClientByPublicSID(String, boolean, Server)</code>!</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">getClientByStreamId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">Get a client by its streamId</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientByUserId-java.lang.Long-">getClientByUserId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;userId)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">There could be multiple users logged in with the same userid,
then this call would return a list not a single user</span></div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientListByRoom-java.lang.Long-">getClientListByRoom</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</code>
<div class="block">Get all ClientList Objects of that room and domain This Function is
needed cause it is invoked internally AFTER the current user has been
already removed from the ClientList to see if the Room is empty again and
the PollList can be removed</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientListByRoomAll-java.lang.Long-">getClientListByRoomAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClients--">getClients</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getClientsWithServer--">getClientsWithServer</a></span>()</code>
<div class="block">loads the server into the client (only if database cache is used)</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getCurrentModeratorByRoom-java.lang.Long-">getCurrentModeratorByRoom</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</code>
<div class="block">get the current Moderator in this room</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/openmeetings/db/dto/basic/SearchResult.html" title="class in org.apache.openmeetings.db.dto.basic">SearchResult</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getListByStartAndMax-int-int-java.lang.String-boolean-">getListByStartAndMax</a></span>(int&nbsp;start,
int&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderby,
boolean&nbsp;asc)</code>
<div class="block">Get list of current client sessions</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getPublishingCount-long-">getPublishingCount</a></span>(long&nbsp;roomId)</code>
<div class="block">returns a number of current users publishing screensharing</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#getRecordingCount-long-">getRecordingCount</a></span>(long&nbsp;roomId)</code>
<div class="block">returns number of current users recording</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/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/openmeetings/db/dao/server/ISessionManager.html#getSessionStatistics--">getSessionStatistics</a></span>()</code>
<div class="block">Get some statistics about the current sessions</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#removeClient-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">removeClient</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">Remove a client from the session store</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#sessionStart--">sessionStart</a></span>()</code>
<div class="block">Notified on server start, when the session manager should be started and
eventually caches cleared/setup</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#updateAVClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.room.Client-org.apache.openmeetings.db.entity.server.Server-">updateAVClientByStreamId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;rcm,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">Update the session object of the audio/video-connection and additionally
swap the values to the session object of the user that holds the full
session object</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/openmeetings/db/dao/server/ISessionManager.html#updateClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.room.Client-boolean-org.apache.openmeetings.db.entity.server.Server-">updateClientByStreamId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;rcm,
boolean&nbsp;updateRoomCount,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</code>
<div class="block">Update the session object
updateRoomCount is only <i>one</i> time true, in
ScopeApplicationAdapter#setRoomValues(Long, Boolean, Boolean, String)
.</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="clearCache--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearCache</h4>
<pre>void&nbsp;clearCache()</pre>
</li>
</ul>
<a name="sessionStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sessionStart</h4>
<pre>void&nbsp;sessionStart()</pre>
<div class="block">Notified on server start, when the session manager should be started and
eventually caches cleared/setup</div>
</li>
</ul>
<a name="add-org.apache.openmeetings.db.entity.room.Client-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;add(<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;c,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
</li>
</ul>
<a name="addClientListItem-java.lang.String-java.lang.String-int-java.lang.String-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addClientListItem</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;addClientListItem(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;scopeName,
int&nbsp;remotePort,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteAddress,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;swfUrl,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">add a new client item</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - </dd>
<dd><code>scopeName</code> - </dd>
<dd><code>remotePort</code> - </dd>
<dd><code>remoteAddress</code> - </dd>
<dd><code>swfUrl</code> - </dd>
<dd><code>server</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClients--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClients</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getClients()</pre>
</li>
</ul>
<a name="getClientsWithServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientsWithServer</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getClientsWithServer()</pre>
<div class="block">loads the server into the client (only if database cache is used)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientByStreamId</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;getClientByStreamId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">Get a client by its streamId</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - </dd>
<dd><code>server</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientByPublicSID-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientByPublicSID</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;getClientByPublicSID(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;publicSID,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">get a client by its publicSID and the server,</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publicSID</code> - </dd>
<dd><code>server</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientByPublicSIDAnyServer-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientByPublicSIDAnyServer</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/dto/server/ClientSessionInfo.html" title="class in org.apache.openmeetings.db.dto.server">ClientSessionInfo</a>&nbsp;getClientByPublicSIDAnyServer(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;publicSID)</pre>
<div class="block">same as <code>#getClientByPublicSID(String, boolean, Server)</code> but it ignores
if the server part, so it will deliver any client just by its publicSID.<br/>
<br/>
<b>Note:</b>
This method requires more time to find the user, so under normal circumstances
you should use <code>#getClientByPublicSID(String, boolean, Server)</code>!</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publicSID</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientByUserId-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientByUserId</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;getClientByUserId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;userId)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">There could be multiple users logged in with the same userid,
then this call would return a list not a single user</span></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userId</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="updateAVClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.room.Client-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateAVClientByStreamId</h4>
<pre>boolean&nbsp;updateAVClientByStreamId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;rcm,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">Update the session object of the audio/video-connection and additionally
swap the values to the session object of the user that holds the full
session object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - </dd>
<dd><code>rcm</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="updateClientByStreamId-java.lang.String-org.apache.openmeetings.db.entity.room.Client-boolean-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateClientByStreamId</h4>
<pre>boolean&nbsp;updateClientByStreamId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&nbsp;rcm,
boolean&nbsp;updateRoomCount,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">Update the session object
updateRoomCount is only <i>one</i> time true, in
ScopeApplicationAdapter#setRoomValues(Long, Boolean, Boolean, String)
.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - </dd>
<dd><code>rcm</code> - </dd>
<dd><code>updateRoomCount</code> - true means the count for the room has to be updated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="removeClient-java.lang.String-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeClient</h4>
<pre>boolean&nbsp;removeClient(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;streamId,
<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">Remove a client from the session store</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientListByRoom-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientListByRoom</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getClientListByRoom(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</pre>
<div class="block">Get all ClientList Objects of that room and domain This Function is
needed cause it is invoked internally AFTER the current user has been
already removed from the ClientList to see if the Room is empty again and
the PollList can be removed</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roomId</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getClientListByRoomAll-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientListByRoomAll</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getClientListByRoomAll(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</pre>
</li>
</ul>
<a name="getCurrentModeratorByRoom-java.lang.Long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentModeratorByRoom</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getCurrentModeratorByRoom(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&nbsp;roomId)</pre>
<div class="block">get the current Moderator in this room</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roomname</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getListByStartAndMax-int-int-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getListByStartAndMax</h4>
<pre><a href="../../../../../../org/apache/openmeetings/db/dto/basic/SearchResult.html" title="class in org.apache.openmeetings.db.dto.basic">SearchResult</a>&lt;<a href="../../../../../../org/apache/openmeetings/db/entity/room/Client.html" title="class in org.apache.openmeetings.db.entity.room">Client</a>&gt;&nbsp;getListByStartAndMax(int&nbsp;start,
int&nbsp;max,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;orderby,
boolean&nbsp;asc)</pre>
<div class="block">Get list of current client sessions</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - </dd>
<dd><code>max</code> - </dd>
<dd><code>orderby</code> - </dd>
<dd><code>asc</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getRecordingCount-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordingCount</h4>
<pre>long&nbsp;getRecordingCount(long&nbsp;roomId)</pre>
<div class="block">returns number of current users recording</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roomId</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getPublishingCount-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPublishingCount</h4>
<pre>long&nbsp;getPublishingCount(long&nbsp;roomId)</pre>
<div class="block">returns a number of current users publishing screensharing</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>roomId</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getActiveRoomIdsByServer-org.apache.openmeetings.db.entity.server.Server-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveRoomIdsByServer</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;getActiveRoomIdsByServer(<a href="../../../../../../org/apache/openmeetings/db/entity/server/Server.html" title="class in org.apache.openmeetings.db.entity.server">Server</a>&nbsp;server)</pre>
<div class="block">Get a list of all servers of all rooms on that server, serverId = null
means it is a local session on the master.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>server</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set, a roomId can be only one time in this list</dd>
</dl>
</li>
</ul>
<a name="getSessionStatistics--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSessionStatistics</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSessionStatistics()</pre>
<div class="block">Get some statistics about the current sessions</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</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/ISessionManager.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../../org/apache/openmeetings/db/dao/server/LdapConfigDao.html" title="class in org.apache.openmeetings.db.dao.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/openmeetings/db/dao/server/ISessionManager.html" target="_top">Frames</a></li>
<li><a href="ISessionManager.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2017 <a href="http://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>