org.exoplatform.webconferencing

Class WebConferencingService

java.lang.Object

org.exoplatform.webconferencing.WebConferencingService

All Implemented Interfaces:

org.picocontainer.Startable

public class WebConferencingService
extends Object
implements org.picocontainer.Startable

Created by The eXo Platform SAS.

Version:

$Id: SkypeService.java 00000 Feb 22, 2017 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebConferencingService.RoomInfo Represent Chat room in calls.
class	WebConferencingService.SpaceInfo Represent Space in calls.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CALL_ID_SCOPE_NAME The Constant CALL_ID_SCOPE_NAME.
protected static String	CALL_OWNER_SCOPE_NAME The Constant CALL_OWNER_SCOPE_NAME.
static String	CHAT_ROOM_TYPE_NAME The Constant CHAT_ROOM_TYPE_NAME.
protected org.exoplatform.services.cms.drives.ManageDriveService	driveService The drive service.
protected static String	GROUP_CALL_TYPE The Constant GROUP_CALL_TYPE.
protected org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator	hierarchyCreator The hierarchy owner.
protected org.exoplatform.services.jcr.RepositoryService	jcrService The jcr service.
protected org.exoplatform.services.listener.ListenerService	listenerService The listener service.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected org.exoplatform.services.organization.OrganizationService	organization The organization.
static String	OWNER_TYPE_CHATROOM The Constant OWNER_TYPE_CHATROOM.
static String	OWNER_TYPE_SPACE The Constant OWNER_TYPE_SPACE.
protected static String	PROVIDER_SCOPE_NAME The Constant PROVIDER_SCOPE_NAME.
protected Map<String,CallProvider>	providers The providers.
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviders The session providers.
protected org.exoplatform.commons.api.settings.SettingService	settingService The settings service.
protected org.exoplatform.social.core.manager.IdentityManager	socialIdentityManager The social identity manager.
static String	SPACE_TYPE_NAME The Constant SPACE_TYPE_NAME.
protected org.exoplatform.social.core.space.spi.SpaceService	spaceService The space service.
protected static String	USER_CALLS_SCOPE_NAME The Constant USER_CALLS_SCOPE_NAME.
protected Map<String,Set<UserCallListener>>	userListeners The user listeners.

Constructor Summary

Constructors

Constructor and Description

WebConferencingService(org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator, org.exoplatform.services.organization.OrganizationService organization, org.exoplatform.social.core.manager.IdentityManager socialIdentityManager, org.exoplatform.services.cms.drives.ManageDriveService driveService, org.exoplatform.services.listener.ListenerService listenerService, org.exoplatform.commons.api.settings.SettingService settingService) Instantiates a new web conferencing service.

Method Summary

