You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2012/03/30 05:00:44 UTC
svn commit: r1307221 - in /incubator/openmeetings/trunk/singlewebapp: ./
docs/ src/org/openmeetings/axis/services/ xdocs/
Author: solomax
Date: Fri Mar 30 03:00:43 2012
New Revision: 1307221
URL: http://svn.apache.org/viewvc?rev=1307221&view=rev
Log:
OPENMEETINGS-106 is fixed
Added:
incubator/openmeetings/trunk/singlewebapp/docs/JabberService.html
Modified:
incubator/openmeetings/trunk/singlewebapp/.project
incubator/openmeetings/trunk/singlewebapp/build.xml
incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm
incubator/openmeetings/trunk/singlewebapp/docs/CalendarService.html
incubator/openmeetings/trunk/singlewebapp/docs/FileService.html
incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html
incubator/openmeetings/trunk/singlewebapp/docs/SoapRestAPI.html
incubator/openmeetings/trunk/singlewebapp/docs/UserService.html
incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html
incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebService.java
incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebServiceFacade.java
incubator/openmeetings/trunk/singlewebapp/xdocs/SoapRestAPI.xml
Modified: incubator/openmeetings/trunk/singlewebapp/.project
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/.project?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/.project (original)
+++ incubator/openmeetings/trunk/singlewebapp/.project Fri Mar 30 03:00:43 2012
@@ -1,71 +1,71 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<projectDescription>
- <name>Openmeetings</name>
- <comment></comment>
- <projects>
- </projects>
- <buildSpec>
- <buildCommand>
- <name>org.eclipse.wst.jsdt.core.javascriptValidator</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>org.eclipse.jdt.core.javabuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>org.eclipse.wst.common.project.facet.core.builder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>org.eclipse.wst.validation.validationbuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
- <name>org.springframework.ide.eclipse.core.springbuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- </buildSpec>
- <natures>
- <nature>org.springframework.ide.eclipse.core.springnature</nature>
- <nature>org.eclipse.jem.workbench.JavaEMFNature</nature>
- <nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature>
- <nature>org.eclipse.wst.common.project.facet.core.nature</nature>
- <nature>org.eclipse.jdt.core.javanature</nature>
- <nature>org.eclipse.wst.jsdt.core.jsNature</nature>
- </natures>
- <filteredResources>
- <filter>
- <id>1332523639229</id>
- <name></name>
- <type>26</type>
- <matcher>
- <id>org.eclipse.ui.ide.multiFilter</id>
- <arguments>1.0-name-matches-false-false-.svn</arguments>
- </matcher>
- </filter>
- <filter>
- <id>1332523639230</id>
- <name></name>
- <type>10</type>
- <matcher>
- <id>org.eclipse.ui.ide.multiFilter</id>
- <arguments>1.0-projectRelativePath-matches-false-false-dist</arguments>
- </matcher>
- </filter>
- <filter>
- <id>1332523639231</id>
- <name></name>
- <type>10</type>
- <matcher>
- <id>org.eclipse.ui.ide.multiFilter</id>
- <arguments>1.0-projectRelativePath-matches-false-false-build/classes</arguments>
- </matcher>
- </filter>
- </filteredResources>
-</projectDescription>
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>Openmeetings</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.wst.jsdt.core.javascriptValidator</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.wst.common.project.facet.core.builder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.wst.validation.validationbuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.springframework.ide.eclipse.core.springbuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.springframework.ide.eclipse.core.springnature</nature>
+ <nature>org.eclipse.jem.workbench.JavaEMFNature</nature>
+ <nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature>
+ <nature>org.eclipse.wst.common.project.facet.core.nature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ <nature>org.eclipse.wst.jsdt.core.jsNature</nature>
+ </natures>
+ <filteredResources>
+ <filter>
+ <id>1333075027076</id>
+ <name></name>
+ <type>26</type>
+ <matcher>
+ <id>org.eclipse.ui.ide.multiFilter</id>
+ <arguments>1.0-name-matches-false-false-.svn</arguments>
+ </matcher>
+ </filter>
+ <filter>
+ <id>1333075027107</id>
+ <name></name>
+ <type>10</type>
+ <matcher>
+ <id>org.eclipse.ui.ide.multiFilter</id>
+ <arguments>1.0-projectRelativePath-matches-false-false-dist</arguments>
+ </matcher>
+ </filter>
+ <filter>
+ <id>1333075027137</id>
+ <name></name>
+ <type>26</type>
+ <matcher>
+ <id>org.eclipse.ui.ide.multiFilter</id>
+ <arguments>1.0-projectRelativePath-matches-false-false-build/classes/openmeetings</arguments>
+ </matcher>
+ </filter>
+ </filteredResources>
+</projectDescription>
Modified: incubator/openmeetings/trunk/singlewebapp/build.xml
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/build.xml?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/build.xml (original)
+++ incubator/openmeetings/trunk/singlewebapp/build.xml Fri Mar 30 03:00:43 2012
@@ -478,10 +478,7 @@
<target name="build.webservice.doc" depends="compile.only">
<javadoc classpathref="build.webservice.classpath">
- <source file="src/org/openmeetings/axis/services/UserWebService.java" />
- <source file="src/org/openmeetings/axis/services/RoomWebService.java" />
- <source file="src/org/openmeetings/axis/services/FileWebService.java" />
- <source file="src/org/openmeetings/axis/services/CalendarWebService.java" />
+ <source file="src/org/openmeetings/axis/services/*WebService.java" />
<doclet name="org.openmeetings.doc.WebServiceDoclet" pathref="build.webservice.classpath">
</doclet>
</javadoc>
@@ -514,10 +511,7 @@
<target name="build.only.webservice.doc" depends="anakia">
<javadoc classpathref="build.webservice.classpath" useexternalfile="true">
- <source file="src/org/openmeetings/axis/services/UserWebService.java" />
- <source file="src/org/openmeetings/axis/services/RoomWebService.java" />
- <source file="src/org/openmeetings/axis/services/FileWebService.java" />
- <source file="src/org/openmeetings/axis/services/CalendarWebService.java" />
+ <source file="src/org/openmeetings/axis/services/*WebService.java" />
<doclet name="org.openmeetings.doc.WebServiceDoclet" pathref="build.webservice.classpath" />
</javadoc>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm Fri Mar 30 03:00:43 2012
@@ -31,7 +31,7 @@ limitations under the License.
<h3>Available WebServices:</h3>
- <iframe src="WebserviceIndex.html" width="100%" height="140" name="WebserviceIndex.html"
+ <iframe src="WebserviceIndex.html" width="100%" height="180" name="WebserviceIndex.html"
scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
<p>Your Browser does not support frames ...</p>
</iframe>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/CalendarService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/CalendarService.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/CalendarService.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/CalendarService.html Fri Mar 30 03:00:43 2012
@@ -31,7 +31,7 @@ limitations under the License.
<h3>Available WebServices:</h3>
- <iframe src="WebserviceIndex.html" width="100%" height="140" name="WebserviceIndex.html"
+ <iframe src="WebserviceIndex.html" width="100%" height="180" name="WebserviceIndex.html"
scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
<p>Your Browser does not support frames ...</p>
</iframe>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/FileService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/FileService.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/FileService.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/FileService.html Fri Mar 30 03:00:43 2012
@@ -31,7 +31,7 @@ limitations under the License.
<h3>Available WebServices:</h3>
- <iframe src="WebserviceIndex.html" width="100%" height="140" name="WebserviceIndex.html"
+ <iframe src="WebserviceIndex.html" width="100%" height="180" name="WebserviceIndex.html"
scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
<p>Your Browser does not support frames ...</p>
</iframe>
Added: incubator/openmeetings/trunk/singlewebapp/docs/JabberService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/JabberService.html?rev=1307221&view=auto
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/JabberService.html (added)
+++ incubator/openmeetings/trunk/singlewebapp/docs/JabberService.html Fri Mar 30 03:00:43 2012
@@ -0,0 +1,234 @@
+<!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" value="OpenMeetings Team">
+ <meta name="email" value="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="180" name="WebserviceIndex.html"
+ scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
+ <p>Your Browser does not support frames ...</p>
+ </iframe>
+
+ <hr />
+
+ <h3>WebService: JabberService</h3>
+ <p>This class provides method implementations necessary for OM to Jabber integration.<p>
+ <p>WSDL sample Url: <a href="http://localhost:5080/openmeetings/services/JabberService?wsdl">http://localhost:5080/openmeetings/services/JabberService?wsdl</a><p>
+
+ <!-- Links to Methods -->
+ <h3>Index of Methods available in JabberService</h3>
+
+ <div class="navigation">
+ <div>
+ <a href="#getAvailableRooms"><b>getAvailableRooms</b></a><br/>
+ <div class="navigation_comment"><i >Get List<Rooms> of all rooms available to the user.
+ No admin rights are necessary for this call</i></div>
+ </div>
+ <div>
+ <a href="#getUserCount"><b>getUserCount</b></a><br/>
+ <div class="navigation_comment"><i >Returns the count of users currently in the Room with given id
+ No admin rights are necessary for this call</i></div>
+ </div>
+ <div>
+ <a href="#getInvitationHash"><b>getInvitationHash</b></a><br/>
+ <div class="navigation_comment"><i >Get invitation hash for the room with given id
+ No admin rights are necessary for this call</i></div>
+ </div>
+ </div>
+
+ <h3>Methods Details in JabberService</h3>
+
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getAvailableRooms" ><b>getAvailableRooms</b></a>
+ </div>
+ </div>
+
+ Method: <i>getAvailableRooms (
+ String SID
+ )
+ </i><br/>
+ <p>
+ Get List<Rooms> of all rooms available to the user.
+ No admin rights are necessary for this call
+ </p>
+ <p>
+ Return Type: java.util.List
+ </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">The SID from UserService.getSession</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/JabberService/getAvailableRooms?SID=VALUE">http://localhost:5080/openmeetings/services/JabberService/getAvailableRooms?SID=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getUserCount" ><b>getUserCount</b></a>
+ </div>
+ </div>
+
+ Method: <i>getUserCount (
+ String SID
+ ,
+ Long roomId
+ )
+ </i><br/>
+ <p>
+ Returns the count of users currently in the Room with given id
+ No admin rights are necessary for this call
+ </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">The SID from UserService.getSession</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">roomId</td>
+ <td valign="top">id of the room to get users</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/JabberService/getUserCount?SID=VALUE&roomId=VALUE">http://localhost:5080/openmeetings/services/JabberService/getUserCount?SID=VALUE&roomId=VALUE</a>
+ </a>
+ </div>
+ <div class="method">
+ <div class="method_header">
+ <div style="margin-left:10px">
+ <a name="getInvitationHash" ><b>getInvitationHash</b></a>
+ </div>
+ </div>
+
+ Method: <i>getInvitationHash (
+ String SID
+ ,
+ String username
+ ,
+ Long room_id
+ )
+ </i><br/>
+ <p>
+ Get invitation hash for the room with given id
+ No admin rights are necessary for this call
+ </p>
+ <p>
+ Return Type: java.lang.String
+ </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">The SID from UserService.getSession</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ String
+ </td>
+ <td valign="top">username</td>
+ <td valign="top">The name of invited user, will be displayed in the rooms user list</td>
+ </tr>
+
+ <tr>
+ <td valign="top">
+ Long
+ </td>
+ <td valign="top">room_id</td>
+ <td valign="top">id of the room to get users</td>
+ </tr>
+
+ </tbody>
+ </table>
+ <br/>
+ REST Sample Call/URL:<br/>
+ <a href="http://localhost:5080/openmeetings/services/JabberService/getInvitationHash?SID=VALUE&username=VALUE&room_id=VALUE">http://localhost:5080/openmeetings/services/JabberService/getInvitationHash?SID=VALUE&username=VALUE&room_id=VALUE</a>
+ </a>
+ </div>
+
+
+ </body>
+</html>
+
Modified: incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html Fri Mar 30 03:00:43 2012
@@ -31,7 +31,7 @@ limitations under the License.
<h3>Available WebServices:</h3>
- <iframe src="WebserviceIndex.html" width="100%" height="140" name="WebserviceIndex.html"
+ <iframe src="WebserviceIndex.html" width="100%" height="180" name="WebserviceIndex.html"
scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
<p>Your Browser does not support frames ...</p>
</iframe>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/SoapRestAPI.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/SoapRestAPI.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/SoapRestAPI.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/SoapRestAPI.html Fri Mar 30 03:00:43 2012
@@ -34,11 +34,8 @@ limitations under the License.
<meta name="email" value="sebawagner@apache.org">
-
-
-
-
-
+
+
<title>Apache OpenMeetings - Home</title>
<link rel="stylesheet" type="text/css" href="css/openmeetings.css">
<link rel="stylesheet" type="text/css" href="css/jquery-ui.css">
@@ -862,54 +859,65 @@ limitations under the License.
</td></tr>
<tr><td>
<blockquote>
- <div>
- <div>
- <a href="UserService.html" target="_BLANK">
- <b>UserService</b>
- </a>
- <br />
- <div style="margin-left:20px">
- <i>The Service contains methods to login and create hash to
- directly enter
- conference rooms, recordings or the application in
- general
- </i>
- </div>
- </div>
- <div>
- <a href="RoomService.html" target="_BLANK">
- <b>RoomService</b>
- </a>
- <br />
- <div style="margin-left:20px">
- <i>RoomService contains methods to manipulate rooms and create
- invitation hash
- </i>
- </div>
- </div>
- <div>
- <a href="FileService.html" target="_BLANK">
- <b>FileService</b>
- </a>
- <br />
- <div style="margin-left:20px">
- <i>Contains methods to import and upload files into the Files
- section of the
- conference room and the personal drive of any user
- </i>
- </div>
- </div>
- <div>
- <a href="CalendarService.html" target="_BLANK">
- <b>CalendarService</b>
- </a>
- <br />
- <div style="margin-left:20px">
- <i>CalendarService contains methods to create, edit delete
- calendar meetings
- </i>
- </div>
- </div>
+ <div>
+ <div>
+ <a href="UserService.html" target="_BLANK">
+ <b>UserService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>The Service contains methods to login and create hash to
+ directly enter
+ conference rooms, recordings or the application in
+ general
+ </i>
+ </div>
+ </div>
+ <div>
+ <a href="RoomService.html" target="_BLANK">
+ <b>RoomService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>RoomService contains methods to manipulate rooms and create
+ invitation hash
+ </i>
+ </div>
+ </div>
+ <div>
+ <a href="FileService.html" target="_BLANK">
+ <b>FileService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>Contains methods to import and upload files into the Files
+ section of the
+ conference room and the personal drive of any user
+ </i>
+ </div>
+ </div>
+ <div>
+ <a href="CalendarService.html" target="_BLANK">
+ <b>CalendarService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>CalendarService contains methods to create, edit delete
+ calendar meetings
+ </i>
+ </div>
+ </div>
+ <div>
+ <a href="JabberService.html" target="_BLANK">
+ <b>JabberService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>The Service contains methods necessary for OM to Jabber integration.
+ All methods doesn't require admin privileges to get called.
+ </i>
+ </div>
+ </div>
</div>
</blockquote>
</p>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/UserService.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/UserService.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/UserService.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/UserService.html Fri Mar 30 03:00:43 2012
@@ -31,7 +31,7 @@ limitations under the License.
<h3>Available WebServices:</h3>
- <iframe src="WebserviceIndex.html" width="100%" height="140" name="WebserviceIndex.html"
+ <iframe src="WebserviceIndex.html" width="100%" height="180" name="WebserviceIndex.html"
scrolling="no" marginheight="0" marginwidth="0" frameborder="0">
<p>Your Browser does not support frames ...</p>
</iframe>
Modified: incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/WebserviceIndex.html Fri Mar 30 03:00:43 2012
@@ -31,13 +31,8 @@ limitations under the License.
<div class="navigation">
<div>
- <a href="UserService.html" target="_PARENT"><b>UserService</b></a><br/>
- <div class="navigation_comment"><i >The Service contains methods to login and create hash to directly enter
- conference rooms, recordings or the application in general</i></div>
- </div>
- <div>
- <a href="RoomService.html" target="_PARENT"><b>RoomService</b></a><br/>
- <div class="navigation_comment"><i >RoomService contains methods to manipulate rooms and create invitation hash</i></div>
+ <a href="CalendarService.html" target="_PARENT"><b>CalendarService</b></a><br/>
+ <div class="navigation_comment"><i >CalendarService contains methods to create, edit delete calendar meetings</i></div>
</div>
<div>
<a href="FileService.html" target="_PARENT"><b>FileService</b></a><br/>
@@ -45,8 +40,17 @@ limitations under the License.
conference room and the personal drive of any user</i></div>
</div>
<div>
- <a href="CalendarService.html" target="_PARENT"><b>CalendarService</b></a><br/>
- <div class="navigation_comment"><i >CalendarService contains methods to create, edit delete calendar meetings</i></div>
+ <a href="JabberService.html" target="_PARENT"><b>JabberService</b></a><br/>
+ <div class="navigation_comment"><i >This class provides method implementations necessary for OM to Jabber integration.</i></div>
+ </div>
+ <div>
+ <a href="RoomService.html" target="_PARENT"><b>RoomService</b></a><br/>
+ <div class="navigation_comment"><i >RoomService contains methods to manipulate rooms and create invitation hash</i></div>
+ </div>
+ <div>
+ <a href="UserService.html" target="_PARENT"><b>UserService</b></a><br/>
+ <div class="navigation_comment"><i >The Service contains methods to login and create hash to directly enter
+ conference rooms, recordings or the application in general</i></div>
</div>
</div>
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebService.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebService.java?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebService.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebService.java Fri Mar 30 03:00:43 2012
@@ -17,6 +17,13 @@ import org.red5.logging.Red5LoggerFactor
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
+/**
+ * This class provides method implementations necessary for OM to Jabber integration.
+ *
+ * @author solomax
+ * @webservice JabberService
+ *
+ */
public class JabberWebService {
private static final Logger log = Red5LoggerFactory.getLogger(
JabberWebService.class, OpenmeetingsVariables.webAppRootKey);
@@ -32,6 +39,13 @@ public class JabberWebService {
@Autowired
private Invitationmanagement invitationManagement;
+ /**
+ * Get List<Rooms> of all rooms available to the user.
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from UserService.getSession
+ * @return List<Rooms> of Rooms
+ */
public List<Rooms> getAvailableRooms(String SID) {
log.debug("getAvailableRooms enter");
@@ -61,6 +75,14 @@ public class JabberWebService {
return result;
}
+ /**
+ * Returns the count of users currently in the Room with given id
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from UserService.getSession
+ * @param roomId id of the room to get users
+ * @return number of users as int
+ */
public int getUserCount(String SID, Long roomId) {
Long users_id = this.sessionManagement.checkSession(SID);
Long user_level = this.userManagement.getUserLevelByID(users_id);
@@ -72,6 +94,15 @@ public class JabberWebService {
return -1;
}
+ /**
+ * Get invitation hash for the room with given id
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from UserService.getSession
+ * @param username The name of invited user, will be displayed in the rooms user list
+ * @param room_id id of the room to get users
+ * @return hash to enter the room
+ */
public String getInvitationHash(String SID, String username, Long room_id) {
Long users_id = this.sessionManagement.checkSession(SID);
Long user_level = this.userManagement.getUserLevelByID(users_id);
Modified: incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebServiceFacade.java
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebServiceFacade.java?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebServiceFacade.java (original)
+++ incubator/openmeetings/trunk/singlewebapp/src/org/openmeetings/axis/services/JabberWebServiceFacade.java Fri Mar 30 03:00:43 2012
@@ -11,6 +11,12 @@ import org.slf4j.Logger;
import org.springframework.context.ApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;
+/**
+ * This class provides method entry points necessary for OM to Jabber integration.
+ *
+ * @author solomax
+ *
+ */
public class JabberWebServiceFacade {
private static final Logger log = Red5LoggerFactory
.getLogger(JabberWebServiceFacade.class,
@@ -34,16 +40,38 @@ public class JabberWebServiceFacade {
return null;
}
- @SuppressWarnings("cast")
+ /**
+ * Get array of all rooms available to the user.
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from {@link UserWebService.getSession}
+ * @return array of Rooms
+ */
public Rooms[] getAvailableRooms(String SID) {
- return ((Rooms[]) getJabberServiceProxy().getAvailableRooms(SID)
- .toArray(new Rooms[0]));
+ return getJabberServiceProxy().getAvailableRooms(SID).toArray(new Rooms[0]);
}
+ /**
+ * Returns the count of users currently in the Room with given id
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from {@link UserWebService.getSession}
+ * @param roomId id of the room to get users
+ * @return number of users as int
+ */
public int getUserCount(String SID, Long roomId) {
return getJabberServiceProxy().getUserCount(SID, roomId);
}
+ /**
+ * Get invitation hash for the room with given id
+ * No admin rights are necessary for this call
+ *
+ * @param SID The SID from {@link UserWebService.getSession}
+ * @param username The name of invited user, will be displayed in the rooms user list
+ * @param room_id id of the room to get users
+ * @return hash to enter the room
+ */
public String getInvitationHash(String SID, String username, Long room_id) {
return getJabberServiceProxy()
.getInvitationHash(SID, username, room_id);
Modified: incubator/openmeetings/trunk/singlewebapp/xdocs/SoapRestAPI.xml
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/xdocs/SoapRestAPI.xml?rev=1307221&r1=1307220&r2=1307221&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/xdocs/SoapRestAPI.xml (original)
+++ incubator/openmeetings/trunk/singlewebapp/xdocs/SoapRestAPI.xml Fri Mar 30 03:00:43 2012
@@ -67,6 +67,17 @@
</i>
</div>
</div>
+ <div>
+ <a href="JabberService.html" target="_BLANK">
+ <b>JabberService</b>
+ </a>
+ <br />
+ <div style="margin-left:20px">
+ <i>The Service contains methods necessary for OM to Jabber integration.
+ All methods doesn't require admin privileges to get called.
+ </i>
+ </div>
+ </div>
</div>
</section>