Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CallProvider.Settings	Call Provider runtime Settings (for serialization in JSON to remote clients).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active	The active flag.
protected Map<String,String>	config	The config.
static String	CONFIG_PROVIDER_ACTIVE	The Constant CONFIG_PROVIDER_ACTIVE.
static String	CONFIG_PROVIDER_CONFIGURATION	The Constant CONFIG_PROVIDER_CONFIGURATION.
static String	CONFIG_PROVIDER_DESCRIPTION	The Constant CONFIG_PROVIDER_DESCRIPTION.
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	Description
CallProvider(org.exoplatform.container.xml.InitParams params)	Instantiates a new web conferencing provider.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Technical description for this provider.
String	getDescription(Locale locale)	Gets the technical description for this provider.
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.
int	hashCode()
boolean	isActive()	Checks if is active.
boolean	isLogEnabled()	Checks if is remote log enabled for the provider.
boolean	isSupportedType(String type)	Checks if it is a supported type by this provider.

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

CONFIG_PROVIDER_ACTIVE

public static final String CONFIG_PROVIDER_ACTIVE

The Constant CONFIG_PROVIDER_ACTIVE.

See Also:

Constant Field Values

CONFIG_PROVIDER_DESCRIPTION

public static final String CONFIG_PROVIDER_DESCRIPTION

The Constant CONFIG_PROVIDER_DESCRIPTION.

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.

active

protected boolean active

The active flag.

Constructor Detail

CallProvider

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

Instantiates a new web conferencing provider.

Parameters:

params - the params

Throws:

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

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isActive

public final boolean isActive()

Checks if is active.

Returns:

true, if is active

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

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

getDescription

public String getDescription()

Technical description for this provider. Will be used in administrative settings. Provider implementation can override it to offer own content. By default it will be taken from the plugin configuration.

Specified by:

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

Overrides:

getDescription in class org.exoplatform.container.component.BaseComponentPlugin

Returns:

the description

getDescription

public String getDescription(Locale locale)

Gets the technical description for this provider.

Parameters:

locale - the locale, can be null then default locale will be assumed.

Returns:

the description in given locale

isLogEnabled

public boolean isLogEnabled()

Checks if is remote log enabled for the provider.

Returns:

true, if is log enabled

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

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 or null if IM not supported by the provider

Throws:

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