Modifier and Type	Method and Description
CallInfo	addCall(String id, String ownerId, String ownerType, String title, String providerType, Collection<String> parts) Adds the call to list of active and fires STARTED event.
void	addPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Adds a provider plugin.
void	addProvider(CallProvider provider) Adds the provider.
void	addUserCallListener(UserCallListener listener) Adds the user listener.
protected org.json.JSONObject	callToJson(CallInfo call) Call to JSON.
protected String	currentUserId() Current user id.
protected void	deleteAllUserCalls() Delete all user calls.
protected void	deleteCall(CallInfo call) Delete call.
protected CallInfo	deleteCallById(String id) Delete call by id.
protected void	deleteOwnerCallId(String ownerId) Delete owner call id.
protected void	fireUserCallJoined(String callId, String providerType, String ownerId, String ownerType, String partId, String userId) Fire user call joined a new part.
protected void	fireUserCallLeaved(String callId, String providerType, String ownerId, String ownerType, String partId, String userId) Fire user call part leaved.
protected void	fireUserCallStateChanged(String userId, String callId, String providerType, String callState, String ownerId, String ownerType) Fire user call state.
CallInfo	getCall(String id) Gets an active call info.
CallProvider	getProvider(String type) Gets the provider.
CallProviderConfiguration	getProviderConfiguration(String providerType, Locale locale) Gets the provider configuration.
Set<CallProviderConfiguration>	getProviderConfigurations() Gets the provider configurations.
Set<CallProviderConfiguration>	getProviderConfigurations(Locale locale) Gets the provider configurations.
WebConferencingService.RoomInfo	getRoomInfo(String id, String name, String title, String[] members) Gets the room info.
WebConferencingService.SpaceInfo	getSpaceInfo(String spacePrettyName) Gets the space info.
protected Set<String>	getSpaceMembers(String spacePrettyName) Gets the space members.
CallState[]	getUserCalls(String userId) Gets the user calls.
UserInfo	getUserInfo(String id) Gets the user info.
protected boolean	isSpaceMember(String userName, String spacePrettyName) Checks if is space member.
CallInfo	joinCall(String id, String userId) If call started, then notify all its parties that given participant joined.
protected CallInfo	jsonToCall(org.json.JSONObject json) Json to call.
protected CallProviderConfiguration	jsonToProviderConfig(org.json.JSONObject json) Json to provider config.
CallInfo	leaveCall(String id, String userId) If call started, then notify all its parties that given participant leaved.
protected void	notifyUserCallStateChanged(CallInfo call, String initiatorId, String state) Notify user call state changed.
protected org.json.JSONObject	providerConfigToJson(CallProviderConfiguration conf) Provider config to json.
protected CallInfo	readCallById(String id) Read call by id.
protected CallInfo	readCallByOwnerId(String ownerId) Deprecated.
protected String	readOwnerCallId(String ownerId) Read owner call id.
protected CallProviderConfiguration	readProviderConfig(String type) Read saved call provider configuration.
protected String[]	readUserGroupCallIds(String userId) Read user group call ids.
void	removeUserCallListener(UserCallListener listener) Removes the user listener.
protected void	removeUserGroupCallId(String userId, String callId) Removes the user group call id.
protected WebConferencingService.RoomInfo	roomInfo(String id, String name, String title, String[] members, String callId) Room info.
protected void	saveCall(CallInfo call) Save call.
protected void	saveOwnerCallId(String ownerId, String callId) Save owner call id.
protected void	saveProviderConfig(CallProviderConfiguration conf) Save provider configuration.
void	saveProviderConfiguration(CallProviderConfiguration config) Save provider configuration.
protected void	saveUserGroupCallId(String userId, String callId) Save user group call id.
void	start()
CallInfo	startCall(String id) Removes the call info from active and fires STOPPED event.
void	stop()
protected CallInfo	stopCall(CallInfo call, String userId, boolean remove) Stop call.
CallInfo	stopCall(String id, boolean remove) Removes the call info from active and fires STOPPED event.

Methods inherited from class java.lang.Object

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

Field Detail

SPACE_TYPE_NAME

public static final String SPACE_TYPE_NAME

The Constant SPACE_TYPE_NAME.

CHAT_ROOM_TYPE_NAME

public static final String CHAT_ROOM_TYPE_NAME

The Constant CHAT_ROOM_TYPE_NAME.

GROUP_CALL_TYPE

protected static final String GROUP_CALL_TYPE

The Constant GROUP_CALL_TYPE.

CALL_OWNER_SCOPE_NAME

protected static final String CALL_OWNER_SCOPE_NAME

The Constant CALL_OWNER_SCOPE_NAME.

CALL_ID_SCOPE_NAME

protected static final String CALL_ID_SCOPE_NAME

The Constant CALL_ID_SCOPE_NAME.

USER_CALLS_SCOPE_NAME

protected static final String USER_CALLS_SCOPE_NAME

The Constant USER_CALLS_SCOPE_NAME.

PROVIDER_SCOPE_NAME

protected static final String PROVIDER_SCOPE_NAME

The Constant PROVIDER_SCOPE_NAME.

OWNER_TYPE_SPACE

public static final String OWNER_TYPE_SPACE

The Constant OWNER_TYPE_SPACE.

See Also:

Constant Field Values

