WebConferencingService (eXo Web Conferencing :: Extension Services 2.1.3 API)

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.SpaceEventInfo` Represent Space event call.
`class`	`WebConferencingService.SpaceInfo` Represent Space in calls.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_USERS` The Constant ALL_USERS.
`static int`	`ARG_MAX_LENGTH` The Constant ARG_MAX_LENGTH.
`protected org.exoplatform.services.security.Authenticator`	`authenticator` The authenticator.
`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.
`protected CallDAO`	`callStorage` The calls storage.
`static String`	`CMS_GROUPS_PATH` The Constant CMS_GROUPS_PATH.
`static int`	`DATA_MAX_LENGTH` The Constant DATA_MAX_LENGTH.
`static String`	`EXO_RSS_ENABLE_PROP` The Constant EXO_RSS_ENABLE_PROP.
`static String`	`EXO_TITLE_PROP` The Constant EXO_TITLE_PROP.
`static String`	`GROUP` The Constant GROUP.
`static int`	`ID_MAX_LENGTH` The Constant ID_MAX_LENGTH.
`protected org.exoplatform.services.security.IdentityRegistry`	`identityRegistry` The identity registry.
`protected InviteDAO`	`inviteStorage` The invite storage.
`static String`	`JCR_CONTENT` The Constant JCR_CONTENT.
`static String`	`JCR_DATA` The Constant JCR_DATA.
`static String`	`JCR_LAST_MODIFIED_PROP` The Constant JCR_LAST_MODIFIED_PROP.
`static String`	`JCR_MIME_TYPE` The Constant JCR_MIME_TYPE.
`protected static String`	`JWT_CONFIGURATION_PROPERTIES` The Constant JWT_CONFIGURATION_PROPERTIES.
`protected org.exoplatform.services.cms.link.LinkManager`	`linkManager` The Link manager.
`protected org.exoplatform.services.listener.ListenerService`	`listenerService` The listener service.
`protected static org.exoplatform.services.log.Log`	`LOG` The Constant LOG.
`static int`	`MAX_RESULT_SIZE` The Constant MAX_RESULT_SIZE.
`static String`	`MIX_PRIVILEGEABLE` The Constant MIX_PRIVILEGEABLE.
`protected org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator`	`nodeCreator` The node creator.
`static String`	`NT_FILE` The Constant NT_FILE.
`static String`	`NT_RESOURCE` The Constant NT_RESOURCE.
`static String`	`OPERATION_CALL_ADDED` The operation call added.
`static String`	`OPERATION_CALL_DELETED` The operation call deleted.
`static String`	`OPERATION_CALL_JOINED` The operation call joined.
`static String`	`OPERATION_CALL_LEAVED` The operation call leaved.
`static String`	`OPERATION_CALL_RECORDED` The operation call recorded.
`static String`	`OPERATION_CALL_STARTED` The operation call started.
`static String`	`OPERATION_CALL_STOPPED` The operation call stopped.
`protected org.exoplatform.services.organization.OrganizationService`	`organization` The organization.
`protected OriginDAO`	`originsStorage` The call origins storage.
`static String`	`OWNER_TYPE_CHATROOM` The Constant OWNER_TYPE_CHATROOM.
`static String`	`OWNER_TYPE_SPACE` The Constant OWNER_TYPE_SPACE.
`static String`	`OWNER_TYPE_SPACEEVENT` The Constant OWNER_TYPE_SPACEEVENT.
`static String`	`OWNER_TYPE_USER` The Constant OWNER_TYPE_USER.
`protected ParticipantDAO`	`participantsStorage` The participants storage.
`protected static String`	`PROVIDER_SCOPE_NAME` The Constant PROVIDER_SCOPE_NAME.
`protected Map<String,CallProvider>`	`providers` The providers.
`protected org.exoplatform.services.jcr.RepositoryService`	`repositoryService` The repository service.
`protected static String`	`SECRET_KEY` The Constant SECRET_KEY.
`protected String`	`secretKey` The secret key.
`static String`	`SESSION_TOKEN_COOKIE` The Constant SESSION_TOKEN_COOKIE.
`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.wcm.ext.component.document.service.ShareDocumentService`	`shareService` The share service.
`protected org.exoplatform.social.core.manager.IdentityManager`	`socialIdentityManager` The social identity manager.
`protected org.exoplatform.social.core.space.spi.SpaceService`	`spaceService` The space service.
`static String`	`STATUS_OK` The status ok.
`static int`	`TEXT_MAX_LENGTH` The Constant TEXT_MAX_LENGTH.
`protected org.exoplatform.upload.UploadService`	`uploadService` The upload service.
`static String`	`USER` The Constant USER.
`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.organization.OrganizationService organization, org.exoplatform.social.core.manager.IdentityManager socialIdentityManager, org.exoplatform.services.listener.ListenerService listenerService, org.exoplatform.commons.api.settings.SettingService settingService, CallDAO callStorage, ParticipantDAO participantsStorage, OriginDAO originsStorage, InviteDAO inviteStorage, org.exoplatform.upload.UploadService uploadService, org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeCreator, org.exoplatform.services.security.IdentityRegistry identityRegistry, org.exoplatform.services.security.Authenticator authenticator, org.exoplatform.wcm.ext.component.document.service.ShareDocumentService shareService, org.exoplatform.container.xml.InitParams initParams, org.exoplatform.services.cms.link.LinkManager linkManager) Instantiates a new web conferencing service.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CallInfo`	`addCall(String id, String ownerId, String ownerType, String title, String providerType, Collection<String> partIds)` Adds the call to list of active and fires STARTED event.
`CallInfo`	`addGuest(String callIId, String guestId)` Adds the guest to call.
`void`	`addParticipant(String callId, String partId)` Adds the participant to existing call.
`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.
`boolean`	`checkInvite(String callId, String inviteId, String identity)` Check invite.
`protected void`	`clearStorage()` Deprecated.
`protected void`	`createCall(CallInfo call)` Create the call in storage with all its participants.
`CallInfo`	`createCall(String id, String ownerId, String ownerType, String title, String providerType, Collection<String> partIds, Collection<String> spaces, boolean start, Date startDate, Date endDate)` Create the call and add it to list of the existing in storage, optionally start the call and notify its participants.
`protected CallEntity`	`createCallEntity(CallInfo call)` Creates the call entity.
`protected OriginEntity`	`createOriginEntity(String callId, OriginInfo origin)` Creates the origin entity.
`protected Set<OriginInfo>`	`createOrigins(String providerType, Collection<String> partIds, Collection<String> spacePrettyNames)` Creates the origins.
`protected IdentityInfo`	`createOwner(String ownerId, String ownerType, String title, boolean isUser, boolean isSpace, boolean isSpaceEvent, boolean isRoom)` Creates call owner.
`protected ParticipantEntity`	`createParticipantEntity(String callId, UserInfo user)` Creates the participant entity.
`protected Set<UserInfo>`	`createParticipants(String providerType, Collection<String> partIds)` Make call's direct participants from its IDs.
`protected String`	`currentUserId()` Current user id.
`protected int`	`deleteAllUserCalls()` Delete all user calls.
`protected void`	`deleteCall(String id)` Delete call.
`protected <C extends SQLException> C`	`exceptionCause(javax.persistence.PersistenceException pe, Class<C> causeClass)` Find cause exception of given type.
`protected CallInfo`	`findCallById(String id, boolean withParticipants)` Find call in storage by its ID.
`protected String`	`findChatRoomCallId(String roomId)` Find a call, owned by a space with given ID, in calls storage.
`protected String`	`findGroupCallId(String ownerId)` Find a call, owned by group with given ID, in calls storage.
`protected List<IdentityData>`	`findGroups(String name, int count)` Find groups.
`List<IdentityData>`	`findGroupsAndUsers(String name)` Find groups and users.
`protected String`	`findLastSpaceEventCallId(String ownerId)` Find last space event call id.
`protected String`	`findSpaceCallId(String spaceId)` Find a call, owned by a space with given ID, in calls storage.
`protected Collection<CallInfo>`	`findUserGroupCalls(String userId)` Find user group calls in calls storage.
`protected List<IdentityData>`	`findUsers(String name, int count)` Find users.
`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.
`protected String`	`getInviteId(String callId)` Gets the invite id.
`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 title, String[] members)` Gets the room info.
`String`	`getSecretKey()` Gets the JWT secret key.
`WebConferencingService.SpaceEventInfo`	`getSpaceEventInfo(String spacePrettyName, String[] partIds, String[] spacesPrettyName)` Gets the space event info, it will return actual event participants at the moment of invocation.
`WebConferencingService.SpaceInfo`	`getSpaceInfo(String spacePrettyName)` Gets the space info, it will return actual space members at the moment of invocation.
`protected Set<String>`	`getSpaceMembers(String spacePrettyName)` Gets the space members.
`CallState[]`	`getUserCalls(String userId)` Gets the user calls.
`protected List<UserInfo.IMInfo>`	`getUserIMs(org.exoplatform.social.core.identity.model.Profile profile)` Gets the user IM accounts.
`UserInfo`	`getUserInfo(String id)` Gets the user info.
`protected void`	`invalidateCall(String id, boolean isGroup)` Invalidate a call by an ID.
`static boolean`	`isNotNullArg(String arg)` Checks if argument not null (also not empty and not longer of 32 chars).
`protected boolean`	`isSpaceMember(String userName, String spacePrettyName)` Checks if is space member.
`static boolean`	`isValidArg(String arg)` Checks if argument valid (null or not empty and not longer of 32 chars).
`static boolean`	`isValidData(String data)` Checks if data valid (null or not empty and not longer of 2000 bytes in UTF8 encoding).
`static boolean`	`isValidId(String id)` Checks is ID valid (not null, not empty and not longer of 255 chars).
`static boolean`	`isValidText(String text)` Checks if is valid text (null, not empty and not longer of 255 chars).
`CallInfo`	`joinCall(String callId, String partId, String clientId)` Join a call if it is started or start already stopped one.
`protected CallProviderConfiguration`	`jsonToProviderConfig(org.json.JSONObject json)` Json to provider config.
`CallInfo`	`leaveCall(String callId, String partId, String clientId)` If call started, then notify all its parties that given participant leaved.
`protected String`	`metricMessage(String userId, CallInfo call, String operation, String status, Long duration, String error)` Metric message for reporting to the stats logger.
`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`	`readCallEntity(CallEntity savedCall, boolean withParticipants)` Read call entity.
`protected CallProviderConfiguration`	`readProviderConfig(String type)` Read saved call provider configuration.
`protected void`	`removeParticipant(String callId, UserInfo participant)` Remove call participant (for leaved state) in a single transaction.
`void`	`removeUserCallListener(UserCallListener listener)` Removes the user listener.
`protected WebConferencingService.RoomInfo`	`roomInfo(String id, String title, String[] members, String callId)` Room info.
`void`	`saveProviderConfiguration(CallProviderConfiguration conf)` Save provider configuration.
`protected WebConferencingService.SpaceEventInfo`	`spaceEventInfo(String spacePrettyName, String callId, String[] participants, String[] spaces)` Space event info.
`protected WebConferencingService.SpaceInfo`	`spaceInfo(String spacePrettyName, String callId)` Space info.
`void`	`start()`
`protected void`	`startCall(CallInfo call, String partId, String clientId, boolean notifyStarted)` Start existing call.
`CallInfo`	`startCall(String callId, String clientId)` Starts existing call and fires STARTED event.
`void`	`stop()`
`protected void`	`stopCall(CallInfo call, String userId, boolean remove)` Stop call.
`CallInfo`	`stopCall(String callId, boolean remove)` Removes the call info from active and fires STOPPED event.
`protected void`	`syncCallEntity(CallInfo call, CallEntity entity)` Update call entity from given CallInfo instance.
`protected void`	`syncMembersAndParticipants(CallInfo call)` Sync group members and participants.
`protected void`	`txAddParticipant(String callId, UserInfo participant)` Tx add participant.
`protected void`	`txCreateCall(CallInfo call)` Creates the call in a single transaction.
`protected int`	`txDeleteAllUserCalls()` Delete all user calls (not group ones) within a single transaction.
`protected void`	`txDeleteCall(String id)` Delete call within a transaction.
`protected void`	`txRemoveParticipant(String callId, String partId)` Remove call participant.
`protected void`	`txStopCall(CallInfo call, boolean remove)` Tx stop call.
`protected void`	`txSyncMembersAndParticipants(CallInfo call)` Sync group members and participants.
`protected void`	`txUpdateCall(CallInfo call)` Update existing call (mark it started, stopped etc) in a single transaction.
`protected void`	`txUpdateCallAndOrigins(CallInfo call)` Tx update call and its origins.
`protected void`	`txUpdateCallAndParticipants(CallInfo call)` Update call and all its participants in a single transaction.
`protected void`	`txUpdateInvites(String callId, List<InvitedIdentity> identities)` Tx update invites.
`protected void`	`txUpdateParticipant(String callId, UserInfo participant)` Update call participant (for joined or leaved state) in a single transaction.
`protected void`	`txUpdateParticipants(CallInfo call, List<UserInfo> participants)` Tx update participants.
`protected void`	`updateCall(CallInfo call)` Update existing call (mark it started, stopped etc).
`CallInfo`	`updateCall(String callId, String ownerId, String newOwnerType, String newTitle, String newProviderType, List<String> partIds, List<String> spaces, Date startDate, Date endDate)` Updates the existing call information and original settings (initial participants and spaces).
`protected void`	`updateCallAndOrigins(CallInfo call)` Update call and its origins.
`protected void`	`updateCallAndParticipants(CallInfo call)` Update call and all its participants.
`CallInfo`	`updateInvites(String callId, List<InvitedIdentity> identities)` Update invites.
`protected void`	`updateParticipant(String callId, UserInfo participant)` Update call participant (for joined or leaved state) in a single transaction.
`CallInfo`	`updateParticipants(String callId, List<String> partIds)` Update participants of the call.
`void`	`uploadFile(UploadFileInfo uploadInfo, javax.servlet.http.HttpServletRequest request)` Upload recording of the call.
`protected org.exoplatform.services.security.Identity`	`userIdentity(String userId)` Find or create user identity.
`protected UserInfo`	`userInfo(String id)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ID_MAX_LENGTH
```
public static final int ID_MAX_LENGTH
```
  The Constant ID_MAX_LENGTH.
  
  See Also:
  
  Constant Field Values
