org.exoplatform.webconferencing

Class CallProvider

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.webconferencing.CallProvider

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public abstract class CallProvider
extends org.exoplatform.container.component.BaseComponentPlugin

Created by The eXo Platform SAS.

Version:

$Id: CallProvider.java 00000 Mar 30, 2017 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	config The config.
static String	CONFIG_PROVIDER_CONFIGURATION The Constant CONFIG_PROVIDER_CONFIGURATION.
static String	CONFIG_PROVIDER_NAME The Constant CONFIG_PROVIDER_NAME.
static String	CONFIG_PROVIDER_TYPE The Constant CONFIG_PROVIDER_TYPE.
protected static String	EMAIL_REGEX The Constant EMAIL_REGEX.
protected Pattern	emailTest The email test.

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

desc, name

Constructor Summary

Constructors

Constructor and Description
CallProvider(org.exoplatform.container.xml.InitParams params) Instantiates a new video calls provider.

Method Summary

Modifier and Type	Method and Description
abstract UserInfo.IMInfo	getIMInfo(String imId) Gets the UserInfo.IMInfo instance for given IM identifier.
abstract String[]	getSupportedTypes() Gets all types supported by this provider.
abstract String	getTitle() Gets human-readable name of this provider (e.g.
abstract String	getType() Gets the main type name of this provider (e.g.
abstract String	getVersion() Gets the version.
boolean	isSupportedType(String type) Checks if it is a supported type by this provider.

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

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROVIDER_TYPE

public static final String CONFIG_PROVIDER_TYPE

The Constant CONFIG_PROVIDER_TYPE.

See Also:

Constant Field Values

CONFIG_PROVIDER_NAME

public static final String CONFIG_PROVIDER_NAME

The Constant CONFIG_PROVIDER_NAME.

See Also:

Constant Field Values

CONFIG_PROVIDER_CONFIGURATION

public static final String CONFIG_PROVIDER_CONFIGURATION

The Constant CONFIG_PROVIDER_CONFIGURATION.

See Also:

Constant Field Values

EMAIL_REGEX

protected static final String EMAIL_REGEX

The Constant EMAIL_REGEX.

See Also:

Constant Field Values

emailTest

protected final Pattern emailTest

The email test.

config

protected final Map<String,String> config

The config.

Constructor Detail

CallProvider

public CallProvider(org.exoplatform.container.xml.InitParams params)
             throws org.exoplatform.container.configuration.ConfigurationException

Instantiates a new video calls provider.

Parameters:

params - the params

Throws:

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

Method Detail

getTitle

public abstract String getTitle()

Gets human-readable name of this provider (e.g. 'Skype'). Provider name can be used in building UI labels and messages.

Returns:

the name

getVersion

public abstract String getVersion()

Gets the version.

Returns:

the version

getType

public abstract String getType()

Gets the main type name of this provider (e.g. 'skype'). Provider type should be in lower case and without white spaces. A provider may support several types as well, to observe all supported types use getSupportedTypes().

Returns:

the type

isSupportedType

public boolean isSupportedType(String type)

Checks if it is a supported type by this provider.

Parameters:

type - the type

Returns:

true, if is supported type, false otherwise

getSupportedTypes

public abstract String[] getSupportedTypes()

Gets all types supported by this provider. Provider type should be in lower case and without white spaces.

Returns:

the types array

getIMInfo

public abstract UserInfo.IMInfo getIMInfo(String imId)
                                   throws CallProviderException

Gets the UserInfo.IMInfo instance for given IM identifier.

Parameters:

imId - the IM identifier

Returns:

an instance of UserInfo.IMInfo

Throws:

CallProviderException - if the provider cannot recognize given IM id or failed to instantiate an UserInfo.IMInfo object