OWNER_TYPE_CHATROOM

public static final String OWNER_TYPE_CHATROOM

The Constant OWNER_TYPE_CHATROOM.

See Also:

Constant Field Values

LOG

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

The Constant LOG.

jcrService

protected final org.exoplatform.services.jcr.RepositoryService jcrService

The jcr service.

sessionProviders

protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders

The session providers.

hierarchyCreator

protected final org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator

The hierarchy owner.

organization

protected final org.exoplatform.services.organization.OrganizationService organization

The organization.

socialIdentityManager

protected final org.exoplatform.social.core.manager.IdentityManager socialIdentityManager

The social identity manager.

driveService

protected final org.exoplatform.services.cms.drives.ManageDriveService driveService

The drive service.

listenerService

protected final org.exoplatform.services.listener.ListenerService listenerService

The listener service.

settingService

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

The settings service.

providers

protected final Map<String,CallProvider> providers

The providers.

spaceService

protected org.exoplatform.social.core.space.spi.SpaceService spaceService

The space service.

userListeners

protected final Map<String,Set<UserCallListener>> userListeners

The user listeners.

Constructor Detail

WebConferencingService

public WebConferencingService(org.exoplatform.services.jcr.RepositoryService jcrService,
                              org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                              org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator,
                              org.exoplatform.services.organization.OrganizationService organization,
                              org.exoplatform.social.core.manager.IdentityManager socialIdentityManager,
                              org.exoplatform.services.cms.drives.ManageDriveService driveService,
                              org.exoplatform.services.listener.ListenerService listenerService,
                              org.exoplatform.commons.api.settings.SettingService settingService)

Instantiates a new web conferencing service.

Parameters:

jcrService - the jcr service

sessionProviders - the session providers

hierarchyCreator - the hierarchy creator

organization - the organization

socialIdentityManager - the social identity manager

driveService - the drive service

listenerService - the listener service

settingService - the setting service

Method Detail

getUserInfo

public UserInfo getUserInfo(String id)
                     throws Exception

Gets the user info.

Parameters:

id - the id

Returns:

the user info

Throws:

Exception - the exception

getSpaceInfo

public WebConferencingService.SpaceInfo getSpaceInfo(String spacePrettyName)
                                              throws Exception

Gets the space info.

Parameters:

spacePrettyName - the space pretty name

Returns:

the space info

Throws:

Exception - the exception

getRoomInfo

public WebConferencingService.RoomInfo getRoomInfo(String id,
                                                   String name,
                                                   String title,
                                                   String[] members)
                                            throws Exception

Gets the room info.

Parameters:

id - the id

name - the name

title - the title

members - the room members

Returns:

the room info

Throws:

Exception - the exception

addCall

public CallInfo addCall(String id,
                        String ownerId,
                        String ownerType,
                        String title,
                        String providerType,
                        Collection<String> parts)
                 throws Exception

Adds the call to list of active and fires STARTED event.

Parameters:

id - the id

ownerId - the owner id

ownerType - the owner type

title - the title

providerType - the provider type

parts - the parts

Returns:

the call info

Throws:

Exception - the exception

getCall

public CallInfo getCall(String id)
                 throws Exception

Gets an active call info.

Parameters:

id - the id

Returns:

the call info or null if call not found

Throws:

Exception - the exception

stopCall

public CallInfo stopCall(String id,
                         boolean remove)
                  throws Exception

Removes the call info from active and fires STOPPED event.

Parameters:

id - the id

remove - the remove

Returns:

the call info or null if call not found

Throws:

Exception - the exception

stopCall

protected CallInfo stopCall(CallInfo call,
                            String userId,
                            boolean remove)
                     throws Exception

Stop call.

Parameters:

call - the call

userId - the user id

remove - the remove

Returns:

the call info

Throws:

Exception - the exception

startCall

public CallInfo startCall(String id)
                   throws Exception

Removes the call info from active and fires STOPPED event.

Parameters:

id - the id

Returns:

the call info or null if call not found

Throws:

Exception - the exception