- TEXT_MAX_LENGTH
```
public static final int TEXT_MAX_LENGTH
```
  The Constant TEXT_MAX_LENGTH.
  
  See Also:
  
  Constant Field Values
- ARG_MAX_LENGTH
```
public static final int ARG_MAX_LENGTH
```
  The Constant ARG_MAX_LENGTH.
  
  See Also:
  
  Constant Field Values
- DATA_MAX_LENGTH
```
public static final int DATA_MAX_LENGTH
```
  The Constant DATA_MAX_LENGTH.
  
  See Also:
  
  Constant Field Values
- MAX_RESULT_SIZE
```
public static final int MAX_RESULT_SIZE
```
  The Constant MAX_RESULT_SIZE.
  
  See Also:
  
  Constant Field Values
- SESSION_TOKEN_COOKIE
```
public static final String SESSION_TOKEN_COOKIE
```
  The Constant SESSION_TOKEN_COOKIE.
- OPERATION_CALL_ADDED
```
public static final String OPERATION_CALL_ADDED
```
  The operation call added.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_STARTED
```
public static final String OPERATION_CALL_STARTED
```
  The operation call started.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_JOINED
```
public static final String OPERATION_CALL_JOINED
```
  The operation call joined.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_LEAVED
```
public static final String OPERATION_CALL_LEAVED
```
  The operation call leaved.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_STOPPED
