Modified: openmeetings/trunk/singlewebapp/docs/webservices/org/apache/openmeetings/webservice/ServerWebService.html URL: http://svn.apache.org/viewvc/openmeetings/trunk/singlewebapp/docs/webservices/org/apache/openmeetings/webservice/ServerWebService.html?rev=1597968&r1=1597967&r2=1597968&view=diff ============================================================================== --- openmeetings/trunk/singlewebapp/docs/webservices/org/apache/openmeetings/webservice/ServerWebService.html (original) +++ openmeetings/trunk/singlewebapp/docs/webservices/org/apache/openmeetings/webservice/ServerWebService.html Wed May 28 10:46:51 2014 @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (version 1.7.0_55) on Tue May 27 16:04:32 NOVT 2014 --> +<!-- Generated by javadoc (version 1.7.0_55) on Wed May 28 14:00:47 NOVT 2014 --> <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> <title>ServerWebService (Openmeetings Webservices 3.1.0-SNAPSHOT API)</title> -<meta name="date" content="2014-05-27"> +<meta name="date" content="2014-05-28"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> @@ -84,7 +84,7 @@ </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><a href="http://docs.oracle.com/javase/7/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.openmeetings.webservice.ServerWebService</li> @@ -99,7 +99,7 @@ <pre>@Produces(value={"application/xml","application/json"}) @Path(value="/server") public class <span class="strong">ServerWebService</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></pre> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> <div class="block">This class provides method implementations necessary for OM to manage servers participating in cluster.</div> <dl><dt><span class="strong">Author:</span></dt> @@ -141,21 +141,21 @@ extends <a href="http://docs.oracle.com/ </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#deleteServer(java.lang.String, long)">deleteServer</a></strong>(<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> SID, +<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#deleteServer(java.lang.String, long)">deleteServer</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, long id)</code> <div class="block">Method to delete server</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#getServerCount(java.lang.String)">getServerCount</a></strong>(<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> SID)</code> +<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#getServerCount(java.lang.String)">getServerCount</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID)</code> <div class="block">Method to retrieve the total count of the servers participating in cluster</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/server/Server.html?is-external=true"; title="class or interface in org.apache.openmeetings.db.entity.server">Server</a>[]</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#getServers(java.lang.String, int, int)">getServers</a></strong>(<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> SID, +<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#getServers(java.lang.String, int, int)">getServers</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, int start, int max)</code> <div class="block">Method to retrieve the list of the servers participating in cluster</div> @@ -163,17 +163,17 @@ extends <a href="http://docs.oracle.com/ </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#saveServer(java.lang.String, long, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.String)">saveServer</a></strong>(<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> SID, +<td class="colLast"><code><strong><a href="../../../../org/apache/openmeetings/webservice/ServerWebService.html#saveServer(java.lang.String, long, java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.String)">saveServer</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, long id, - <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, - <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> address, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> address, int port, - <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> user, - <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> pass, - <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> webapp, - <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> protocol, - <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> active, - <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> comment)</code> + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> pass, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> webapp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> protocol, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> active, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> comment)</code> <div class="block">Method to add/update server</div> </td> </tr> @@ -182,8 +182,8 @@ extends <a href="http://docs.oracle.com/ <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> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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> @@ -222,7 +222,7 @@ extends <a href="http://docs.oracle.com/ <ul class="blockList"> <li class="blockList"> <h4>getServers</h4> -<pre>public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/server/Server.html?is-external=true"; title="class or interface in org.apache.openmeetings.db.entity.server">Server</a>[] getServers(<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> SID, +<pre>public <a href="http://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/server/Server.html?is-external=true"; title="class or interface in org.apache.openmeetings.db.entity.server">Server</a>[] getServers(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, int start, int max) throws org.apache.openmeetings.webservice.dto.ServiceException</pre> @@ -239,7 +239,7 @@ extends <a href="http://docs.oracle.com/ <ul class="blockList"> <li class="blockList"> <h4>getServerCount</h4> -<pre>public int getServerCount(<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> SID) +<pre>public int getServerCount(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID) throws org.apache.openmeetings.webservice.dto.ServiceException</pre> <div class="block">Method to retrieve the total count of the servers participating in cluster</div> @@ -255,17 +255,17 @@ extends <a href="http://docs.oracle.com/ <ul class="blockList"> <li class="blockList"> <h4>saveServer</h4> -<pre>public long saveServer(<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> SID, +<pre>public long saveServer(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, long id, - <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, - <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> address, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> address, int port, - <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> user, - <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> pass, - <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> webapp, - <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> protocol, - <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> active, - <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> comment) + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> user, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> pass, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> webapp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> protocol, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> active, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> comment) throws org.apache.openmeetings.webservice.dto.ServiceException</pre> <div class="block">Method to add/update server</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>SID</code> - - session id to identify the user making request</dd><dd><code>id</code> - - the id of the server to save</dd><dd><code>name</code> - - the name of the server to save</dd><dd><code>address</code> - - the address(DNS name or IP) of the server to save</dd><dd><code>port</code> - - the http port of the slave</dd><dd><code>user</code> - - REST user to access the slave</dd><dd><code>pass</code> - - REST pass to access the slave</dd><dd><code>webapp</code> - - webapp name of the OpenMeetings instance</dd><dd><code>protocol</code> - - protocol to access the OpenMeetings instance</dd><dd><code>active</code> - - if the server currently participates in the cluster or not</dd><dd><code>comment</code> - - comment for the server</dd> @@ -280,7 +280,7 @@ extends <a href="http://docs.oracle.com/ <ul class="blockListLast"> <li class="blockList"> <h4>deleteServer</h4> -<pre>public boolean deleteServer(<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> SID, +<pre>public boolean deleteServer(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> SID, long id) throws org.apache.openmeetings.webservice.dto.ServiceException</pre> <div class="block">Method to delete server</div>