joinCall

public CallInfo joinCall(String id,
                         String userId)
                  throws Exception

If call started, then notify all its parties that given participant joined. If stopped, then InvalidCallStateException will be thrown.

Parameters:

id - the id

userId - the user id

Returns:

the call info or null if call not found

Throws:

Exception - the exception

leaveCall

public CallInfo leaveCall(String id,
                          String userId)
                   throws Exception

If call started, then notify all its parties that given participant leaved. If stopped, then InvalidCallStateException will be thrown.

Parameters:

id - the id

userId - the user id

Returns:

the call info or null if call not found

Throws:

Exception - the exception

getUserCalls

public CallState[] getUserCalls(String userId)
                         throws Exception

Gets the user calls.

Parameters:

userId - the user id

Returns:

the user call states

Throws:

Exception - the exception

addUserCallListener

public void addUserCallListener(UserCallListener listener)

Adds the user listener.

Parameters:

listener - the listener

removeUserCallListener

public void removeUserCallListener(UserCallListener listener)

Removes the user listener.

Parameters:

listener - the listener

fireUserCallStateChanged

protected void fireUserCallStateChanged(String userId,
                                        String callId,
                                        String providerType,
                                        String callState,
                                        String ownerId,
                                        String ownerType)

Fire user call state.

Parameters:

userId - the user id

callId - the call id

providerType - the provider type

callState - the call state

ownerId - the caller id

ownerType - the caller type

fireUserCallJoined

protected void fireUserCallJoined(String callId,
                                  String providerType,
                                  String ownerId,
                                  String ownerType,
                                  String partId,
                                  String userId)

Fire user call joined a new part.

Parameters:

callId - the call id

providerType - the provider type

ownerId - the owner id

ownerType - the owner type

partId - the part id

userId - the user id

fireUserCallLeaved

protected void fireUserCallLeaved(String callId,
                                  String providerType,
                                  String ownerId,
                                  String ownerType,
                                  String partId,
                                  String userId)

Fire user call part leaved.

Parameters:

callId - the call id

providerType - the provider type

ownerId - the owner id

ownerType - the owner type

partId - the part id

userId - the user id

addPlugin

public void addPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Adds a provider plugin. This method is safe in runtime: if configured provider is not an instance of CallProvider then it will log a warning and let server continue the start.

Parameters:

plugin - the plugin

addProvider

public void addProvider(CallProvider provider)

Adds the provider.

Parameters:

provider - the provider

getProvider

public CallProvider getProvider(String type)

Gets the provider.

Parameters:

type - the type

Returns:

the provider

getProviderConfigurations

public Set<CallProviderConfiguration> getProviderConfigurations(Locale locale)

Gets the provider configurations.

Parameters:

locale - the locale to apply to provider description, if null a default one will be used

Returns:

the provider configurations

getProviderConfigurations

public Set<CallProviderConfiguration> getProviderConfigurations()

Gets the provider configurations.

Returns:

the provider configurations

getProviderConfiguration

public CallProviderConfiguration getProviderConfiguration(String providerType,
                                                          Locale locale)
                                                   throws Exception

Gets the provider configuration.

Parameters:

providerType - the provider type

locale - the locale to apply to provider description, if null a default one will be used

Returns:

the provider configuration or null if provider not found

Throws:

Exception - the exception

saveProviderConfiguration

public void saveProviderConfiguration(CallProviderConfiguration config)
                               throws Exception

Save provider configuration.

Parameters:

config - the config

Throws:

Exception - the exception

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

isSpaceMember

protected boolean isSpaceMember(String userName,
                                String spacePrettyName)

Checks if is space member.

Parameters:

userName - the user name

spacePrettyName - the space pretty name

Returns:

true, if is space member

getSpaceMembers

protected Set<String> getSpaceMembers(String spacePrettyName)

Gets the space members.

Parameters:

spacePrettyName - the space pretty name

Returns:

the space members

callToJson

protected org.json.JSONObject callToJson(CallInfo call)
                                  throws org.json.JSONException