```
public static final String OPERATION_CALL_STOPPED
```
  The operation call stopped.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_DELETED
```
public static final String OPERATION_CALL_DELETED
```
  The operation call deleted.
  
  See Also:
  
  Constant Field Values
- OPERATION_CALL_RECORDED
```
public static final String OPERATION_CALL_RECORDED
```
  The operation call recorded.
  
  See Also:
  
  Constant Field Values
- STATUS_OK
```
public static final String STATUS_OK
```
  The status ok.
  
  See Also:
  
  Constant Field Values
- 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.
- JWT_CONFIGURATION_PROPERTIES
```
protected static final String JWT_CONFIGURATION_PROPERTIES
```
  The Constant JWT_CONFIGURATION_PROPERTIES.
  
  See Also:
  
  Constant Field Values
- SECRET_KEY
```
protected static final String SECRET_KEY
```
  The Constant SECRET_KEY.
  
  See Also:
  
  Constant Field Values
- ALL_USERS
```
public static final String ALL_USERS
```
  The Constant ALL_USERS.
  
  See Also:
  
  Constant Field Values
- GROUP
```
public static final String GROUP
```
  The Constant GROUP.
  
  See Also:
  
  Constant Field Values
- USER
```
public static final String USER
```
  The Constant USER.
  
  See Also:
  
  Constant Field Values
- OWNER_TYPE_USER
```
public static final String OWNER_TYPE_USER
```
  The Constant OWNER_TYPE_USER.
  
  See Also:
  
  Constant Field Values
- OWNER_TYPE_SPACE
```
public static final String OWNER_TYPE_SPACE
```
  The Constant OWNER_TYPE_SPACE.
  
  See Also:
  
  Constant Field Values
- OWNER_TYPE_SPACEEVENT
```
public static final String OWNER_TYPE_SPACEEVENT
```
  The Constant OWNER_TYPE_SPACEEVENT.
  
  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
- CMS_GROUPS_PATH
```
public static final String CMS_GROUPS_PATH
```
  The Constant CMS_GROUPS_PATH.
  
  See Also:
  
  Constant Field Values
- EXO_TITLE_PROP
```
public static final String EXO_TITLE_PROP
```
  The Constant EXO_TITLE_PROP.
  
  See Also:
  
  Constant Field Values
- NT_FILE
```
public static final String NT_FILE
```
  The Constant NT_FILE.
  
  See Also:
  
  Constant Field Values
- JCR_CONTENT
```
public static final String JCR_CONTENT
```
  The Constant JCR_CONTENT.
  
  See Also:
  
  Constant Field Values
- JCR_DATA
```
public static final String JCR_DATA
```
  The Constant JCR_DATA.
  
  See Also:
  
  Constant Field Values
- JCR_MIME_TYPE
```
public static final String JCR_MIME_TYPE
```
  The Constant JCR_MIME_TYPE.
  
  See Also:
  
  Constant Field Values
- JCR_LAST_MODIFIED_PROP
```
public static final String JCR_LAST_MODIFIED_PROP
```
  The Constant JCR_LAST_MODIFIED_PROP.
  
  See Also:
  
  Constant Field Values
- EXO_RSS_ENABLE_PROP
```
public static final String EXO_RSS_ENABLE_PROP
```
  The Constant EXO_RSS_ENABLE_PROP.
  
  See Also:
  
  Constant Field Values
- NT_RESOURCE
```
public static final String NT_RESOURCE
```
  The Constant NT_RESOURCE.
  
  See Also:
  
  Constant Field Values
- MIX_PRIVILEGEABLE
```
public static final String MIX_PRIVILEGEABLE
```
  The Constant MIX_PRIVILEGEABLE.
  
  See Also:
  
  Constant Field Values
- LOG
```
protected static final org.exoplatform.services.log.Log LOG
```
  The Constant LOG.
- secretKey
```
protected final String secretKey
```
  The secret key.
- 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.
- 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.
- callStorage
```
protected final CallDAO callStorage
```
  The calls storage.
- participantsStorage
```
protected final ParticipantDAO participantsStorage
```
  The participants storage.
- originsStorage
```
protected final OriginDAO originsStorage
```
  The call origins storage.
