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 2018/02/23 01:55:00 UTC
[openmeetings] branch 4.0.x updated: no jira: javadocs are updated,
SIP documentation is updated
This is an automated email from the ASF dual-hosted git repository.
solomax pushed a commit to branch 4.0.x
in repository https://gitbox.apache.org/repos/asf/openmeetings.git
The following commit(s) were added to refs/heads/4.0.x by this push:
new 5bc6e47 no jira: javadocs are updated, SIP documentation is updated
5bc6e47 is described below
commit 5bc6e474f068bbddfb3e0b2cc2e4c656c18ba8d8
Author: Maxim Solodovnik <so...@gmail.com>
AuthorDate: Fri Feb 23 08:54:14 2018 +0700
no jira: javadocs are updated, SIP documentation is updated
---
.../screenshare/gui/ScreenSharerFrame.java | 7 +-
.../src/site/xdoc/red5sip-integration_2.0.xml | 178 -----------
.../src/site/xdoc/red5sip-integration_2.1.xml | 325 ---------------------
.../src/site/xdoc/red5sip-integration_3.0.xml | 311 --------------------
.../src/site/xdoc/red5sip-integration_3.1.xml | 305 -------------------
.../src/site/xdoc/red5sip-integration_3.3.xml | 317 --------------------
.../src/site/xdoc/red5sip-integration_4.0.xml | 316 --------------------
.../src/site/xdoc/voip-sip-integration.xml | 310 ++++++++++++++++++--
.../openmeetings/web/admin/AdminBaseForm.java | 34 +--
.../openmeetings/web/admin/SearchableDataView.java | 2 +-
.../openmeetings/web/admin/labels/LangForm.java | 7 +-
.../apache/openmeetings/web/common/BasePanel.java | 7 +-
.../web/common/ConfirmableAjaxBorder.java | 8 +-
.../web/data/SearchableDataProvider.java | 2 +-
.../web/room/OmRedirectTimerBehavior.java | 2 +-
.../web/user/calendar/CalendarDialog.java | 8 +
.../openmeetings/web/user/chat/ChatToolbar.java | 4 +
.../openmeetings/web/user/rooms/RoomListPanel.java | 10 +-
18 files changed, 344 insertions(+), 1809 deletions(-)
diff --git a/openmeetings-screenshare/src/main/java/org/apache/openmeetings/screenshare/gui/ScreenSharerFrame.java b/openmeetings-screenshare/src/main/java/org/apache/openmeetings/screenshare/gui/ScreenSharerFrame.java
index 24aed00..c697c08 100644
--- a/openmeetings-screenshare/src/main/java/org/apache/openmeetings/screenshare/gui/ScreenSharerFrame.java
+++ b/openmeetings-screenshare/src/main/java/org/apache/openmeetings/screenshare/gui/ScreenSharerFrame.java
@@ -31,7 +31,6 @@ import java.awt.SystemColor;
import java.awt.Toolkit;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
-import java.io.IOException;
import javax.swing.BorderFactory;
import javax.swing.GroupLayout;
@@ -227,8 +226,10 @@ public class ScreenSharerFrame extends JFrame {
/**
* Create the frame.
- * @throws AWTException
- * @throws IOException
+ *
+ * @param core - core object
+ * @param textLabels - translated labels
+ * @throws AWTException - in case of AWT exception
*/
public ScreenSharerFrame(final Core core, String[] textLabels) throws AWTException {
this.core = core;
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_2.0.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_2.0.xml
deleted file mode 100644
index a874f77..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_2.0.xml
+++ /dev/null
@@ -1,178 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
-
- <body>
-
- <section name="SIP-Transport Integration">
- <p>
- You need minimum version 2.0 of Apache OpenMeetings to apply this guide!
- </p>
- <p>
- Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 10.04.
- </p>
- </section>
-
- <section name="Setup Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update
-sudo apt-get install asterisk asterisk-mysql
-]]>
- </source>
- </div>
- <div>
- Ubuntu 10.04 has broken asterisk-mysql version. For other distribution next commands not needed:
- <source>
-<![CDATA[
-aptitude purge asterisk-mysql
-cd /tmp
-apt-get build-dep asterisk-mysql
-apt-get -b source asterisk-mysql
-dpkg -i asterisk-mysql_1.6.2.0-1_i386.deb
-]]>
- </source>
- </div>
- <div>
- Enable asterisk mysql realtime module:<br/><br/>
- Add string
- <source>
-<![CDATA[
-load => res_config_mysql.so
-]]>
- </source>
- to the /etc/asterisk/modules.conf into the "modules" section.
- </div>
- <div>
- Configure mysql realtime module:<br/><br/>
-
- Create file /etc/asterisk/res_mysql.conf and add lines:
- <source>
-<![CDATA[
-[general]
-dbhost=127.0.0.1
-dbname=openmeetings
-dbuser=root
-dbpass=
-dbport=3306
-]]>
- </source>
- </div>
- <div>
- Add next lines into the /etc/asterisk/extconfig.conf:
- <source>
-<![CDATA[
-[settings]
-sipusers => mysql,general,sipusers
-sippeers => mysql,general,sipusers
-extensions => mysql,general,extensions
-meetme => mysql,general,meetme
-]]>
- </source>
- </div>
- <div>
- Add next lines into the /etc/asterisk/extensions.conf:
- <source>
-<![CDATA[
-[rooms]
-switch => Realtime/@
-]]>
- </source>
- </div>
-
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- Insert, for example, SIP user with name 'test':
- <source>
-<![CDATA[
-INSERT INTO sipusers (allow, context, disallow, host, name, secret) VALUES ('ulaw' , 'rooms', NULL, 'dynamic' , 'test', '12345');
-]]>
- </source>
- </div>
- </section>
-
- <section name="Setup red5sip transport">
- <div>
- Download red5sip from<tt>http://red5phone.googlecode.com/svn/branches/red5sip</tt>
- </div>
- <p>
- Build with Apache Ant
- </p>
- <div>
- Install jsvc:
- <source>
-<![CDATA[
-apt-get install jsvc
-]]>
- </source>
- </div>
- <div>
- Insert proper values to the /opt/red5sip/settings.properties
-
- <source>
-<![CDATA[
-red5.host - red5 server address (127.0.0.1)
-sip.obproxy - asterisk adderss (127.0.0.1)
-sip.phone - sip phone number (test)
-sip.authid - sip auth id (test)
-sip.secret - sip password (12345)
-sip.realm - sip realm, "asterisk" by default
-sip.proxy -
-rooms - ids of openmeetings rooms, can be, for example, 2,3,5,6
-]]>
- </source>
- </div>
- <div>
- Add red5sip to autostart:
- <source>
-<![CDATA[
-ln -s /opt/red5sip/red5sip.sh /etc/init.d/red5sip
-chmod a+x /etc/init.d/red5sip
-update-rc.d /etc/init.d/red5sip defaults
-]]>
- </source>
- </div>
- <div>
- Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </div>
- <div>
- Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </div>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_2.1.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_2.1.xml
deleted file mode 100644
index 2693adf..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_2.1.xml
+++ /dev/null
@@ -1,325 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
- <body>
- <section name="SIP-Transport Integration">
- <p>You need Apache OpenMeetings <strong>version 2.1</strong> to apply this guide!</p>
- <p>You need Asterisk <strong>version 11</strong> to apply this guide!</p>
- <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 12.10.</p>
- </section>
- <section name="Prerequisites">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update && sudo apt-get upgrade
-sudo apt-get install build-essential linux-headers-`uname -r` libxml2-dev libncurses5-dev libsqlite3-dev sqlite3 openssl libssl-dev
-]]>
- </source>
- </div>
- </section>
- <section name="ODBC Setup">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update
-sudo apt-get install unixODBC unixODBC-dev libmyodbc
-]]>
- </source>
- </div>
- <div>
- Set up Asterisk connector:<br /><br />
- Modify file <tt>/etc/odbc.ini</tt> as follows: (replace USER, PASSWORD and Socket with values relative to your system)
- <source>
-<![CDATA[
-[asterisk-connector]
-Description = MySQL connection to 'openmeetings' database
-Driver = MySQL
-Database = openmeetings
-Server = localhost
-USER = root
-PASSWORD =
-Port = 3306
-Socket = /var/run/mysqld/mysqld.sock
-]]>
- </source>
- Modify file <tt>/etc/odbcinst.ini</tt> as follows: (replace the path to the *.so files below with the real paths on your system)<br/>
- (The path below is for x32 server, x64 version is most probably located at <tt>/usr/lib/x86_64-linux-gnu/odbc</tt>)<br/>
- <source>
-<![CDATA[
-[MySQL]
-Description = ODBC for MySQL
-Driver = /usr/lib/i386-linux-gnu/odbc/libmyodbc.so
-Setup = /usr/lib/i386-linux-gnu/odbc/libodbcmyS.so
-FileUsage = 1
-]]>
- </source>
- Run the following command to ensure everything works as expected:
- <source>
-<![CDATA[
-echo "select 1" | isql -v asterisk-connector
-]]>
- </source>
- </div>
- </section>
- <section name="Building and setting up Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
-sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-11.2.1.tar.gz
-sudo tar -xvzf asterisk-11.2.1.tar.gz
-cd ./asterisk-11.2.1
-sudo make clean
-sudo ./configure
-sudo make
-sudo make install
-sudo make samples
-sudo make config
-sudo service asterisk start
-]]>
- </source>
- </div>
- </section>
- <section name="Configure Asterisk">
- <div>
- Enable asterisk ODBC module:<br /><br />
- Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
- <strong>Add/uncomment the following lines</strong>
- <source>
-<![CDATA[
-preload => res_odbc.so
-preload => res_config_odbc.so
-]]>
- </source>
- </div><br />
- <div>
- Create/update "[asterisk]" section in <tt>/etc/asterisk/res_odbc.conf</tt>:
- <source>
-<![CDATA[
-[asterisk]
-enabled => yes
-dsn => asterisk-connector
-pre-connect => yes
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/sip.conf</tt><br />
- <strong>Add/uncomment the following line</strong>:<br />
- <source>
-<![CDATA[
-videosupport=yes
-rtcachefriends=yes
-]]>
- </source>
- <strong>Increase maxexpiry value to 43200</strong>:<br />
- <source>
-<![CDATA[
-maxexpiry=43200
-]]>
- </source>
- <strong>Add user for the "SIP Transport"</strong>:<br />
- <source>
-<![CDATA[
-[red5sip_user]
-type=friend
-secret=12345
-disallow=all
-allow=ulaw
-allow=h264
-host=dynamic
-nat=force_rport,comedia
-context=rooms-red5sip
-]]>
- </source>
- </div><br />
- <div>
- Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
- <source>
-<![CDATA[
-[settings]
-sippeers => odbc,asterisk,sipusers
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/extensions.conf</tt><br />
- <strong>Add the following section</strong>:<br />
- <source>
-<![CDATA[
-[rooms]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
-exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
-exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
-exten => _400X!,n,Hangup
-exten => _400X!,n(notavail),Answer()
-exten => _400X!,n,Playback(invalid)
-exten => _400X!,n,Hangup
-
-[rooms-originate]
-exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
-exten => _400X!,n,Hangup
-
-[rooms-out]
-; *****************************************************
-; Extensions for outgoing calls from Openmeetings room.
-; *****************************************************
-
-[rooms-red5sip]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
-exten => _400X!,n(notavail),Hangup
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
- <strong>Add/Modify the following secions</strong>:<br />
- <source>
-<![CDATA[
-[general]
-
-[red5sip_user]
-type=user
-marked=yes
-dsp_drop_silence=yes
-denoise=true
-
-[sip_user]
-type=user
-end_marked=yes
-wait_marked=yes
-music_on_hold_when_empty=yes
-dsp_drop_silence=yes
-denoise=true
-
-[default_bridge]
-type=bridge
-video_mode=follow_talker
-]]>
- </source>
- </div><br />
- <div>
- To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
- <strong>Add/Modify the following sections</strong>:<br />
- <source>
-<![CDATA[
-[general]
-enabled = yes
-webenabled = no
-port = 5038
-bindaddr = 127.0.0.1
-
-[openmeetings]
-secret = 12345
-deny=0.0.0.0/0.0.0.0
-permit=127.0.0.1/255.255.255.0
-read = all
-write = all
-]]>
- </source>
- </div><br />
- <div>
- Update Openmeetings with creadentials for Asterisk manager.
- Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/openmeetings-applicationContext.xml</tt><br />
- find <strong><bean id="sipDao" class="org.apache.openmeetings.data.conference.dao.SipDao"></strong>
- uncomment its parameters and set it to your custom values.
- <p style="font-size: larger; color: blue;">
- IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
- otherwise all SIP related room information will be lost
- </p>
- </div><br />
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- </div><br />
- </section>
-
- <section name="Setup red5sip transport">
- <div>
- Download red5sip from <tt>http://red5phone.googlecode.com/svn/branches/red5sip_2.1</tt>
- </div>
- <div>
- Build with Apache Ant
- <source>
-<![CDATA[
-ant
-]]>
- </source>
- </div>
- <div>
- Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
-
- <source>
-<![CDATA[
-red5.host=127.0.0.1 # red5 server address
-om.context=openmeetings # Openmeetings context
-red5.codec=asao
-red5.codec.rate=22 # should correlate with mic settings in public/config.xml
-sip.obproxy=127.0.0.1 # asterisk adderss
-sip.phone=red5sip_user # sip phone number
-sip.authid=red5sip_user # sip auth id
-sip.secret=12345 # sip password
-sip.realm=asterisk # sip realm
-sip.proxy=127.0.0.1 # address of sip proxy
-rooms.forceStart=no # TBD
-rooms=1 # TBD (not in use)
-]]>
- </source>
- </div>
- <div>
- Add red5sip to autostart:
- <source>
-<![CDATA[
-sudo cp /opt/red5sip/red5sip /etc/init.d/
-sudo chmod a+x /etc/init.d/red5sip
-sudo update-rc.d red5sip defaults
-]]>
- </source>
- </div>
- <div>
- Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </div>
- <div>
- Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </div>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_3.0.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_3.0.xml
deleted file mode 100644
index 9581c2d..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_3.0.xml
+++ /dev/null
@@ -1,311 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
- <body>
- <section name="SIP-Transport Integration">
- <p>You need Apache OpenMeetings <strong>version 3.0+</strong> to apply this guide!</p>
- <p>You need Asterisk <strong>version 13+</strong> to apply this guide!</p>
- <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 12.10.</p>
- </section>
- <section name="Prerequisites">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update && sudo apt-get upgrade
-]]>
- </source>
- </div>
- </section>
- <section name="Building and setting up Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
-sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-13.9.0.tar.gz
-sudo tar -xvzf asterisk-13.9.0.tar.gz
-cd ./asterisk-13.9.0
-sudo make clean
-sudo contrib/scripts/install_prereq install
-sudo ./configure
-sudo make menuconfig
-]]>
- </source>
- Make sure you have selected <tt>Add-ons -> res_config_mysql</tt>, Press F12 to save
- <source>
-<![CDATA[
-sudo make
-sudo make install
-sudo make samples
-sudo make config
-sudo service asterisk start
-]]>
- </source>
- </div>
- </section>
- <section name="Configure Asterisk">
- <div>
- Enable asterisk MySQL module:<br /><br />
- Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
- <strong>Add/uncomment the following lines</strong>
- <source>
-<![CDATA[
-preload => res_config_mysql.so
-]]>
- </source>
- </div><br />
- <div>
- Configure MySQL module:<br /><br />
- Set valid data for MySQL in <tt>/etc/asterisk/res_config_mysql.conf</tt> :<br />
- <strong>Example</strong>
- <source>
-<![CDATA[
-[general]
-dbhost = 127.0.0.1
-dbname = openmeetings
-dbuser = root
-dbpass =
-dbport = 3306
-dbsock = /var/lib/mysql/mysql.sock
-dbcharset = utf8
-requirements=warn
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/sip.conf</tt><br />
- <strong>Add/uncomment the following line</strong>:<br />
- <source>
-<![CDATA[
-videosupport=yes
-rtcachefriends=yes
-]]>
- </source>
- <strong>Increase maxexpiry value to 43200</strong>:<br />
- <source>
-<![CDATA[
-maxexpiry=43200
-]]>
- </source>
- <strong>Add user for the "SIP Transport"</strong>:<br />
- <source>
-<![CDATA[
-[red5sip_user]
-type=friend
-secret=12345
-disallow=all
-allow=ulaw
-allow=h263
-host=dynamic
-nat=force_rport,comedia
-context=rooms-red5sip
-]]>
- </source>
- </div><br />
- <div>
- Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
- <source>
-<![CDATA[
-[settings]
-sippeers => mysql,general,sipusers
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/extensions.conf</tt><br />
- <strong>Add the following section</strong>:<br />
- <source>
-<![CDATA[
-; *****************************************************
-; The below dial plan is used to dial into a Openmeetings Conference room
-; The first line DB_EXISTS(openmeetings/room/ does not belong to the openmeetings application but is the name of astDB containing the astDB family/key pair and values
-; To Check if your astDB has been created do the following in a terminal window type the following:
-; asterisk –rx “database show”
-; If you do not receive an output with that resembles openmeetings/rooms/400## where “##” will equal the extension assigned when you created your room
-; If you do not receive the above output check your parameters in /opt/red5/webapps/openmeetings/WEB-INF/classes/openmeetings-applicationContext.xml
-; Go back into the Administrator Panel and remove the PIN number in each room save the record with no PIN number and then re-enter the pin again resave the record.
-; *****************************************************
-
-[rooms]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
-exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
-exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
-exten => _400X!,n,Hangup
-exten => _400X!,n(notavail),Answer()
-exten => _400X!,n,Playback(invalid)
-exten => _400X!,n,Hangup
-
-[rooms-originate]
-exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
-exten => _400X!,n,Hangup
-
-[rooms-out]
-; *****************************************************
-; Extensions for outgoing calls from Openmeetings room.
-; *****************************************************
-
-[rooms-red5sip]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
-exten => _400X!,n(notavail),Hangup
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
- <strong>Add/Modify the following secions</strong>:<br />
- <source>
-<![CDATA[
-[general]
-
-[red5sip_user]
-type=user
-marked=yes
-dsp_drop_silence=yes
-denoise=true
-
-[sip_user]
-type=user
-end_marked=yes
-wait_marked=yes
-music_on_hold_when_empty=yes
-dsp_drop_silence=yes
-denoise=true
-
-[default_bridge]
-type=bridge
-video_mode=follow_talker
-]]>
- </source>
- </div><br />
- <div>
- To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
- <strong>Add/Modify the following sections</strong>:<br />
- <source>
-<![CDATA[
-[general]
-enabled = yes
-webenabled = no
-port = 5038
-bindaddr = 127.0.0.1
-
-[openmeetings]
-secret = 12345
-deny=0.0.0.0/0.0.0.0
-permit=127.0.0.1/255.255.255.0
-read = all
-write = all
-]]>
- </source>
- </div><br />
- <div>
- Update Openmeetings with creadentials for Asterisk manager.
- Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/classes/openmeetings-applicationContext.xml</tt><br />
- find <strong><bean id="sipDao" class="org.apache.openmeetings.db.dao.room.SipDao"></strong>
- uncomment its parameters and set it to your custom values.
- <p style="font-size: larger; color: blue;">
- IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
- otherwise all SIP related room information will be lost
- </p>
- </div><br />
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- </div><br />
- </section>
-
- <section name="Setup red5sip transport">
- <div>
- Download red5sip from <tt>https://github.com/solomax/red5phone/tree/red5sip_3.0</tt>, switch to the branch red5sip_3.0
- </div>
- <div>
- switch to the branch red5sip_3.0
- <source>
-<![CDATA[
-git clone https://github.com/solomax/red5phone.git
-git checkout red5sip_3.0
-]]>
- </source>
- </div>
- <div>
- Build with Apache Ant
- <source>
-<![CDATA[
-ant
-]]>
- </source>
- </div>
- <div>
- Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
-
- <source>
-<![CDATA[
-red5.host=127.0.0.1 # red5 server address
-om.context=openmeetings # Openmeetings context
-red5.codec=asao
-red5.codec.rate=22 # should correlate with mic settings in public/config.xml
-sip.obproxy=127.0.0.1 # asterisk adderss
-sip.phone=red5sip_user # sip phone number
-sip.authid=red5sip_user # sip auth id
-sip.secret=12345 # sip password
-sip.realm=asterisk # sip realm
-sip.proxy=127.0.0.1 # address of sip proxy
-rooms.forceStart=no # TBD
-rooms=1 # TBD (not in use)
-]]>
- </source>
- </div>
- <div>
- Add red5sip to autostart:
- <source>
-<![CDATA[
-sudo cp /opt/red5sip/red5sip /etc/init.d/
-sudo chmod a+x /etc/init.d/red5sip
-sudo update-rc.d red5sip defaults
-]]>
- </source>
- </div>
- <div>
- Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </div>
- <div>
- Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </div>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_3.1.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_3.1.xml
deleted file mode 100644
index 33c6d80..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_3.1.xml
+++ /dev/null
@@ -1,305 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
- <body>
- <section name="SIP-Transport Integration">
- <p>You need Apache OpenMeetings <strong>version 3.1+</strong> to apply this guide!</p>
- <p>You need Asterisk <strong>version 13+</strong> to apply this guide!</p>
- <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 12.10.</p>
- </section>
- <section name="Prerequisites">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update && sudo apt-get upgrade
-]]>
- </source>
- </div>
- </section>
- <section name="Building and setting up Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
-sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-13.9.0.tar.gz
-sudo tar -xvzf asterisk-13.9.0.tar.gz
-cd ./asterisk-13.9.0
-sudo make clean
-sudo contrib/scripts/install_prereq install
-sudo ./configure
-sudo make menuconfig
-]]>
- </source>
- Make sure you have selected <tt>Add-ons -> res_config_mysql</tt>, Press F12 to save
- <source>
-<![CDATA[
-sudo make
-sudo make install
-sudo make samples
-sudo make config
-sudo service asterisk start
-]]>
- </source>
- </div>
- </section>
- <section name="Configure Asterisk">
- <div>
- Enable asterisk MySQL module:<br /><br />
- Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
- <strong>Add/uncomment the following lines</strong>
- <source>
-<![CDATA[
-preload => res_config_mysql.so
-]]>
- </source>
- </div><br />
- <div>
- Configure MySQL module:<br /><br />
- Set valid data for MySQL in <tt>/etc/asterisk/res_config_mysql.conf</tt> :<br />
- <strong>Example</strong>
- <source>
-<![CDATA[
-[general]
-dbhost = 127.0.0.1
-dbname = openmeetings
-dbuser = root
-dbpass =
-dbport = 3306
-dbsock = /var/lib/mysql/mysql.sock
-dbcharset = utf8
-requirements=warn
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/sip.conf</tt><br />
- <strong>Add/uncomment the following line</strong>:<br />
- <source>
-<![CDATA[
-videosupport=yes
-rtcachefriends=yes
-]]>
- </source>
- <strong>Increase maxexpiry value to 43200</strong>:<br />
- <source>
-<![CDATA[
-maxexpiry=43200
-]]>
- </source>
- <strong>Add user for the "SIP Transport"</strong>:<br />
- <source>
-<![CDATA[
-[red5sip_user]
-type=friend
-secret=12345
-disallow=all
-allow=ulaw
-allow=h263
-host=dynamic
-nat=force_rport,comedia
-context=rooms-red5sip
-]]>
- </source>
- </div><br />
- <div>
- Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
- <source>
-<![CDATA[
-[settings]
-sippeers => mysql,general,sipusers
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/extensions.conf</tt><br />
- <strong>Add the following section</strong>:<br />
- <source>
-<![CDATA[
-; *****************************************************
-; The below dial plan is used to dial into a Openmeetings Conference room
-; The first line DB_EXISTS(openmeetings/room/ does not belong to the openmeetings application but is the name of astDB containing the astDB family/key pair and values
-; To Check if your astDB has been created do the following in a terminal window type the following:
-; asterisk –rx “database show”
-; If you do not receive an output with that resembles openmeetings/rooms/400## where “##” will equal the extension assigned when you created your room
-; If you do not receive the above output check your parameters in /opt/red5/webapps/openmeetings/WEB-INF/classes/openmeetings-applicationContext.xml
-; Go back into the Administrator Panel and remove the PIN number in each room save the record with no PIN number and then re-enter the pin again resave the record.
-; *****************************************************
-
-[rooms]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
-exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
-exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
-exten => _400X!,n,Hangup
-exten => _400X!,n(notavail),Answer()
-exten => _400X!,n,Playback(invalid)
-exten => _400X!,n,Hangup
-
-[rooms-originate]
-exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
-exten => _400X!,n,Hangup
-
-[rooms-out]
-; *****************************************************
-; Extensions for outgoing calls from Openmeetings room.
-; *****************************************************
-
-[rooms-red5sip]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
-exten => _400X!,n(notavail),Hangup
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
- <strong>Add/Modify the following secions</strong>:<br />
- <source>
-<![CDATA[
-[general]
-
-[red5sip_user]
-type=user
-marked=yes
-dsp_drop_silence=yes
-denoise=true
-
-[sip_user]
-type=user
-end_marked=yes
-wait_marked=yes
-music_on_hold_when_empty=yes
-dsp_drop_silence=yes
-denoise=true
-
-[default_bridge]
-type=bridge
-video_mode=follow_talker
-]]>
- </source>
- </div><br />
- <div>
- To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
- <strong>Add/Modify the following sections</strong>:<br />
- <source>
-<![CDATA[
-[general]
-enabled = yes
-webenabled = no
-port = 5038
-bindaddr = 127.0.0.1
-
-[openmeetings]
-secret = 12345
-deny=0.0.0.0/0.0.0.0
-permit=127.0.0.1/255.255.255.0
-read = all
-write = all
-]]>
- </source>
- </div><br />
- <div>
- Update OpenMeetings with credentials for Asterisk manager.
- Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/classes/openmeetings-applicationContext.xml</tt><br />
- find <strong><bean id="sipDao" class="org.apache.openmeetings.db.dao.room.SipDao"></strong>
- uncomment its parameters and set it to your custom values.
- <p style="font-size: larger; color: blue;">
- IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
- otherwise all SIP related room information will be lost
- </p>
- </div><br />
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- </div><br />
- </section>
-
- <section name="Setup red5sip transport">
- <ul>
- <li>Download red5sip from <tt>https://github.com/openmeetings/red5sip</tt>
- <source>
-<![CDATA[
-git clone https://github.com/openmeetings/red5sip.git
-git checkout red5sip_3.1
-]]>
- </source>
- </li>
- <li>Build with Apache Maven
- <source>
-<![CDATA[
-cd red5sip
-mvn clean package
-]]>
- </source>
- </li>
- <li>All necessary files will be available in <tt>target</tt> folder, copy/move it to /opt/red5sip/</li>
- <li>Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
- <source>
-<![CDATA[
-red5.host=127.0.0.1 # red5 server address
-om.context=openmeetings # Openmeetings context
-red5.codec=asao
-red5.codec.rate=22 # should correlate with mic settings in public/config.xml
-sip.obproxy=127.0.0.1 # asterisk adderss
-sip.phone=red5sip_user # sip phone number
-sip.authid=red5sip_user # sip auth id
-sip.secret=12345 # sip password
-sip.realm=asterisk # sip realm
-sip.proxy=127.0.0.1 # address of sip proxy
-rooms.forceStart=no # TBD
-rooms=1 # TBD (not in use)
-]]>
- </source>
- </li>
- <li>Add red5sip to autostart:
- <source>
-<![CDATA[
-sudo cp /opt/red5sip/red5sip /etc/init.d/
-sudo chmod a+x /etc/init.d/red5sip
-sudo update-rc.d red5sip defaults
-]]>
- </source>
- </li>
- <li>Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </li>
- <li>Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </li>
- </ul>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_3.3.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_3.3.xml
deleted file mode 100644
index 51b0d3d..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_3.3.xml
+++ /dev/null
@@ -1,317 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
- <body>
- <section name="SIP-Transport Integration">
- <p>You need Apache OpenMeetings <strong>version 3.1+</strong> to apply this guide!</p>
- <p>You need Asterisk <strong>version 13+</strong> to apply this guide!</p>
- <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 16.04.</p>
- </section>
- <section name="Prerequisites">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update && sudo apt-get upgrade
-]]>
- </source>
- </div>
- </section>
- <section name="Building and setting up Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
-sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-13.9.0.tar.gz
-sudo tar -xvzf asterisk-13.9.0.tar.gz
-cd ./asterisk-13.9.0
-sudo make clean
-sudo contrib/scripts/install_prereq install
-sudo ./configure
-sudo make menuconfig
-]]>
- </source>
- Make sure you have selected <tt>Add-ons -> res_config_mysql</tt>, Press F12 to save
- <source>
-<![CDATA[
-sudo make
-sudo make install
-sudo make samples
-sudo make config
-sudo service asterisk start
-]]>
- </source>
- </div>
- </section>
- <section name="Configure Asterisk">
- <div>
- Enable asterisk MySQL module:<br /><br />
- Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
- <strong>Add/uncomment the following lines</strong>
- <source>
-<![CDATA[
-preload => res_config_mysql.so
-]]>
- </source>
- </div><br />
- <div>
- Configure MySQL module:<br /><br />
- Set valid data for MySQL in <tt>/etc/asterisk/res_config_mysql.conf</tt> :<br />
- <strong>Example</strong>
- <source>
-<![CDATA[
-[general]
-dbhost = 127.0.0.1
-dbname = openmeetings
-dbuser = root
-dbpass =
-dbport = 3306
-dbsock = /var/lib/mysql/mysql.sock
-dbcharset = utf8
-requirements=warn
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/sip.conf</tt><br />
- <strong>Add/uncomment the following line</strong>:<br />
- <source>
-<![CDATA[
-videosupport=yes
-rtcachefriends=yes
-]]>
- </source>
- <strong>Increase maxexpiry value to 43200</strong>:<br />
- <source>
-<![CDATA[
-maxexpiry=43200
-]]>
- </source>
- <strong>Add user for the "SIP Transport"</strong>:<br />
- <source>
-<![CDATA[
-[red5sip_user]
-type=friend
-secret=12345
-disallow=all
-allow=ulaw
-allow=h263
-host=dynamic
-nat=force_rport,comedia
-context=rooms-red5sip
-]]>
- </source>
- </div><br />
- <div>
- Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
- <source>
-<![CDATA[
-[settings]
-sippeers => mysql,general,sipusers
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/extensions.conf</tt><br />
- <strong>Add the following section</strong>:<br />
- <source>
-<![CDATA[
-; *****************************************************
-; The below dial plan is used to dial into a Openmeetings Conference room
-; The first line DB_EXISTS(openmeetings/room/ does not belong to the openmeetings application but is the name of astDB containing the astDB family/key pair and values
-; To Check if your astDB has been created do the following in a terminal window type the following:
-; asterisk –rx “database show”
-; If you do not receive an output with that resembles openmeetings/rooms/400## where “##” will equal the extension assigned when you created your room
-; If you do not receive the above output check your parameters in /opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml
-; Go back into the Administrator Panel and remove the PIN number in each room save the record with no PIN number and then re-enter the pin again resave the record.
-; *****************************************************
-
-[rooms]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
-exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
-exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
-exten => _400X!,n,Hangup
-exten => _400X!,n(notavail),Answer()
-exten => _400X!,n,Playback(invalid)
-exten => _400X!,n,Hangup
-
-[rooms-originate]
-exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
-exten => _400X!,n,Hangup
-
-[rooms-out]
-; *****************************************************
-; Extensions for outgoing calls from Openmeetings room.
-; *****************************************************
-
-[rooms-red5sip]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
-exten => _400X!,n(notavail),Hangup
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
- <strong>Add/Modify the following secions</strong>:<br />
- <source>
-<![CDATA[
-[general]
-
-[red5sip_user]
-type=user
-marked=yes
-dsp_drop_silence=yes
-denoise=true
-
-[sip_user]
-type=user
-end_marked=yes
-wait_marked=yes
-music_on_hold_when_empty=yes
-dsp_drop_silence=yes
-denoise=true
-
-[default_bridge]
-type=bridge
-video_mode=follow_talker
-]]>
- </source>
- </div><br />
- <div>
- To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
- <strong>Add/Modify the following sections</strong>:<br />
- <source>
-<![CDATA[
-[general]
-enabled = yes
-webenabled = no
-port = 5038
-bindaddr = 127.0.0.1
-
-[openmeetings]
-secret = 12345
-deny=0.0.0.0/0.0.0.0
-permit=127.0.0.1/255.255.255.0
-read = all
-write = all
-]]>
- </source>
- </div><br />
- <div>
- Update OpenMeetings with credentials for Asterisk manager.
- Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml</tt><br />
- find <strong><bean id="sipDao" class="org.apache.openmeetings.db.dao.room.SipDao"></strong>
- uncomment its parameters and set it to your custom values.<br/>
- set value for <tt>uid</tt> property to unique secret value (can be generated here <a href="https://www.uuidgenerator.net">https://www.uuidgenerator.net</a>)
- and sync it with <tt>settings.properties</tt> of red5sip (see below)
- <p style="font-size: larger; color: blue;">
- IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
- otherwise all SIP related room information will be lost
- </p>
- </div><br />
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- </div><br />
- </section>
-
- <section name="Setup red5sip transport">
- <ul>
- <li>Download red5sip from <tt>https://github.com/openmeetings/red5sip</tt>
- <source>
-<![CDATA[
-git clone https://github.com/openmeetings/red5sip.git
-git checkout red5sip_3.3
-]]>
- </source>
- </li>
- <li>Build with Apache Maven
- <source>
-<![CDATA[
-cd red5sip
-mvn clean package
-]]>
- </source>
- </li>
- <li>All necessary files will be available in <tt>target</tt> folder, copy/move it to /opt/red5sip/</li>
- <li>Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
- <source>
-<![CDATA[
-red5.host=127.0.0.1 # red5 server address
-om.context=openmeetings # Openmeetings context
-red5.codec=asao
-red5.codec.rate=22 # should correlate with mic settings in public/config.xml
-sip.obproxy=127.0.0.1 # asterisk adderss
-sip.phone=red5sip_user # sip phone number
-sip.authid=red5sip_user # sip auth id
-sip.secret=12345 # sip password
-sip.realm=asterisk # sip realm
-sip.proxy=127.0.0.1 # address of sip proxy
-rooms.forceStart=no # TBD
-uid=87dddad4-9ca5-475b-860f-2e0825d02b76 #can be generated here: https://www.uuidgenerator.net/
-rooms=1 # TBD (not in use)
-]]>
- </source>
- </li>
- <li>Add red5sip to autostart:
- <source>
-<![CDATA[
-sudo cp /opt/red5sip/red5sip /etc/init.d/
-sudo chmod a+x /etc/init.d/red5sip
-sudo update-rc.d red5sip defaults
-]]>
- </source>
- </li>
- <li>Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </li>
- <li>
- Enable <tt>SIP</tt> in openmeetings: <br/>
- <tt>Administration->Configuration->red5sip.enable == yes</tt>
- </li>
- <li>
- Enable SIP for particular room(s): <br/>
- <tt>Administration->Conference rooms->Room->Enable SIP transport in the room == checked</tt><br/>
- (SIP number will be assigned to room if everything is OK)
- </li>
- <li>Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </li>
- </ul>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/red5sip-integration_4.0.xml b/openmeetings-server/src/site/xdoc/red5sip-integration_4.0.xml
deleted file mode 100644
index 05973ce..0000000
--- a/openmeetings-server/src/site/xdoc/red5sip-integration_4.0.xml
+++ /dev/null
@@ -1,316 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
- -->
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>SIP-Transport Integration</title>
- <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author>
- </properties>
- <body>
- <section name="SIP-Transport Integration">
- <p>You need Apache OpenMeetings <strong>version 4.0+</strong> to apply this guide!</p>
- <p>You need Asterisk <strong>version 13+</strong> to apply this guide!</p>
- <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 16.04.</p>
- </section>
- <section name="Prerequisites">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo apt-get update && sudo apt-get upgrade
-]]>
- </source>
- </div>
- </section>
- <section name="Building and setting up Asterisk">
- <div>
- Run the commands
- <source>
-<![CDATA[
-sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
-sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-13.17.0.tar.gz
-sudo tar -xvzf asterisk-13.17.0.tar.gz
-cd ./asterisk-13.17.0
-sudo make clean
-sudo contrib/scripts/install_prereq install
-sudo ./configure
-sudo make menuconfig
-]]>
- </source>
- Make sure you have selected <tt>Add-ons -> res_config_mysql</tt>, Press F12 to save
- <source>
-<![CDATA[
-sudo make
-sudo make install
-sudo make samples
-sudo make config
-sudo service asterisk start
-]]>
- </source>
- </div>
- </section>
- <section name="Configure Asterisk">
- <div>
- Enable asterisk MySQL module:<br /><br />
- Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
- <strong>Add/uncomment the following lines</strong>
- <source>
-<![CDATA[
-preload => res_config_mysql.so
-]]>
- </source>
- </div><br />
- <div>
- Configure MySQL module:<br /><br />
- Set valid data for MySQL in <tt>/etc/asterisk/res_config_mysql.conf</tt> :<br />
- <strong>Example</strong>
- <source>
-<![CDATA[
-[general]
-dbhost = 127.0.0.1
-dbname = openmeetings
-dbuser = root
-dbpass =
-dbport = 3306
-dbsock = /var/lib/mysql/mysql.sock
-dbcharset = utf8
-requirements=warn
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/sip.conf</tt><br />
- <strong>Add/uncomment the following line</strong>:<br />
- <source>
-<![CDATA[
-videosupport=yes
-rtcachefriends=yes
-]]>
- </source>
- <strong>Increase maxexpiry value to 43200</strong>:<br />
- <source>
-<![CDATA[
-maxexpiry=43200
-]]>
- </source>
- <strong>Add user for the "SIP Transport"</strong>:<br />
- <source>
-<![CDATA[
-[red5sip_user]
-type=friend
-secret=12345
-disallow=all
-allow=ulaw
-allow=h263
-host=dynamic
-nat=force_rport,comedia
-context=rooms-red5sip
-]]>
- </source>
- </div><br />
- <div>
- Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
- <source>
-<![CDATA[
-[settings]
-sippeers => mysql,general,sipusers
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/extensions.conf</tt><br />
- <strong>Add the following section</strong>:<br />
- <source>
-<![CDATA[
-; *****************************************************
-; The below dial plan is used to dial into a Openmeetings Conference room
-; The first line DB_EXISTS(openmeetings/room/ does not belong to the openmeetings application but is the name of astDB containing the astDB family/key pair and values
-; To Check if your astDB has been created do the following in a terminal window type the following:
-; asterisk –rx “database show”
-; If you do not receive an output with that resembles openmeetings/rooms/400## where “##” will equal the extension assigned when you created your room
-; If you do not receive the above output check your parameters in /opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml
-; Go back into the Administrator Panel and remove the PIN number in each room save the record with no PIN number and then re-enter the pin again resave the record.
-; *****************************************************
-
-[rooms]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
-exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
-exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
-exten => _400X!,n,Hangup
-exten => _400X!,n(notavail),Answer()
-exten => _400X!,n,Playback(invalid)
-exten => _400X!,n,Hangup
-
-[rooms-originate]
-exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
-exten => _400X!,n,Hangup
-
-[rooms-out]
-; *****************************************************
-; Extensions for outgoing calls from Openmeetings room.
-; *****************************************************
-
-[rooms-red5sip]
-exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
-exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
-exten => _400X!,n(notavail),Hangup
-]]>
- </source>
- </div><br />
- <div>
- Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
- <strong>Add/Modify the following secions</strong>:<br />
- <source>
-<![CDATA[
-[general]
-
-[red5sip_user]
-type=user
-marked=yes
-dsp_drop_silence=yes
-denoise=true
-
-[sip_user]
-type=user
-end_marked=yes
-wait_marked=yes
-music_on_hold_when_empty=yes
-dsp_drop_silence=yes
-denoise=true
-
-[default_bridge]
-type=bridge
-video_mode=follow_talker
-]]>
- </source>
- </div><br />
- <div>
- To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
- <strong>Add/Modify the following sections</strong>:<br />
- <source>
-<![CDATA[
-[general]
-enabled = yes
-webenabled = no
-port = 5038
-bindaddr = 127.0.0.1
-
-[openmeetings]
-secret = 12345
-deny=0.0.0.0/0.0.0.0
-permit=127.0.0.1/255.255.255.0
-read = all
-write = all
-]]>
- </source>
- </div><br />
- <div>
- Update OpenMeetings with credentials for Asterisk manager.
- Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml</tt><br />
- find <strong><bean id="sipDao" class="org.apache.openmeetings.db.dao.room.SipDao"></strong>
- uncomment its parameters and set it to your custom values.<br/>
- set value for <tt>uid</tt> property to unique secret value (can be generated here <a href="https://www.uuidgenerator.net">https://www.uuidgenerator.net</a>)
- and sync it with <tt>settings.properties</tt> of red5sip (see below)
- <p style="font-size: larger; color: blue;">
- IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
- otherwise all SIP related room information will be lost
- </p>
- </div><br />
- <div>
- Restart asterisk:
- <source>
-<![CDATA[
-service asterisk restart
-]]>
- </source>
- </div><br />
- </section>
-
- <section name="Setup red5sip transport">
- <ul>
- <li>Download red5sip from <tt>https://github.com/openmeetings/red5sip</tt>
- <source>
-<![CDATA[
-git clone https://github.com/openmeetings/red5sip.git
-]]>
- </source>
- </li>
- <li>Build with Apache Maven
- <source>
-<![CDATA[
-cd red5sip
-mvn clean package
-]]>
- </source>
- </li>
- <li>All necessary files will be available in <tt>target</tt> folder, copy/move it to /opt/red5sip/</li>
- <li>Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
- <source>
-<![CDATA[
-red5.host=127.0.0.1 # red5 server address
-om.context=openmeetings # Openmeetings context
-red5.codec=asao
-red5.codec.rate=22 # should correlate with mic setting in Admin->Config `flash.mic.rate`
-sip.obproxy=127.0.0.1 # asterisk adderss
-sip.phone=red5sip_user # sip phone number
-sip.authid=red5sip_user # sip auth id
-sip.secret=12345 # sip password
-sip.realm=asterisk # sip realm
-sip.proxy=127.0.0.1 # address of sip proxy
-rooms.forceStart=no # TBD
-uid=87dddad4-9ca5-475b-860f-2e0825d02b76 #can be generated here: https://www.uuidgenerator.net/
-rooms=1 # TBD (not in use)
-]]>
- </source>
- </li>
- <li>Add red5sip to autostart:
- <source>
-<![CDATA[
-sudo cp /opt/red5sip/red5sip /etc/init.d/
-sudo chmod a+x /etc/init.d/red5sip
-sudo update-rc.d red5sip defaults
-]]>
- </source>
- </li>
- <li>Start openmeetings
- <source>
-<![CDATA[
-service red5 start
-]]>
- </source>
- </li>
- <li>
- Enable <tt>SIP</tt> in openmeetings: <br/>
- <tt>Administration->Configuration->red5sip.enable == yes</tt>
- </li>
- <li>
- Enable SIP for particular room(s): <br/>
- <tt>Administration->Conference rooms->Room->Enable SIP transport in the room == checked</tt><br/>
- (SIP number will be assigned to room if everything is OK)
- </li>
- <li>Start red5sip
- <source>
-<![CDATA[
-service red5sip start
-]]>
- </source>
- </li>
- </ul>
- </section>
- </body>
-</document>
diff --git a/openmeetings-server/src/site/xdoc/voip-sip-integration.xml b/openmeetings-server/src/site/xdoc/voip-sip-integration.xml
index cb2f6c3..1f61673 100644
--- a/openmeetings-server/src/site/xdoc/voip-sip-integration.xml
+++ b/openmeetings-server/src/site/xdoc/voip-sip-integration.xml
@@ -45,25 +45,299 @@
or for example somebody from the list of
<a href="commercial-support.html">commercial support</a>.
<br/><br/>
- <a href="red5sip-integration_2.0.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 2.0
- </a>.<br/>
- <a href="red5sip-integration_2.1.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 2.1
- </a>.<br/>
- <a href="red5sip-integration_3.0.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 3.0
- </a>.<br/>
- <a href="red5sip-integration_3.1.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 3.1+
- </a>.<br/>
- <a href="red5sip-integration_3.3.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 3.3+
- </a>.<br/>
- <a href="red5sip-integration_4.0.html">
- Instruction how-to set up OpenMeetings SIP-Transport integration for Openmeetings 4.0+
- </a>.<br/>
</p>
</section>
+ <section name="SIP-Transport Integration">
+ <p>You need Apache OpenMeetings <strong>version 4.0+</strong> to apply this guide!</p>
+ <p>You need Asterisk <strong>version 13+</strong> to apply this guide!</p>
+ <p>Here is instruction how-to set up red5sip transport integration with OpenMeetings on Ubuntu 16.04.</p>
+ </section>
+ <section name="Prerequisites">
+ <div>
+ Run the commands
+ <source>
+<![CDATA[
+sudo apt-get update && sudo apt-get upgrade
+]]>
+ </source>
+ </div>
+ </section>
+ <section name="Building and setting up Asterisk">
+ <div>
+ Run the commands
+ <source>
+<![CDATA[
+sudo mkdir /usr/src/asterisk && cd /usr/src/asterisk
+sudo wget http://downloads.asterisk.org/pub/telephony/asterisk/releases/asterisk-13.17.0.tar.gz
+sudo tar -xvzf asterisk-13.17.0.tar.gz
+cd ./asterisk-13.17.0
+sudo make clean
+sudo contrib/scripts/install_prereq install
+sudo ./configure
+sudo make menuconfig
+]]>
+ </source>
+ Make sure you have selected <tt>Add-ons -> res_config_mysql</tt>, Press F12 to save
+ <source>
+<![CDATA[
+sudo make
+sudo make install
+sudo make samples
+sudo make config
+sudo service asterisk start
+]]>
+ </source>
+ </div>
+ </section>
+ <section name="Configure Asterisk">
+ <div>
+ Enable asterisk MySQL module:<br /><br />
+ Modify "[modules]" section of <tt>/etc/asterisk/modules.conf</tt> as follows:<br />
+ <strong>Add/uncomment the following lines</strong>
+ <source>
+<![CDATA[
+preload => res_config_mysql.so
+]]>
+ </source>
+ </div><br />
+ <div>
+ Configure MySQL module:<br /><br />
+ Set valid data for MySQL in <tt>/etc/asterisk/res_config_mysql.conf</tt> :<br />
+ <strong>Example</strong>
+ <source>
+<![CDATA[
+[general]
+dbhost = 127.0.0.1
+dbname = openmeetings
+dbuser = root
+dbpass =
+dbport = 3306
+dbsock = /var/lib/mysql/mysql.sock
+dbcharset = utf8
+requirements=warn
+]]>
+ </source>
+ </div><br />
+ <div>
+ Modify <tt>/etc/asterisk/sip.conf</tt><br />
+ <strong>Add/uncomment the following line</strong>:<br />
+ <source>
+<![CDATA[
+videosupport=yes
+rtcachefriends=yes
+]]>
+ </source>
+ <strong>Increase maxexpiry value to 43200</strong>:<br />
+ <source>
+<![CDATA[
+maxexpiry=43200
+]]>
+ </source>
+ <strong>Add user for the "SIP Transport"</strong>:<br />
+ <source>
+<![CDATA[
+[red5sip_user]
+type=friend
+secret=12345
+disallow=all
+allow=ulaw
+allow=h263
+host=dynamic
+nat=force_rport,comedia
+context=rooms-red5sip
+]]>
+ </source>
+ </div><br />
+ <div>
+ Add next lines into the <tt>/etc/asterisk/extconfig.conf</tt>:
+ <source>
+<![CDATA[
+[settings]
+sippeers => mysql,general,sipusers
+]]>
+ </source>
+ </div><br />
+ <div>
+ Modify <tt>/etc/asterisk/extensions.conf</tt><br />
+ <strong>Add the following section</strong>:<br />
+ <source>
+<![CDATA[
+; *****************************************************
+; The below dial plan is used to dial into a Openmeetings Conference room
+; The first line DB_EXISTS(openmeetings/room/ does not belong to the openmeetings application but is the name of astDB containing the astDB family/key pair and values
+; To Check if your astDB has been created do the following in a terminal window type the following:
+; asterisk –rx “database show”
+; If you do not receive an output with that resembles openmeetings/rooms/400## where “##” will equal the extension assigned when you created your room
+; If you do not receive the above output check your parameters in /opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml
+; Go back into the Administrator Panel and remove the PIN number in each room save the record with no PIN number and then re-enter the pin again resave the record.
+; *****************************************************
+
+[rooms]
+exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
+exten => _400X!,n(ok),SET(PIN=${DB(openmeetings/rooms/${EXTEN})})
+exten => _400X!,n,Set(CONFBRIDGE(user,template)=sip_user)
+exten => _400X!,n,Set(CONFBRIDGE(user,pin)=${PIN})
+exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,)
+exten => _400X!,n,Hangup
+exten => _400X!,n(notavail),Answer()
+exten => _400X!,n,Playback(invalid)
+exten => _400X!,n,Hangup
+
+[rooms-originate]
+exten => _400X!,1,Confbridge(${EXTEN},default_bridge,sip_user)
+exten => _400X!,n,Hangup
+
+[rooms-out]
+; *****************************************************
+; Extensions for outgoing calls from Openmeetings room.
+; *****************************************************
+
+[rooms-red5sip]
+exten => _400X!,1,GotoIf($[${DB_EXISTS(openmeetings/rooms/${EXTEN})}]?ok:notavail)
+exten => _400X!,n(ok),Confbridge(${EXTEN},default_bridge,red5sip_user)
+exten => _400X!,n(notavail),Hangup
+]]>
+ </source>
+ </div><br />
+ <div>
+ Modify <tt>/etc/asterisk/confbridge.conf</tt><br />
+ <strong>Add/Modify the following secions</strong>:<br />
+ <source>
+<![CDATA[
+[general]
+
+[red5sip_user]
+type=user
+marked=yes
+dsp_drop_silence=yes
+denoise=true
+
+[sip_user]
+type=user
+end_marked=yes
+wait_marked=yes
+music_on_hold_when_empty=yes
+dsp_drop_silence=yes
+denoise=true
+
+[default_bridge]
+type=bridge
+video_mode=follow_talker
+]]>
+ </source>
+ </div><br />
+ <div>
+ To enable Asterisk Manager API modify <tt>/etc/asterisk/manager.conf</tt><br />
+ <strong>Add/Modify the following sections</strong>:<br />
+ <source>
+<![CDATA[
+[general]
+enabled = yes
+webenabled = no
+port = 5038
+bindaddr = 127.0.0.1
+
+[openmeetings]
+secret = 12345
+deny=0.0.0.0/0.0.0.0
+permit=127.0.0.1/255.255.255.0
+read = all
+write = all
+]]>
+ </source>
+ </div><br />
+ <div>
+ Update OpenMeetings with credentials for Asterisk manager.
+ Modify <tt>/opt/red5/webapps/openmeetings/WEB-INF/classes/applicationContext.xml</tt><br />
+ find <strong><bean id="sipDao" class="org.apache.openmeetings.db.dao.room.SipDao"></strong>
+ uncomment its parameters and set it to your custom values.<br/>
+ set value for <tt>uid</tt> property to unique secret value (can be generated here <a href="https://www.uuidgenerator.net">https://www.uuidgenerator.net</a>)
+ and sync it with <tt>settings.properties</tt> of red5sip (see below)
+ <p style="font-size: larger; color: blue;">
+ IMPORTANT: this step should be done <strong>BEFORE</strong> system install/restore
+ otherwise all SIP related room information will be lost
+ </p>
+ </div><br />
+ <div>
+ Restart asterisk:
+ <source>
+<![CDATA[
+service asterisk restart
+]]>
+ </source>
+ </div><br />
+ </section>
+
+ <section name="Setup red5sip transport">
+ <ul>
+ <li>Download red5sip from <tt>https://github.com/openmeetings/red5sip</tt>
+ <source>
+<![CDATA[
+git clone https://github.com/openmeetings/red5sip.git
+]]>
+ </source>
+ </li>
+ <li>Build with Apache Maven
+ <source>
+<![CDATA[
+cd red5sip
+mvn clean package
+]]>
+ </source>
+ </li>
+ <li>All necessary files will be available in <tt>target</tt> folder, copy/move it to /opt/red5sip/</li>
+ <li>Insert proper values to the <tt>/opt/red5sip/settings.properties</tt>
+ <source>
+<![CDATA[
+red5.host=127.0.0.1 # red5 server address
+om.context=openmeetings # Openmeetings context
+red5.codec=asao
+red5.codec.rate=22 # should correlate with mic setting in Admin->Config `flash.mic.rate`
+sip.obproxy=127.0.0.1 # asterisk adderss
+sip.phone=red5sip_user # sip phone number
+sip.authid=red5sip_user # sip auth id
+sip.secret=12345 # sip password
+sip.realm=asterisk # sip realm
+sip.proxy=127.0.0.1 # address of sip proxy
+rooms.forceStart=no # TBD
+uid=87dddad4-9ca5-475b-860f-2e0825d02b76 #can be generated here: https://www.uuidgenerator.net/
+rooms=1 # TBD (not in use)
+]]>
+ </source>
+ </li>
+ <li>Add red5sip to autostart:
+ <source>
+<![CDATA[
+sudo cp /opt/red5sip/red5sip /etc/init.d/
+sudo chmod a+x /etc/init.d/red5sip
+sudo update-rc.d red5sip defaults
+]]>
+ </source>
+ </li>
+ <li>Start openmeetings
+ <source>
+<![CDATA[
+service red5 start
+]]>
+ </source>
+ </li>
+ <li>
+ Enable <tt>SIP</tt> in openmeetings: <br/>
+ <tt>Administration->Configuration->red5sip.enable == yes</tt>
+ </li>
+ <li>
+ Enable SIP for particular room(s): <br/>
+ <tt>Administration->Conference rooms->Room->Enable SIP transport in the room == checked</tt><br/>
+ (SIP number will be assigned to room if everything is OK)
+ </li>
+ <li>Start red5sip
+ <source>
+<![CDATA[
+service red5sip start
+]]>
+ </source>
+ </li>
+ </ul>
+ </section>
</body>
</document>
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/AdminBaseForm.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/AdminBaseForm.java
index b774100..3273d1f 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/AdminBaseForm.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/AdminBaseForm.java
@@ -29,7 +29,7 @@ import org.apache.wicket.model.IModel;
*
* @author swagner
*
- * @param <T>
+ * @param <T> - Entity class being used by this Admin Form
*/
public abstract class AdminBaseForm<T> extends Form<T> {
private static final long serialVersionUID = 1L;
@@ -118,16 +118,16 @@ public abstract class AdminBaseForm<T> extends Form<T> {
/**
* invoked when user press save button
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected abstract void onSaveSubmit(AjaxRequestTarget target, Form<?> form);
/**
* invoked when save has error
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected void onSaveError(AjaxRequestTarget target, Form<?> form) {
//no-op
@@ -136,16 +136,16 @@ public abstract class AdminBaseForm<T> extends Form<T> {
/**
* invoked when new button is pressed
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected abstract void onNewSubmit(AjaxRequestTarget target, Form<?> form);
/**
* invoked if new has error
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected void onNewError(AjaxRequestTarget target, Form<?> form) {
//no-op
@@ -154,16 +154,16 @@ public abstract class AdminBaseForm<T> extends Form<T> {
/**
* invoked when refresh button is pressed
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected abstract void onRefreshSubmit(AjaxRequestTarget target, Form<?> form);
/**
* invoked when refresh has error
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected void onRefreshError(AjaxRequestTarget target, Form<?> form) {
//no-op
@@ -172,16 +172,16 @@ public abstract class AdminBaseForm<T> extends Form<T> {
/**
* invoked when delete button is pressed
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected abstract void onDeleteSubmit(AjaxRequestTarget target, Form<?> form);
/**
* invoked when delete has error
*
- * @param target
- * @param form
+ * @param target - ajax target to update form component
+ * @param form - Form being processed
*/
protected void onDeleteError(AjaxRequestTarget target, Form<?> form) {
//no-op
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/SearchableDataView.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/SearchableDataView.java
index 1c412e1..cbb863c 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/SearchableDataView.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/SearchableDataView.java
@@ -27,7 +27,7 @@ import org.apache.wicket.markup.repeater.data.DataView;
*
* @author swagner
*
- * @param <T>
+ * @param <T> - Entity class being used by this Data View
*/
public abstract class SearchableDataView<T extends IDataProviderEntity> extends DataView<T> {
private static final long serialVersionUID = 1L;
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/labels/LangForm.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/labels/LangForm.java
index 0ecb3a5..531fd8e 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/labels/LangForm.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/admin/labels/LangForm.java
@@ -48,10 +48,9 @@ public class LangForm extends Form<Void> {
/**
* Render Main
*
- * @param id
- * @param listContainer
- * @param language
- * @param langPanel
+ * @param id - id of this form
+ * @param listContainer - container holds list of labels
+ * @param langPanel - language panel
*/
public LangForm(String id, final WebMarkupContainer listContainer, final LangPanel langPanel) {
super(id);
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/BasePanel.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/BasePanel.java
index 4ea6ba9..d870642 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/BasePanel.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/BasePanel.java
@@ -57,7 +57,8 @@ public abstract class BasePanel extends Panel {
* Overwrite this method to execute Java code after Panel is loaded by the
* {@link MenuPanel}
*
- * @param target
+ * @param handler - request handler to update menu
+ * @return - this for chaining
*/
public BasePanel onMenuPanelLoad(IPartialPageRequestHandler handler) {
handler.add(getBasePage().getHeader().setVisible(true), getMainPanel().getMenu().setVisible(true)
@@ -69,7 +70,7 @@ public abstract class BasePanel extends Panel {
/**
* This method should be overridden to perform necessary cleanup: remove timers etc.
*
- * @param handler
+ * @param handler - request handler to perform cleanup
*/
public void cleanup(IPartialPageRequestHandler handler) {
}
@@ -77,7 +78,7 @@ public abstract class BasePanel extends Panel {
/**
* This method should be overridden to perform after "new message" dialog was closed.
*
- * @param handler
+ * @param handler - request handler to perform action after "new message" dialog was closed.
*/
public void onNewMessageClose(IPartialPageRequestHandler handler) {
}
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/ConfirmableAjaxBorder.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/ConfirmableAjaxBorder.java
index 46c68f2..c4c72cd 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/ConfirmableAjaxBorder.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/common/ConfirmableAjaxBorder.java
@@ -100,7 +100,7 @@ public abstract class ConfirmableAjaxBorder extends Border {
/**
* Gives a chance to the specializations to modify the attributes.
*
- * @param attributes attributes
+ * @param attributes - attributes
*/
protected void updateAjaxAttributes(AjaxRequestAttributes attributes) {
}
@@ -112,8 +112,7 @@ public abstract class ConfirmableAjaxBorder extends Border {
/**
* Triggered when the form is submitted, but the validation failed
*
- * @param target the {@link AjaxRequestTarget}
- * @param form the {@link Form}
+ * @param target - the {@link AjaxRequestTarget}
*/
protected void onError(AjaxRequestTarget target) {
}
@@ -121,8 +120,7 @@ public abstract class ConfirmableAjaxBorder extends Border {
/**
* Triggered when the form is submitted, and the validation succeed
*
- * @param target the {@link AjaxRequestTarget}
- * @param form the {@link Form}
+ * @param target - the {@link AjaxRequestTarget}
*/
protected abstract void onSubmit(AjaxRequestTarget target);
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/data/SearchableDataProvider.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/data/SearchableDataProvider.java
index 6c88d6b..5b0fd8b 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/data/SearchableDataProvider.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/data/SearchableDataProvider.java
@@ -33,7 +33,7 @@ import org.apache.wicket.model.IModel;
*
* @author swagner
*
- * @param <T>
+ * @param <T> - Entity class being used by this Provider
*/
public class SearchableDataProvider<T extends IDataProviderEntity> extends SortableDataProvider<T, String> {
private static final long serialVersionUID = 1L;
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/room/OmRedirectTimerBehavior.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/room/OmRedirectTimerBehavior.java
index 78e00d5..292dd48 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/room/OmRedirectTimerBehavior.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/room/OmRedirectTimerBehavior.java
@@ -61,7 +61,7 @@ public abstract class OmRedirectTimerBehavior extends AbstractAjaxTimerBehavior
}
/**
- * @param remain
+ * @param remain - time in seconds until redirect
*/
protected void onTimer(int remain) {
}
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/calendar/CalendarDialog.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/calendar/CalendarDialog.java
index 1a8093b..5ecf08d 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/calendar/CalendarDialog.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/calendar/CalendarDialog.java
@@ -117,6 +117,10 @@ public class CalendarDialog extends AbstractFormDialog<OmCalendar> {
/**
* Open the Dialog with a specific type of Appointment Based Prompts
+ *
+ * @param handler - the {@link IPartialPageRequestHandler}
+ * @param type - the {@link DIALOG_TYPE} being opened
+ * @param a - the {@link Appointment}
*/
public void open(IPartialPageRequestHandler handler, DIALOG_TYPE type, Appointment a) {
this.type = type;
@@ -149,6 +153,10 @@ public class CalendarDialog extends AbstractFormDialog<OmCalendar> {
/**
* Open the Dialog with a specific type of Calendar Based Prompts
+ *
+ * @param handler - the {@link IPartialPageRequestHandler}
+ * @param type - the {@link DIALOG_TYPE} being opened
+ * @param c - the {@link OmCalendar}
*/
public void open(IPartialPageRequestHandler handler, DIALOG_TYPE type, OmCalendar c) {
this.type = type;
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/chat/ChatToolbar.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/chat/ChatToolbar.java
index b8d09b1..62872a7 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/chat/ChatToolbar.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/chat/ChatToolbar.java
@@ -142,6 +142,8 @@ public class ChatToolbar extends Panel implements IWysiwygToolbar {
*
* @param id
* the markup-id
+ * @param form
+ * chat form
*/
public ChatToolbar(String id, ChatForm form) {
this(id, form, null);
@@ -152,6 +154,8 @@ public class ChatToolbar extends Panel implements IWysiwygToolbar {
*
* @param id
* the markup-id
+ * @param form
+ * chat form
* @param model
* the {@link org.apache.wicket.model.IModel}
*/
diff --git a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/rooms/RoomListPanel.java b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/rooms/RoomListPanel.java
index fd3fd33..5ba829d 100644
--- a/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/rooms/RoomListPanel.java
+++ b/openmeetings-web/src/main/java/org/apache/openmeetings/web/user/rooms/RoomListPanel.java
@@ -108,8 +108,8 @@ public class RoomListPanel extends Panel {
/**
* this method need to be overriden to perform custom actions on room container click
- * @param target
- * @param r
+ * @param target - the {@link AjaxRequestTarget}
+ * @param r - current {@link Room}
*/
public void onContainerClick(AjaxRequestTarget target, Room r) {
//no-op
@@ -117,8 +117,8 @@ public class RoomListPanel extends Panel {
/**
* this method need to be overriden to perform custom actions on room refresh click
- * @param target
- * @param r
+ * @param target - the {@link AjaxRequestTarget}
+ * @param r - current {@link Room}
*/
public void onRefreshClick(AjaxRequestTarget target, Room r) {
//no-op
@@ -126,6 +126,8 @@ public class RoomListPanel extends Panel {
/**
* this method need to be overriden to perform custom actions on room enter click
+ * @param target - the {@link AjaxRequestTarget}
+ * @param roomId - id of the room being entered
*/
public void onRoomEnter(AjaxRequestTarget target, Long roomId) {
RoomEnterBehavior.roomEnter((MainPage)getPage(), target, roomId);
--
To stop receiving notification emails like this one, please contact
solomax@apache.org.