Call to JSON.

Parameters:

call - the call

Returns:

the JSON object

Throws:

org.json.JSONException - the JSON exception

jsonToCall

protected CallInfo jsonToCall(org.json.JSONObject json)
                       throws Exception

Json to call.

Parameters:

json - the json

Returns:

the call info

Throws:

Exception - the exception

saveCall

protected void saveCall(CallInfo call)
                 throws Exception

Save call.

Parameters:

call - the call

Throws:

Exception - the exception

readCallByOwnerId

@Deprecated
protected CallInfo readCallByOwnerId(String ownerId)
                                          throws Exception

Deprecated.

Read call by owner id.

Parameters:

ownerId - the owner id

Returns:

the call info

Throws:

Exception - the exception

readCallById

protected CallInfo readCallById(String id)
                         throws Exception

Read call by id.

Parameters:

id - the id

Returns:

the call info

Throws:

Exception - the exception

deleteCall

protected void deleteCall(CallInfo call)
                   throws Exception

Delete call.

Parameters:

call - the call

Throws:

Exception - the exception

deleteAllUserCalls

protected void deleteAllUserCalls()
                           throws Exception

Delete all user calls. This will not touch any group call. For use on server start to cleanup the storage.

Throws:

Exception - the exception

deleteCallById

protected CallInfo deleteCallById(String id)
                           throws Exception

Delete call by id.

Parameters:

id - the id

Returns:

the call info

Throws:

Exception - the exception

saveOwnerCallId

protected void saveOwnerCallId(String ownerId,
                               String callId)

Save owner call id.

Parameters:

ownerId - the owner id

callId - the call id

readOwnerCallId

protected String readOwnerCallId(String ownerId)

Read owner call id.

Parameters:

ownerId - the owner id

Returns:

the string

deleteOwnerCallId

protected void deleteOwnerCallId(String ownerId)

Delete owner call id.

Parameters:

ownerId - the owner id

readUserGroupCallIds

protected String[] readUserGroupCallIds(String userId)

Read user group call ids.

Parameters:

userId - the user id

Returns:

the string[]

saveUserGroupCallId

protected void saveUserGroupCallId(String userId,
                                   String callId)

Save user group call id.

Parameters:

userId - the user id

callId - the call id

removeUserGroupCallId

protected void removeUserGroupCallId(String userId,
                                     String callId)

Removes the user group call id.

Parameters:

userId - the user id

callId - the call id

jsonToProviderConfig

protected CallProviderConfiguration jsonToProviderConfig(org.json.JSONObject json)
                                                  throws Exception

Json to provider config.

Parameters:

json - the json

Returns:

the call provider configuration

Throws:

Exception - the exception

providerConfigToJson

protected org.json.JSONObject providerConfigToJson(CallProviderConfiguration conf)
                                            throws org.json.JSONException

Provider config to json.

Parameters:

conf - the conf

Returns:

the JSON object

Throws:

org.json.JSONException - the JSON exception

readProviderConfig

protected CallProviderConfiguration readProviderConfig(String type)
                                                throws Exception

Read saved call provider configuration.

Parameters:

type - the type

Returns:

the configuration

Throws:

Exception - the exception

saveProviderConfig

protected void saveProviderConfig(CallProviderConfiguration conf)
                           throws Exception

Save provider configuration.

Parameters:

conf - the conf

Throws:

Exception - the exception

roomInfo

protected WebConferencingService.RoomInfo roomInfo(String id,
                                                   String name,
                                                   String title,
                                                   String[] members,
                                                   String callId)
                                            throws Exception

Room info.

Parameters:

id - the id

name - the name

title - the title

members - the members

callId - the call id

Returns:

the room info

Throws:

Exception - the exception

currentUserId

protected String currentUserId()

Current user id.

Returns:

the string

notifyUserCallStateChanged

protected void notifyUserCallStateChanged(CallInfo call,
                                          String initiatorId,
                                          String state)

Notify user call state changed.

Parameters:

call - the call

initiatorId - the initiator id

state - the state