- inviteStorage
```
protected final InviteDAO inviteStorage
```
  The invite storage.
- providers
```
protected final Map<String,CallProvider> providers
```
  The providers.
- spaceService
```
protected org.exoplatform.social.core.space.spi.SpaceService spaceService
```
  The space service.
- shareService
```
protected org.exoplatform.wcm.ext.component.document.service.ShareDocumentService shareService
```
  The share service.
- userListeners
```
protected final Map<String,Set<UserCallListener>> userListeners
```
  The user listeners.
- uploadService
```
protected final org.exoplatform.upload.UploadService uploadService
```
  The upload service.
- repositoryService
```
protected final org.exoplatform.services.jcr.RepositoryService repositoryService
```
  The repository service.
- sessionProviders
```
protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders
```
  The session providers.
- nodeCreator
```
protected final org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeCreator
```
  The node creator.
- identityRegistry
```
protected final org.exoplatform.services.security.IdentityRegistry identityRegistry
```
  The identity registry.
- authenticator
```
protected final org.exoplatform.services.security.Authenticator authenticator
```
  The authenticator.
- linkManager
```
protected final org.exoplatform.services.cms.link.LinkManager linkManager
```
  The Link manager.

Constructor Detail

WebConferencingService

public WebConferencingService(org.exoplatform.services.organization.OrganizationService organization,
                              org.exoplatform.social.core.manager.IdentityManager socialIdentityManager,
                              org.exoplatform.services.listener.ListenerService listenerService,
                              org.exoplatform.commons.api.settings.SettingService settingService,
                              CallDAO callStorage,
                              ParticipantDAO participantsStorage,
                              OriginDAO originsStorage,
                              InviteDAO inviteStorage,
                              org.exoplatform.upload.UploadService uploadService,
                              org.exoplatform.services.jcr.RepositoryService repositoryService,
                              org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                              org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeCreator,
                              org.exoplatform.services.security.IdentityRegistry identityRegistry,
                              org.exoplatform.services.security.Authenticator authenticator,
                              org.exoplatform.wcm.ext.component.document.service.ShareDocumentService shareService,
                              org.exoplatform.container.xml.InitParams initParams,
                              org.exoplatform.services.cms.link.LinkManager linkManager)

Instantiates a new web conferencing service.

Parameters:: organization - the organization; socialIdentityManager - the social identity manager; listenerService - the listener service; settingService - the setting service; callStorage - the call storage; participantsStorage - the participants storage; originsStorage - the origins storage; inviteStorage - the invite storage; uploadService - the upload service; repositoryService - the repository service; sessionProviders - the session providers; nodeCreator - the node creator; identityRegistry - the identity registry; authenticator - the authenticator; shareService - the share service; initParams - the initParams; linkManager - the link manager

Method Detail

isValidId
```
public static boolean isValidId(String id)
```
Checks is ID valid (not null, not empty and not longer of 255 chars).

Parameters:

id - the id

Returns:

true, if is valid id

isValidText
```
public static boolean isValidText(String text)
```
Checks if is valid text (null, not empty and not longer of 255 chars).

Parameters:

text - the text

Returns:

true, if is valid text

isValidArg
```
public static boolean isValidArg(String arg)
```
Checks if argument valid (null or not empty and not longer of 32 chars).

Parameters:

arg - the arg

Returns:

true, if is valid arg

isNotNullArg
```
public static boolean isNotNullArg(String arg)
```
Checks if argument not null (also not empty and not longer of 32 chars).

Parameters:

arg - the arg

Returns:

true, if is not null arg

isValidData
```
public static boolean isValidData(String data)
                           throws UnsupportedEncodingException
```
Checks if data valid (null or not empty and not longer of 2000 bytes in UTF8 encoding).

Parameters:

data - the data

Returns:

true, if is valid data

Throws:

UnsupportedEncodingException - if UTF8 encoding not found in runtime

userInfo

protected UserInfo userInfo(String id)
                     throws IdentityStateException

Throws:: IdentityStateException

getUserInfo
```
public UserInfo getUserInfo(String id)
                     throws IdentityStateException
```
Gets the user info.

Parameters:

id - the id

Returns:

the user info

Throws:

IdentityStateException - if error happened during searching the user in Organization Service

getSpaceInfo
```
public WebConferencingService.SpaceInfo getSpaceInfo(String spacePrettyName)
                                              throws IdentityStateException,
                                                     StorageException
```
Gets the space info, it will return actual space members at the moment of invocation.

Parameters:

spacePrettyName - the space pretty name

Returns:

the space info

Throws:

IdentityStateException - if error reading space member in Organization Service

StorageException - if error reading saved group call ID associated with a space

getSpaceEventInfo

public WebConferencingService.SpaceEventInfo getSpaceEventInfo(String spacePrettyName,
                                                               String[] partIds,
                                                               String[] spacesPrettyName)
                                                        throws IdentityStateException,
                                                               StorageException

Gets the space event info, it will return actual event participants at the moment of invocation. Even participants will be resolved from the owner and given spaces' members plus given participants IDs.

Parameters:: spacePrettyName - the space pretty name; partIds - the participants IDs (attendees) added to the event directly; spacesPrettyName - the Social spaces' pretty names for add its members as participants (attendees) to the event
Returns:: the space event info
Throws:: IdentityStateException - the identity state exception; StorageException - the storage exception

getSecretKey
```
public String getSecretKey()
```
Gets the JWT secret key.

Returns:

the secret key

spaceInfo

protected WebConferencingService.SpaceInfo spaceInfo(String spacePrettyName,
                                                     String callId)
                                              throws IdentityStateException

Space info.

Parameters:: spacePrettyName - the space pretty name; callId - the call id
Returns:: the space info
Throws:: IdentityStateException - if error reading space member in Organization Service

spaceEventInfo

protected WebConferencingService.SpaceEventInfo spaceEventInfo(String spacePrettyName,
                                                               String callId,
                                                               String[] participants,
                                                               String[] spaces)
                                                        throws IdentityStateException

Space event info.

Parameters:: spacePrettyName - the space pretty name; callId - the call id; participants - the participants user names; spaces - an array of space pretty names
Returns:: the space info
Throws:: IdentityStateException - the identity state exception

getRoomInfo

public WebConferencingService.RoomInfo getRoomInfo(String id,
                                                   String title,
                                                   String[] members)
                                            throws IdentityStateException,
                                                   StorageException

Gets the room info.

Parameters:: id - the id; title - the title; members - the room members
Returns:: the room info
Throws:: IdentityStateException - if error reading room member in Organization Service; StorageException - if error reading saved group call ID associated with a room

roomInfo

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

Room info.

