Package org.exoplatform.webconferencing.webrtc

Class WebrtcProvider

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.webconferencing.CallProvider

org.exoplatform.webconferencing.webrtc.WebrtcProvider

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class WebrtcProvider
extends org.exoplatform.webconferencing.CallProvider

Created by The eXo Platform SAS.

Version:

$Id: WebrtcProvider.java 00000 Aug 15, 2017 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebrtcProvider.DefaultICEServer	The Class DefaultICEServer.
static class	WebrtcProvider.ICEServer	The Class ICEServer.
static class	WebrtcProvider.RTCConfiguration	The Class RTCConfiguration.
class	WebrtcProvider.SettingsBuilder	The Class SettingsBuilder.
class	WebrtcProvider.WebrtcSettings	The Class WebrtcSettings.

Nested classes/interfaces inherited from class org.exoplatform.webconferencing.CallProvider

org.exoplatform.webconferencing.CallProvider.Settings

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_RTC_CONFIGURATION	The Constant CONFIG_RTC_CONFIGURATION.
protected static String	KEY_RTC_SETTINGS	The Constant KEY_RTC_SETTINGS.
protected static org.exoplatform.services.log.Log	LOG	The Constant LOG.
protected org.exoplatform.services.resources.ResourceBundleService	resourceBundleService	The resource bundle service.
protected WebrtcProvider.RTCConfiguration	rtcConfiguration	The rtc configuration.
protected org.exoplatform.commons.api.settings.SettingService	settingService	The settings service.
static String	VERSION	The Constant VERSION.
protected static String	WEBRTC_SCOPE_NAME	The Constant WEBRTC_SCOPE_NAME.
static String	WEBRTC_TITLE	The Constant WEBRTC_TITLE.
static String	WEBRTC_TYPE	The Constant WEBRTC_TYPE.

Fields inherited from class org.exoplatform.webconferencing.CallProvider

active, config, CONFIG_PROVIDER_ACTIVE, CONFIG_PROVIDER_CONFIGURATION, CONFIG_PROVIDER_DESCRIPTION, EMAIL_REGEX, emailTest

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor	Description
WebrtcProvider(org.exoplatform.container.xml.InitParams params, org.exoplatform.commons.api.settings.SettingService settingService, org.exoplatform.services.resources.ResourceBundleService resourceBundleService)	Instantiates a new WebRTC provider.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getDescription(Locale locale)
org.exoplatform.webconferencing.UserInfo.IMInfo	getIMInfo(String imId)
WebrtcProvider.RTCConfiguration	getRtcConfiguration()	Gets the rtc configuration.
String[]	getSupportedTypes()
String	getTitle()
String	getType()
String	getVersion()
boolean	isLogEnabled()
protected boolean	isNotNull(Object obj)	Checks if is not null or JSON NULL.
WebrtcProvider.RTCConfiguration	jsonToRtcConfig(org.json.JSONObject json)	Json to RTC config.
protected void	logRemoteLogEnabled()	Log remote log enabled.
protected WebrtcProvider.RTCConfiguration	readRtcConfig()	Read rtc config.
org.json.JSONObject	rtcConfigToJson(WebrtcProvider.RTCConfiguration rtcConf)	RTC config to json.
protected void	saveRtcConfig(WebrtcProvider.RTCConfiguration conf)	Save rtc config.
void	saveRtcConfiguration(WebrtcProvider.RTCConfiguration conf)	Save rtc configuration.
WebrtcProvider.SettingsBuilder	settings()	Gets the settings.

Methods inherited from class org.exoplatform.webconferencing.CallProvider

equals, hashCode, isActive, isSupportedType

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getName, setDescription, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

WEBRTC_TYPE

public static final String WEBRTC_TYPE

The Constant WEBRTC_TYPE.

See Also:

Constant Field Values

WEBRTC_TITLE

public static final String WEBRTC_TITLE

The Constant WEBRTC_TITLE.

See Also:

Constant Field Values

CONFIG_RTC_CONFIGURATION

public static final String CONFIG_RTC_CONFIGURATION

The Constant CONFIG_RTC_CONFIGURATION.

See Also:

Constant Field Values

WEBRTC_SCOPE_NAME

