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
static int	ARG_MAX_LENGTH The Constant ARG_MAX_LENGTH.
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	CHAT_ROOM_TYPE_NAME The Constant CHAT_ROOM_TYPE_NAME.
static int	DATA_MAX_LENGTH The Constant DATA_MAX_LENGTH.
protected static String	GROUP_CALL_TYPE The Constant GROUP_CALL_TYPE.
static int	ID_MAX_LENGTH The Constant ID_MAX_LENGTH.
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 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.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.
static int	TEXT_MAX_LENGTH The Constant TEXT_MAX_LENGTH.
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) 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 void	createCall(CallInfo call) Create the call in storage with all its participants.
protected CallEntity	createCallEntity(CallInfo call) Creates the call entity.
protected ParticipantEntity	createParticipantEntity(String callId, UserInfo user) Creates the participant entity.
protected String	currentUserId() Current user id.
protected int	deleteAllUserCalls() Delete all user calls.
protected boolean	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) Find call in storage by its ID.
protected String	findGroupCallId(String ownerId) Find a call, owned by group with given ID, in calls storage.
protected Collection<CallInfo>	findUserGroupCalls(String userId) Find user group calls in calls storage.
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 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 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 id, 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 id, String partId, String clientId) 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	readCallEntity(CallEntity savedCall, boolean withParticipants) Read call entity.
protected CallProviderConfiguration	readProviderConfig(String type) Read saved call provider configuration.
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.SpaceInfo	spaceInfo(String spacePrettyName, String callId) Space info.
void	start()
protected void	startCall(CallInfo call, String clientId) Start existing call.
CallInfo	startCall(String id, String clientId) Starts existing call and fires STARTED 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.
protected void	syncCallEntity(CallInfo call, CallEntity entity) Update call entity from given CallInfo instance.
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 boolean	txDeleteCall(String id) Delete call within a transaction.
protected void	txUpdateCall(CallInfo call) Update existing call (mark it started, stopped etc) in a single transaction.
protected void	txUpdateCallAndParticipants(CallInfo call) Update call and all its participants in a single transaction.
protected void	txUpdateParticipant(String callId, UserInfo participant) Update call participant (for joined or leaved state) in a single transaction.
protected void	updateCall(CallInfo call) Update existing call (mark it started, stopped etc).
protected void	updateCallAndParticipants(CallInfo call) Update call and all its participants.
protected void	updateParticipant(String callId, UserInfo participant) Update call participant (for joined or leaved state) in a single transaction.

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

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.

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.

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

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

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

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.

Parameters:

spacePrettyName - the space pretty name

Returns:

the space info

Throws:

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

IdentityStateException - if error reading space member in Organization Service

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

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:

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

IdentityStateException - if error reading room member in Organization Service

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

parts - the participants

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)

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 id,
                         boolean remove)
                  throws CallNotFoundException,
                         InvalidCallException

Removes the call info from active and fires STOPPED event.

Parameters:

id - the 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 CallInfo stopCall(CallInfo call,
                            String userId,
                            boolean remove)
                     throws StorageException

Stop call.

Parameters:

call - the call

userId - the user id

remove - the remove

Returns:

the call info

Throws:

StorageException - if persistence exception happen

startCall

public CallInfo startCall(String id,
                          String clientId)
                   throws CallNotFoundException,
                          InvalidCallException

Starts existing call and fires STARTED event. It's actual for group calls.

Parameters:

id - the 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 clientId)
                  throws ParticipantNotFoundException,
                         CallSettingsException,
                         StorageException,
                         CallNotFoundException

Start existing call.

Parameters:

call - the call

clientId - the client id

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

joinCall

public CallInfo joinCall(String id,
                         String partId,
                         String clientId)
                  throws InvalidCallException,
                         CallNotFoundException

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

Parameters:

id - the id

partId - the participant 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

leaveCall

public CallInfo leaveCall(String id,
                          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:

id - the 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

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:

org.json.JSONException - if cannot serialize to JSON

UnsupportedEncodingException - if UTF8 not supported

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

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

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

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

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)

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

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

txDeleteCall

protected boolean txDeleteCall(String id)
                        throws IllegalArgumentException,
                               IllegalStateException,
                               javax.persistence.PersistenceException

Delete call within a transaction.

Parameters:

id - the call id

Returns:

true, if successful

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

deleteCall

protected boolean deleteCall(String id)
                      throws StorageException

Delete call.

Parameters:

id - the id

Returns:

true, if successful

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

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

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)
                         throws IdentityStateException,
                                StorageException,
                                CallSettingsException,
                                CallOwnerException

Find call in storage by its ID.

Parameters:

id - the id

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

StorageException - if persistent error happens

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

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