<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!-- | |
Copyright 1999-2004 The Apache Software Foundation | |
Licensed under the Apache License, Version 2.0 (the "License"); | |
you may not use this file except in compliance with the License. | |
You may obtain a copy of the License at | |
http://www.apache.org/licenses/LICENSE-2.0 | |
Unless required by applicable law or agreed to in writing, software | |
distributed under the License is distributed on an "AS IS" BASIS, | |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
See the License for the specific language governing permissions and | |
limitations under the License. | |
--> | |
<!-- ====================================================================== --> | |
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE TEMPLATE INSTEAD! --> | |
<!-- Main Page Section --> | |
<!-- ====================================================================== --> | |
<html> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> | |
<meta name="author" content="OpenMeetings Team"> | |
<meta name="email" content="sebawagner@apache.org"> | |
<title>OpenMeetings API Methods</title> | |
<link rel="stylesheet" type="text/css" href="openmeetings_docs.css"> | |
</head> | |
<body> | |
<h3>Available WebServices:</h3> | |
<iframe src="WebserviceIndex.html" width="100%" height="210" name="WebserviceIndex.html" | |
scrolling="no" marginheight="0" marginwidth="0" frameborder="0"> | |
<p>Your Browser does not support frames ...</p> | |
</iframe> | |
<hr /> | |
<h3>WebService: ServerService</h3> | |
<p>This class provides method implementations necessary for OM to manage servers | |
participating in cluster.<p> | |
<p>WSDL sample Url: <a href="http://localhost:5080/openmeetings/services/ServerService?wsdl">http://localhost:5080/openmeetings/services/ServerService?wsdl</a><p> | |
<!-- Links to Methods --> | |
<h3>Index of Methods available in ServerService</h3> | |
<div class="navigation"> | |
<div> | |
<a href="#getServers"><b>getServers</b></a><br/> | |
<div class="navigation_comment"><i >Method to retrieve the list of the servers participating in cluster</i></div> | |
</div> | |
<div> | |
<a href="#getServerCount"><b>getServerCount</b></a><br/> | |
<div class="navigation_comment"><i >Method to retrieve the total count of the servers participating in | |
cluster</i></div> | |
</div> | |
<div> | |
<a href="#saveServer"><b>saveServer</b></a><br/> | |
<div class="navigation_comment"><i >Method to add/update server</i></div> | |
</div> | |
<div> | |
<a href="#deleteServer"><b>deleteServer</b></a><br/> | |
<div class="navigation_comment"><i >Method to delete server</i></div> | |
</div> | |
</div> | |
<h3>Methods Details in ServerService</h3> | |
<div class="method"> | |
<div class="method_header"> | |
<div style="margin-left:10px"> | |
<a name="getServers" ><b>getServers</b></a> | |
</div> | |
</div> | |
Method: <i>getServers ( | |
String SID | |
, | |
int start | |
, | |
int max | |
) | |
</i><br/> | |
<p> | |
Method to retrieve the list of the servers participating in cluster | |
</p> | |
<p> | |
Return Type: org.apache.openmeetings.persistence.beans.basic.Server[] | |
</p> | |
<p>Params:</p> | |
<table rules="all" border="1"> | |
<thead> | |
<tr> | |
<th width="200" align="left">Type</th> | |
<th width="200" align="left">Fieldname</th> | |
<th width="400" align="left">Description</th> | |
</tr> | |
</thead> | |
<tbody> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">SID</td> | |
<td valign="top">- session id to identify the user making request</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
int | |
</td> | |
<td valign="top">start</td> | |
<td valign="top">- server index to start with</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
int | |
</td> | |
<td valign="top">max</td> | |
<td valign="top">- Maximum server count</td> | |
</tr> | |
</tbody> | |
</table> | |
<br/> | |
REST Sample Call/URL:<br/> | |
<a href="http://localhost:5080/openmeetings/services/ServerService/getServers?SID=VALUE&start=VALUE&max=VALUE">http://localhost:5080/openmeetings/services/ServerService/getServers?SID=VALUE&start=VALUE&max=VALUE</a> | |
</div> | |
<div class="method"> | |
<div class="method_header"> | |
<div style="margin-left:10px"> | |
<a name="getServerCount" ><b>getServerCount</b></a> | |
</div> | |
</div> | |
Method: <i>getServerCount ( | |
String SID | |
) | |
</i><br/> | |
<p> | |
Method to retrieve the total count of the servers participating in | |
cluster | |
</p> | |
<p> | |
Return Type: int | |
</p> | |
<p>Params:</p> | |
<table rules="all" border="1"> | |
<thead> | |
<tr> | |
<th width="200" align="left">Type</th> | |
<th width="200" align="left">Fieldname</th> | |
<th width="400" align="left">Description</th> | |
</tr> | |
</thead> | |
<tbody> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">SID</td> | |
<td valign="top">- session id to identify the user making request</td> | |
</tr> | |
</tbody> | |
</table> | |
<br/> | |
REST Sample Call/URL:<br/> | |
<a href="http://localhost:5080/openmeetings/services/ServerService/getServerCount?SID=VALUE">http://localhost:5080/openmeetings/services/ServerService/getServerCount?SID=VALUE</a> | |
</div> | |
<div class="method"> | |
<div class="method_header"> | |
<div style="margin-left:10px"> | |
<a name="saveServer" ><b>saveServer</b></a> | |
</div> | |
</div> | |
Method: <i>saveServer ( | |
String SID | |
, | |
long id | |
, | |
String name | |
, | |
String address | |
, | |
int port | |
, | |
String user | |
, | |
String pass | |
, | |
String webapp | |
, | |
String protocol | |
, | |
Boolean active | |
, | |
String comment | |
) | |
</i><br/> | |
<p> | |
Method to add/update server | |
</p> | |
<p> | |
Return Type: long | |
</p> | |
<p>Params:</p> | |
<table rules="all" border="1"> | |
<thead> | |
<tr> | |
<th width="200" align="left">Type</th> | |
<th width="200" align="left">Fieldname</th> | |
<th width="400" align="left">Description</th> | |
</tr> | |
</thead> | |
<tbody> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">SID</td> | |
<td valign="top">- session id to identify the user making request</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
long | |
</td> | |
<td valign="top">id</td> | |
<td valign="top">- the id of the server to save</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">name</td> | |
<td valign="top">- the name of the server to save</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">address</td> | |
<td valign="top">- the address(DNS name or IP) of the server to save</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
int | |
</td> | |
<td valign="top">port</td> | |
<td valign="top">- the http port of the slave</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">user</td> | |
<td valign="top">- REST user to access the slave</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">pass</td> | |
<td valign="top">- REST pass to access the slave</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">webapp</td> | |
<td valign="top">- webapp name of the OpenMeetings instance</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">protocol</td> | |
<td valign="top">- protocol to access the OpenMeetings instance</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
Boolean | |
</td> | |
<td valign="top">active</td> | |
<td valign="top">- if the server currently participates in the cluster or not</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">comment</td> | |
<td valign="top">- comment for the server</td> | |
</tr> | |
</tbody> | |
</table> | |
<br/> | |
REST Sample Call/URL:<br/> | |
<a href="http://localhost:5080/openmeetings/services/ServerService/saveServer?SID=VALUE&id=VALUE&name=VALUE&address=VALUE&port=VALUE&user=VALUE&pass=VALUE&webapp=VALUE&protocol=VALUE&active=VALUE&comment=VALUE">http://localhost:5080/openmeetings/services/ServerService/saveServer?SID=VALUE&id=VALUE&name=VALUE&address=VALUE&port=VALUE&user=VALUE&pass=VALUE&webapp=VALUE&protocol=VALUE&active=VALUE&comment=VALUE</a> | |
</div> | |
<div class="method"> | |
<div class="method_header"> | |
<div style="margin-left:10px"> | |
<a name="deleteServer" ><b>deleteServer</b></a> | |
</div> | |
</div> | |
Method: <i>deleteServer ( | |
String SID | |
, | |
long id | |
) | |
</i><br/> | |
<p> | |
Method to delete server | |
</p> | |
<p> | |
Return Type: boolean | |
</p> | |
<p>Params:</p> | |
<table rules="all" border="1"> | |
<thead> | |
<tr> | |
<th width="200" align="left">Type</th> | |
<th width="200" align="left">Fieldname</th> | |
<th width="400" align="left">Description</th> | |
</tr> | |
</thead> | |
<tbody> | |
<tr> | |
<td valign="top"> | |
String | |
</td> | |
<td valign="top">SID</td> | |
<td valign="top">- session id to identify the user making request</td> | |
</tr> | |
<tr> | |
<td valign="top"> | |
long | |
</td> | |
<td valign="top">id</td> | |
<td valign="top">- the id of the server to delete</td> | |
</tr> | |
</tbody> | |
</table> | |
<br/> | |
REST Sample Call/URL:<br/> | |
<a href="http://localhost:5080/openmeetings/services/ServerService/deleteServer?SID=VALUE&id=VALUE">http://localhost:5080/openmeetings/services/ServerService/deleteServer?SID=VALUE&id=VALUE</a> | |
</div> | |
</body> | |
</html> | |