protected static final String WEBRTC_SCOPE_NAME

The Constant WEBRTC_SCOPE_NAME.

KEY_RTC_SETTINGS

protected static final String KEY_RTC_SETTINGS

The Constant KEY_RTC_SETTINGS.

VERSION

public static final String VERSION

The Constant VERSION.

See Also:

Constant Field Values

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

settingService

protected final org.exoplatform.commons.api.settings.SettingService settingService

The settings service.

resourceBundleService

protected final org.exoplatform.services.resources.ResourceBundleService resourceBundleService

The resource bundle service.

rtcConfiguration

protected WebrtcProvider.RTCConfiguration rtcConfiguration

The rtc configuration.

Constructor Detail

WebrtcProvider

public WebrtcProvider(org.exoplatform.container.xml.InitParams params,
                      org.exoplatform.commons.api.settings.SettingService settingService,
                      org.exoplatform.services.resources.ResourceBundleService resourceBundleService)
               throws org.exoplatform.container.configuration.ConfigurationException

Instantiates a new WebRTC provider.

Parameters:

params - the params

settingService - the setting service

resourceBundleService - the resource bundle service

Throws:

org.exoplatform.container.configuration.ConfigurationException - the configuration exception

Method Detail

getRtcConfiguration

public WebrtcProvider.RTCConfiguration getRtcConfiguration()

Gets the rtc configuration.

Returns:

the rtc configuration

saveRtcConfiguration

public void saveRtcConfiguration(WebrtcProvider.RTCConfiguration conf)
                          throws Exception

Save rtc configuration.

Parameters:

conf - the conf

Throws:

Exception - the exception

settings

public WebrtcProvider.SettingsBuilder settings()

Gets the settings.

Returns:

the settings

getIMInfo

public org.exoplatform.webconferencing.UserInfo.IMInfo getIMInfo(String imId)
                                                          throws org.exoplatform.webconferencing.CallProviderException

Specified by:

getIMInfo in class org.exoplatform.webconferencing.CallProvider

Throws:

org.exoplatform.webconferencing.CallProviderException

getVersion

public String getVersion()

Specified by:

getVersion in class org.exoplatform.webconferencing.CallProvider

getType

public String getType()

Specified by:

getType in class org.exoplatform.webconferencing.CallProvider

getSupportedTypes

public String[] getSupportedTypes()

Specified by:

getSupportedTypes in class org.exoplatform.webconferencing.CallProvider

getTitle

public String getTitle()

Specified by:

getTitle in class org.exoplatform.webconferencing.CallProvider

getDescription

public String getDescription()

Specified by:

getDescription in interface org.exoplatform.container.component.ComponentPlugin

Overrides:

getDescription in class org.exoplatform.webconferencing.CallProvider

getDescription

public String getDescription(Locale locale)

Overrides:

getDescription in class org.exoplatform.webconferencing.CallProvider

isLogEnabled

public boolean isLogEnabled()

Overrides:

isLogEnabled in class org.exoplatform.webconferencing.CallProvider

jsonToRtcConfig

public WebrtcProvider.RTCConfiguration jsonToRtcConfig(org.json.JSONObject json)
                                                throws Exception

Json to RTC config.

Parameters:

json - the json

Returns:

the RTC configuration

Throws:

Exception - the exception

rtcConfigToJson

public org.json.JSONObject rtcConfigToJson(WebrtcProvider.RTCConfiguration rtcConf)
                                    throws Exception

RTC config to json.

Parameters:

rtcConf - the rtc conf

Returns:

the JSON object

Throws:

Exception - the exception

saveRtcConfig

protected void saveRtcConfig(WebrtcProvider.RTCConfiguration conf)
                      throws Exception

Save rtc config.

Parameters:

conf - the conf

Throws:

Exception - the exception

readRtcConfig

protected WebrtcProvider.RTCConfiguration readRtcConfig()
                                                 throws Exception

Read rtc config.

Returns:

the RTC configuration

Throws:

Exception - the exception

isNotNull

protected boolean isNotNull(Object obj)

Checks if is not null or JSON NULL.

Parameters:

obj - the obj

Returns:

true, if is null

logRemoteLogEnabled

protected void logRemoteLogEnabled()

Log remote log enabled.