Parameters:: id - the id; title - the title; members - the members; callId - the call id
Returns:: the room info
Throws:: IdentityStateException - if user cannot be read

addCall
```
public CallInfo addCall(String id,
                        String ownerId,
                        String ownerType,
                        String title,
                        String providerType,
                        Collection<String> partIds)
                 throws CallArgumentException,
                        StorageException,
                        IdentityStateException,
                        CallConflictException,
                        CallSettingsException
```
Adds the call to list of active and fires STARTED event.

Parameters:

id - the id of the call

ownerId - the owner id of the call

ownerType - the owner type

title - the title of the call

providerType - the provider type

partIds - the participants IDs

Returns:

the call info object of type CallInfo

Throws:

CallArgumentException - if call argument has wrong value (failed validation)

StorageException - if error reading, adding or updating call information in persistent storage

IdentityStateException - if error reading room member in Organization Service

CallConflictException - if such call already exists and has active state (started and/or running)

CallSettingsException - if call entry has wrong settings (it's for Chat room call, the title - too long or has bad value)

createCall

public CallInfo createCall(String id,
                           String ownerId,
                           String ownerType,
                           String title,
                           String providerType,
                           Collection<String> partIds,
                           Collection<String> spaces,
                           boolean start,
                           Date startDate,
                           Date endDate)
                    throws CallArgumentException,
                           StorageException,
                           IdentityStateException,
                           CallConflictException,
                           CallSettingsException

Create the call and add it to list of the existing in storage, optionally start the call and notify its participants.

Parameters:: id - the id of the call; ownerId - the owner id of the call; ownerType - the owner type; title - the title of the call; providerType - the provider type; partIds - the original participants collection; spaces - the original spaces (pretty names collection) with members allowed for participating the call; start - the start flag, if true then the call will be started (listeners will be notified)
Returns:: the call info object of type CallInfo
Throws:: CallArgumentException - if call argument has wrong value (failed validation); StorageException - if error reading, adding or updating call information in persistent storage; IdentityStateException - if error reading room member in Organization Service; CallConflictException - if such call already exists and has active state (started and/or running); CallSettingsException - if call entry has wrong settings (it's for Chat room call, the title - too long or has bad value)

updateCall

public CallInfo updateCall(String callId,
                           String ownerId,
                           String newOwnerType,
                           String newTitle,
                           String newProviderType,
                           List<String> partIds,
                           List<String> spaces,
                           Date startDate,
                           Date endDate)
                    throws InvalidCallException,
                           CallArgumentException,
                           CallSettingsException,
                           StorageException,
                           CallNotFoundException,
                           IdentityStateException,
                           ParticipantNotFoundException

Updates the existing call information and original settings (initial participants and spaces). Note: this method will not update the call actual participants states (who is running the call right now or leaved it), see updateParticipants(String, List) method for such work.

Parameters:: callId - the call id; ownerId - the owner id; newOwnerType - the owner type; newTitle - the title; newProviderType - the provider type; partIds - the participants; spaces - the spaces; startDate - the start date; endDate - the end date
Returns:: the call info
Throws:: InvalidCallException - the invalid call exception; CallArgumentException - the call argument exception; CallSettingsException - the call settings exception; StorageException - the storage exception; CallNotFoundException - the call not found exception; IdentityStateException - the identity state exception; ParticipantNotFoundException
See Also:: updateParticipants(String, List)

createParticipants

protected Set<UserInfo> createParticipants(String providerType,
                                           Collection<String> partIds)
                                    throws IdentityStateException,
                                           CallArgumentException

Make call's direct participants from its IDs.

Parameters:: providerType - the provider type; partIds - the participants IDs
Returns:: the participants
Throws:: IdentityStateException - the identity state exception; CallArgumentException - the call argument exception

createOrigins

protected Set<OriginInfo> createOrigins(String providerType,
                                        Collection<String> partIds,
                                        Collection<String> spacePrettyNames)
                                 throws IdentityStateException,
                                        CallArgumentException

Creates the origins.

Parameters:: providerType - the provider type; partIds - the part ids; spacePrettyNames - the spaces names
Returns:: the sets of origins built from participants and spaces
Throws:: IdentityStateException - the identity state exception; CallArgumentException - the call argument exception

createOwner

protected IdentityInfo createOwner(String ownerId,
                                   String ownerType,
                                   String title,
                                   boolean isUser,
                                   boolean isSpace,
                                   boolean isSpaceEvent,
                                   boolean isRoom)
                            throws CallArgumentException,
                                   IdentityStateException

Creates call owner.

Parameters:: ownerId - the owner id; ownerType - the owner type; title - the title; isUser - the is user; isSpace - the is space; isSpaceEvent - the is space event; isRoom - the is room
Returns:: the call owner
Throws:: CallArgumentException - the call argument exception; IdentityStateException - the identity state exception

getCall
```
public CallInfo getCall(String id)
                 throws InvalidCallException
```
Gets an active call info.

Parameters:

id - the id

Returns:

the call info or null if call not found

Throws:

InvalidCallException - if call in erroneous state, see cause exception for details

stopCall
```
public CallInfo stopCall(String callId,
                         boolean remove)
                  throws CallNotFoundException,
                         InvalidCallException
```
Removes the call info from active and fires STOPPED event.

Parameters:

callId - the call id

remove - the remove

Returns:

the call info object of type CallInfo

Throws:

CallNotFoundException - if call not found

InvalidCallException - if call in erroneous state and cannot be used, details are in caused exception

stopCall

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

Stop call.

Parameters:: call - the call; userId - the user id; remove - the remove
Throws:: StorageException - if persistence exception happen

startCall
```
public CallInfo startCall(String callId,
                          String clientId)
                   throws CallNotFoundException,
                          InvalidCallException
```
Starts existing call and fires STARTED event. It's actual for group calls.

Parameters:

callId - the call id

clientId - the client id

Returns:

the call info object of type CallInfo

Throws:

CallNotFoundException - if call not found

InvalidCallException - if call in erroneous state and cannot be used, details are in caused exception

startCall

protected void startCall(CallInfo call,
                         String partId,
                         String clientId,
                         boolean notifyStarted)
                  throws ParticipantNotFoundException,
                         CallSettingsException,
                         StorageException,
                         CallNotFoundException

Start existing call.

Parameters:: call - the call; partId - the participant id who started the call; clientId - the client id; notifyStarted - if true then all participants will be notified about the started call
Throws:: ParticipantNotFoundException - if call or its participants not found in storage; CallSettingsException - if call entry has wrong settings (room title, owner type etc); StorageException - if storage exception happen; CallNotFoundException - if call not found in storage

updateParticipants
```
public CallInfo updateParticipants(String callId,
                                   List<String> partIds)
                            throws CallNotFoundException,
                                   InvalidCallException,
                                   StorageException
```
Update participants of the call. Used to update current participants of call with provided user IDs. Use this method to sycn a group call associated with external apps like eXo Chat.

Parameters:

callId - the call id

partIds - the participants ids

Returns:

the call info

Throws:

CallNotFoundException - the call not found exception

InvalidCallException - the invalid call exception

StorageException - the storage exception

addParticipant

public void addParticipant(String callId,
                           String partId)
                    throws StorageException,
                           CallNotFoundException,
                           InvalidCallException,
                           IdentityStateException,
                           CallArgumentException

Adds the participant to existing call.

Parameters:: callId - the call id; partId - the part id
Throws:: StorageException - the storage exception; CallNotFoundException - the call not found exception; InvalidCallException - the invalid call exception; IdentityStateException - the identity state exception; CallArgumentException - if participant cannot be found

addGuest

public CallInfo addGuest(String callIId,
                         String guestId)
                  throws StorageException,
                         CallNotFoundException,
                         InvalidCallException,
                         IdentityStateException

Adds the guest to call. Adds guest as a participant to the call.

Parameters:: callIId - the call id; guestId - the guest id
Returns:: the call info
Throws:: StorageException - the storage exception; CallNotFoundException - the call not found exception; InvalidCallException - the invalid call exception; IdentityStateException - the identity state exception

updateInvites

public CallInfo updateInvites(String callId,
                              List<InvitedIdentity> identities)
                       throws CallNotFoundException,
                              InvalidCallException,
                              StorageException

Update invites. Updates list of invited users/groups for the call that can join by invite link.

Parameters:: callId - the call id; identities - the invites
Returns:: the call info
Throws:: CallNotFoundException - the call not found exception; InvalidCallException - the invalid call exception; StorageException - the storage exception

joinCall

public CallInfo joinCall(String callId,
                         String partId,
                         String clientId)
                  throws InvalidCallException,
                         CallNotFoundException,
                         IdentityStateException,
                         CallArgumentException

Join a call if it is started or start already stopped one.

Parameters:: callId - the call id; partId - the participant id; clientId - the client id
Returns:: the call info object of type CallInfo
Throws:: InvalidCallException - if call in erroneous state and cannot be used, details are in caused exception; CallNotFoundException - if call not found; IdentityStateException - the identity state exception; CallArgumentException - if participant cannot be found

leaveCall
```
public CallInfo leaveCall(String callId,
                          String partId,
                          String clientId)
                   throws InvalidCallException
```
If call started, then notify all its parties that given participant leaved. If call not found then null will be returned.

Parameters:

callId - the call id

partId - the participant id

clientId - the client id

Returns:

the call info or null if call not found

Throws:

InvalidCallException - if call in erroneous state and cannot be used, details are in caused exception

getUserCalls
```
public CallState[] getUserCalls(String userId)
                         throws StorageException
```
Gets the user calls.

Parameters:

userId - the user id

Returns:

the user call states

Throws:

StorageException - if persistence error happen

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

checkInvite

public boolean checkInvite(String callId,
                           String inviteId,
                           String identity)
                    throws Exception

Check invite.

Parameters:: callId - the call id; inviteId - the invite id; identity - the identity
Returns:: true, if successful
Throws:: Exception - the exception

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)
```
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

saveProviderConfiguration

public void saveProviderConfiguration(CallProviderConfiguration conf)
                               throws UnsupportedEncodingException,
                                      org.json.JSONException

Save provider configuration.

Parameters:: conf - the configuration to save
Throws:: UnsupportedEncodingException - if UTF8 not supported; org.json.JSONException - if cannot serialize to JSON

findGroupsAndUsers

public List<IdentityData> findGroupsAndUsers(String name)
                                      throws Exception

Find groups and users.

Parameters:: name - the name
Returns:: the list
Throws:: Exception - the exception

findUsers

protected List<IdentityData> findUsers(String name,
                                       int count)
                                throws Exception

Find users.

Parameters:: name - the name; count - the count
Returns:: the list
Throws:: Exception - the exception

findGroups

protected List<IdentityData> findGroups(String name,
                                        int count)
                                 throws Exception

Find groups.

Parameters:: name - the name; count - the count
Returns:: the list
Throws:: Exception - the exception

uploadFile

public void uploadFile(UploadFileInfo uploadInfo,
                       javax.servlet.http.HttpServletRequest request)
                throws UploadFileException,
                       javax.jcr.RepositoryException

Upload recording of the call.

Parameters:: uploadInfo - the upload info; request - the request
Throws:: UploadFileException - the upload recording exception; javax.jcr.RepositoryException - the repository exception

userIdentity
```
protected org.exoplatform.services.security.Identity userIdentity(String userId)
```
Find or create user identity.

Parameters:

userId - the user id

Returns:

the identity can be null if not found and cannot be created via current authenticator

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

jsonToProviderConfig

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

Json to provider config.

Parameters:: json - the json
Returns:: the call provider configuration
Throws:: org.json.JSONException - the JSON exception

getUserIMs

protected List<UserInfo.IMInfo> getUserIMs(org.exoplatform.social.core.identity.model.Profile profile)

Gets the user IM accounts.

Parameters:: profile - the profile
Returns:: the user I ms

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)
```
Read saved call provider configuration.

Parameters:

type - the type

Returns:

the configuration

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

readCallEntity
```
protected CallInfo readCallEntity(CallEntity savedCall,
                                  boolean withParticipants)
                           throws CallSettingsException,
                                  IdentityStateException,
                                  CallOwnerException
```
Read call entity.

Parameters:

savedCall - the saved call

withParticipants - the with participants

Returns:

the call info

Throws:

CallSettingsException - if call entry has wrong settings (Chat room call title too long or has bad value)

IdentityStateException - if error reading call owner or participant

CallOwnerException - if call owner is of wrong type or cannot be found (as an identity)

getInviteId
```
protected String getInviteId(String callId)
                      throws StorageException
```
Gets the invite id.

Parameters:

callId - the call id

Returns:

the invite id

Throws:

StorageException - the storage exception

createCallEntity
```
protected CallEntity createCallEntity(CallInfo call)
                               throws CallSettingsException
```
Creates the call entity.

Parameters:

call - the call

Returns:

the call entity

Throws:

CallSettingsException - if call entry has wrong settings (chat room title)

syncCallEntity

protected void syncCallEntity(CallInfo call,
                              CallEntity entity)
                       throws CallSettingsException

Update call entity from given CallInfo instance.

Parameters:: call - the call; entity - the entity
Throws:: CallSettingsException - if call entry has wrong settings (room title)

createParticipantEntity

protected ParticipantEntity createParticipantEntity(String callId,
                                                    UserInfo user)

Creates the participant entity.

Parameters:: callId - the call id; user - the user
Returns:: the participant entity

createOriginEntity

protected OriginEntity createOriginEntity(String callId,
                                          OriginInfo origin)

Creates the origin entity.

Parameters:: callId - the call id; origin - the origin
Returns:: the origin entity

exceptionCause

protected <C extends SQLException> C exceptionCause(javax.persistence.PersistenceException pe,
                                                    Class<C> causeClass)

Find cause exception of given type.

Type Parameters:: C - the generic type
Parameters:: pe - the pe; causeClass - the cause class
Returns:: the c

txCreateCall
```
protected void txCreateCall(CallInfo call)
                     throws IllegalArgumentException,
                            IllegalStateException,
                            javax.persistence.PersistenceException,
                            CallSettingsException
```
Creates the call in a single transaction.

Parameters:

call - the call

Throws:

IllegalArgumentException - the illegal argument exception

IllegalStateException - the illegal state exception

javax.persistence.PersistenceException - if persistence exception happen

CallSettingsException - if call entry has wrong settings (chat room title)

See Also:

ExoTransactional

txAddParticipant

protected void txAddParticipant(String callId,
                                UserInfo participant)
                         throws IllegalArgumentException,
                                IllegalStateException,
                                javax.persistence.PersistenceException

Tx add participant.

Parameters:: callId - the call id; participant - the participant
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception

txStopCall

protected void txStopCall(CallInfo call,
                          boolean remove)
                   throws IllegalArgumentException,
                          IllegalStateException,
                          javax.persistence.PersistenceException

Tx stop call.

Parameters:: call - the call; remove - the remove
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception

txUpdateCall
```
protected void txUpdateCall(CallInfo call)
                     throws CallNotFoundException,
                            IllegalArgumentException,
                            IllegalStateException,
                            javax.persistence.PersistenceException,
                            CallSettingsException
```
Update existing call (mark it started, stopped etc) in a single transaction.

Parameters:

call - the call

Throws:

CallNotFoundException - if call not found in storage

IllegalArgumentException - the illegal argument exception

IllegalStateException - the illegal state exception

javax.persistence.PersistenceException - the persistence exception

CallSettingsException - if call entry has wrong settings (room call title)

txUpdateInvites

protected void txUpdateInvites(String callId,
                               List<InvitedIdentity> identities)
                        throws IllegalArgumentException,
                               IllegalStateException,
                               javax.persistence.PersistenceException

Tx update invites.

Parameters:: callId - the id; identities - the identities
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception

txUpdateParticipant

protected void txUpdateParticipant(String callId,
                                   UserInfo participant)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.persistence.PersistenceException,
                                   ParticipantNotFoundException

Update call participant (for joined or leaved state) in a single transaction.

Parameters:: callId - the call id; participant - the participant
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception; ParticipantNotFoundException - if call participant not found in storage

txSyncMembersAndParticipants
```
protected void txSyncMembersAndParticipants(CallInfo call)
```
Sync group members and participants.

Parameters:

call - the call

txRemoveParticipant

protected void txRemoveParticipant(String callId,
                                   String partId)
                            throws ParticipantNotFoundException

Remove call participant.

Parameters:: callId - the call id; partId - the participant id
Throws:: ParticipantNotFoundException - if participant not found

txUpdateCallAndParticipants

protected void txUpdateCallAndParticipants(CallInfo call)
                                    throws IllegalArgumentException,
                                           IllegalStateException,
                                           javax.persistence.PersistenceException,
                                           CallNotFoundException,
                                           CallSettingsException,
                                           ParticipantNotFoundException

Update call and all its participants in a single transaction.

Parameters:: call - the call
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception; CallNotFoundException - if call or its participants not found in storage; CallSettingsException - if call entry has wrong settings (room call title); ParticipantNotFoundException - if call participant not found in storage

txUpdateCallAndOrigins

protected void txUpdateCallAndOrigins(CallInfo call)
                               throws IllegalArgumentException,
                                      IllegalStateException,
                                      javax.persistence.PersistenceException,
                                      CallNotFoundException,
                                      CallSettingsException,
                                      ParticipantNotFoundException

Tx update call and its origins.

Parameters:: call - the call
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception; CallNotFoundException - the call not found exception; CallSettingsException - the call settings exception; ParticipantNotFoundException - the participant not found exception

txDeleteCall
```
protected void txDeleteCall(String id)
                     throws IllegalArgumentException,
                            IllegalStateException,
                            javax.persistence.PersistenceException
```
Delete call within a transaction.

Parameters:

id - the call id

Throws:

IllegalArgumentException - the illegal argument exception

IllegalStateException - the illegal state exception

javax.persistence.PersistenceException - the persistence exception

txUpdateParticipants

protected void txUpdateParticipants(CallInfo call,
                                    List<UserInfo> participants)
                             throws IllegalArgumentException,
                                    IllegalStateException,
                                    javax.persistence.PersistenceException

Tx update participants.

Parameters:: call - the call; participants - the participants
Throws:: IllegalArgumentException - the illegal argument exception; IllegalStateException - the illegal state exception; javax.persistence.PersistenceException - the persistence exception

txDeleteAllUserCalls
```
protected int txDeleteAllUserCalls()
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.persistence.PersistenceException
```
Delete all user calls (not group ones) within a single transaction.

Returns:

number of deleted calls

Throws:

IllegalArgumentException - the illegal argument exception

IllegalStateException - the illegal state exception

javax.persistence.PersistenceException - the persistence exception

clearStorage
```
@Deprecated
protected void clearStorage()
```
Deprecated.

Clear JPA storage from stale/cached objects.

deleteCall
```
protected void deleteCall(String id)
                   throws StorageException
```
Delete call.

Parameters:

id - the id

Throws:

StorageException - if storage error happens

deleteAllUserCalls
```
protected int deleteAllUserCalls()
                          throws StorageException
```
Delete all user calls. This will not touch any group call. For use on server start to cleanup the storage.

Returns:

number of deleted calls

Throws:

StorageException - if storage error happens

updateCallAndParticipants

protected void updateCallAndParticipants(CallInfo call)
                                  throws StorageException,
                                         ParticipantNotFoundException,
                                         CallSettingsException,
                                         CallNotFoundException

Update call and all its participants.

Parameters:: call - the call
Throws:: StorageException - if storage exception happen; ParticipantNotFoundException - if call or its participants not found in storage; CallSettingsException - if call entry has wrong settings (room call title); CallNotFoundException - if call not found in storage

updateCallAndOrigins

protected void updateCallAndOrigins(CallInfo call)
                             throws StorageException,
                                    ParticipantNotFoundException,
                                    CallSettingsException,
                                    CallNotFoundException

Update call and its origins.

Parameters:: call - the call
Throws:: StorageException - the storage exception; ParticipantNotFoundException - the participant not found exception; CallSettingsException - the call settings exception; CallNotFoundException - the call not found exception

syncMembersAndParticipants
```
protected void syncMembersAndParticipants(CallInfo call)
                                   throws StorageException
```
Sync group members and participants.

Parameters:

call - the call

Throws:

StorageException - the storage exception

updateParticipant

protected void updateParticipant(String callId,
                                 UserInfo participant)
                          throws ParticipantNotFoundException,
                                 StorageException

Update call participant (for joined or leaved state) in a single transaction.

Parameters:: callId - the call id; participant - the participant
Throws:: ParticipantNotFoundException - if call participant not found in storage; StorageException - if storage exception happen

removeParticipant

protected void removeParticipant(String callId,
                                 UserInfo participant)
                          throws ParticipantNotFoundException,
                                 StorageException

Remove call participant (for leaved state) in a single transaction.

Parameters:: callId - the call id; participant - the participant
Throws:: ParticipantNotFoundException - if call participant not found in storage; StorageException - if storage exception happen

updateCall
```
protected void updateCall(CallInfo call)
                   throws CallNotFoundException,
                          CallSettingsException,
                          StorageException
```
Update existing call (mark it started, stopped etc).

Parameters:

call - the call

Throws:

CallNotFoundException - if call not found in storage

CallSettingsException - if call entry has wrong settings (room call title)

StorageException - if storage exception happen

findCallById
```
protected CallInfo findCallById(String id,
                                boolean withParticipants)
                         throws IdentityStateException,
                                StorageException,
                                CallSettingsException,
                                CallOwnerException
```
Find call in storage by its ID.

Parameters:

id - the id

withParticipants - also read participants from the DB

Returns:

the call info

Throws:

IdentityStateException - if error reading call owner or participant

StorageException - if persistent error happens

CallSettingsException - if call entry has wrong settings (Chat room call title too long or has bad value)

CallOwnerException - if call owner type of unknown type

findGroupCallId
```
protected String findGroupCallId(String ownerId)
                          throws StorageException
```
Find a call, owned by group with given ID, in calls storage.

Parameters:

ownerId - the owner id

Returns:

the string or null if no call found

Throws:

StorageException - the storage exception

findSpaceCallId
```
protected String findSpaceCallId(String spaceId)
                          throws StorageException
```
Find a call, owned by a space with given ID, in calls storage.

Parameters:

spaceId - the owner id

Returns:

the string or null if no call found

Throws:

StorageException - the storage exception

findChatRoomCallId
```
protected String findChatRoomCallId(String roomId)
                             throws StorageException
```
Find a call, owned by a space with given ID, in calls storage.

Parameters:

roomId - the room id

Returns:

the string or null if no call found

Throws:

StorageException - the storage exception

findLastSpaceEventCallId
```
protected String findLastSpaceEventCallId(String ownerId)
                                   throws StorageException
```
Find last space event call id.

Parameters:

ownerId - the owner id

Returns:

the string

Throws:

StorageException - the storage exception

findUserGroupCalls
```
protected Collection<CallInfo> findUserGroupCalls(String userId)
                                           throws StorageException
```
Find user group calls in calls storage.

Parameters:

userId - the user id

Returns:

the collection

Throws:

StorageException - if persistence error happen

createCall
```
protected void createCall(CallInfo call)
                   throws StorageException,
                          CallConflictException,
                          CallSettingsException
```
Create the call in storage with all its participants. If such call (by ID) already exists a CallConflictException will be raised.

Parameters:

call - the call info

Throws:

StorageException - if storage exception happen

CallConflictException - the call conflicts with another (same ID) call

CallSettingsException - the call settings wrong (chat room title)

invalidateCall
```
protected void invalidateCall(String id,
                              boolean isGroup)
                       throws CallConflictException,
                              StorageException
```
Invalidate a call by an ID. If such call (by ID) already found and, it's P2P call but not active - it will be removed, otherwise CallConflictException will be thrown. This method designed to be called just before createCall(CallInfo).

Parameters:

id - the id

isGroup - the is group

Throws:

CallConflictException - if call conflict found and existing call cannot be removed

StorageException - if storage exception happen

metricMessage
```
protected String metricMessage(String userId,
                               CallInfo call,
                               String operation,
                               String status,
                               Long duration,
                               String error)
```
Metric message for reporting to the stats logger.

Parameters:

userId - the user id of the operation

call - the call in the operation

operation - the operation name

status - the status of operation

duration - the operation duration in millseconds (can be null), it's not a call duration

error - the error if present (can be null)

Returns:

the string combining all given parameters in specified format according https://community.exoplatform.com/portal/g/:spaces:exo_itop/exo_itop/wiki/SPEC_-_logging_for_monitoring

Class WebConferencingService

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_MAX_LENGTH

TEXT_MAX_LENGTH

ARG_MAX_LENGTH

DATA_MAX_LENGTH

MAX_RESULT_SIZE

SESSION_TOKEN_COOKIE

OPERATION_CALL_ADDED

OPERATION_CALL_STARTED

OPERATION_CALL_JOINED

OPERATION_CALL_LEAVED

OPERATION_CALL_STOPPED

OPERATION_CALL_DELETED

OPERATION_CALL_RECORDED

STATUS_OK

CALL_OWNER_SCOPE_NAME

CALL_ID_SCOPE_NAME

USER_CALLS_SCOPE_NAME

PROVIDER_SCOPE_NAME

JWT_CONFIGURATION_PROPERTIES

SECRET_KEY

ALL_USERS

GROUP

USER

OWNER_TYPE_USER

OWNER_TYPE_SPACE

OWNER_TYPE_SPACEEVENT

OWNER_TYPE_CHATROOM

CMS_GROUPS_PATH

EXO_TITLE_PROP

NT_FILE

JCR_CONTENT

JCR_DATA

JCR_MIME_TYPE

JCR_LAST_MODIFIED_PROP

EXO_RSS_ENABLE_PROP

NT_RESOURCE

MIX_PRIVILEGEABLE

LOG

secretKey

organization

socialIdentityManager

listenerService

settingService

callStorage

participantsStorage

originsStorage

inviteStorage

providers

spaceService

shareService

userListeners

uploadService

repositoryService

sessionProviders

nodeCreator

identityRegistry

authenticator

linkManager

Constructor Detail

WebConferencingService

Method Detail

isValidId

isValidText

isValidArg

isNotNullArg

isValidData

userInfo

getUserInfo

getSpaceInfo

getSpaceEventInfo

getSecretKey

spaceInfo

spaceEventInfo