org.apache.openmeetings.core.remote.red5

Class ScopeApplicationAdapter

java.lang.Object

org.red5.server.adapter.AbstractScopeAdapter

org.red5.server.adapter.StatefulScopeWrappingAdapter

org.red5.server.adapter.MultiThreadedApplicationAdapter

org.apache.openmeetings.core.remote.red5.ScopeApplicationAdapter

All Implemented Interfaces:

org.red5.server.api.event.IEventHandler, org.red5.server.api.IAttributeStore, org.red5.server.api.scheduling.ISchedulingService, org.red5.server.api.scope.IScopeAware, org.red5.server.api.scope.IScopeHandler, org.red5.server.api.scope.IScopeService, org.red5.server.api.service.IBroadcastStreamService, org.red5.server.api.service.IOnDemandStreamService, org.red5.server.api.service.IPendingServiceCallback, org.red5.server.api.service.IStreamSecurityService, org.red5.server.api.service.ISubscriberStreamService, org.red5.server.api.so.ISharedObjectSecurityService, org.red5.server.api.so.ISharedObjectService, org.red5.server.api.stream.IStreamAwareScopeHandler, org.red5.server.jmx.mxbeans.ApplicationMXBean, org.red5.server.jmx.mxbeans.AttributeStoreMXBean

public class ScopeApplicationAdapter
extends org.red5.server.adapter.MultiThreadedApplicationAdapter
implements org.red5.server.api.service.IPendingServiceCallback

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScopeApplicationAdapter.MessageSender

Field Summary

Fields inherited from class org.red5.server.adapter.MultiThreadedApplicationAdapter

schedulingService

Fields inherited from class org.red5.server.adapter.StatefulScopeWrappingAdapter

plugins, scope

Fields inherited from interface org.red5.server.api.so.ISharedObjectService

BEAN_NAME

Fields inherited from interface org.red5.server.api.service.IBroadcastStreamService

BROADCAST_STREAM_SERVICE

Fields inherited from interface org.red5.server.api.service.IOnDemandStreamService

BEAN_NAME

Fields inherited from interface org.red5.server.api.service.ISubscriberStreamService

BEAN_NAME

Fields inherited from interface org.red5.server.api.scheduling.ISchedulingService

BEAN_NAME

Fields inherited from interface org.red5.server.api.service.IStreamSecurityService

BEAN_NAME

Fields inherited from interface org.red5.server.api.so.ISharedObjectSecurityService

BEAN_NAME

Constructor Summary

Constructors

Constructor and Description
ScopeApplicationAdapter()

Method Summary

Modifier and Type	Method and Description
boolean	appStart(org.red5.server.api.scope.IScope scope)
boolean	checkRoomValues(Long roomId)
List<org.apache.openmeetings.db.entity.room.Client>	checkScreenSharing()
List<Long>	getActiveRoomIds()
org.red5.server.api.scope.IBroadcastScope	getBroadcastScope(org.red5.server.api.scope.IScope scope, String name)
List<org.apache.openmeetings.db.entity.room.Client>	getClientListScope() Get all ClientList Objects of that room and domain Used in lz.applyForModeration.lzx
String	getCryptKey()
List<org.apache.openmeetings.db.entity.room.Client>	getCurrentModeratorList()
boolean	getInterviewRecordingStatus() Deprecated. this method should be reworked to use a single SQL query in the cache to get any client in the current room that is recording instead of iterating through connections!
boolean	getMicMutedByPublicSID(String publicSID)
String	getPublicSID() this function is invoked directly after initial connecting
org.red5.server.api.scope.IScope	getRoomScope(String room)
List<Long>	listRoomBroadcast()
boolean	loadTestSyncMessage(String remoteMethodName, Object newMessage, boolean sendSelf) Deprecated.
static long	nextBroadCastId()
boolean	overwritePublicSID(String newPublicSID) this function is invoked after a reconnect
long	removeModerator(String publicSID)
void	resultReceived(org.red5.server.api.service.IPendingServiceCall arg0)
boolean	roomConnect(org.red5.server.api.IConnection conn, Object[] params)
void	roomLeave(org.red5.server.api.IClient client, org.red5.server.api.scope.IScope room) Logic must be before roomDisconnect cause otherwise you cannot throw a message to each one
void	roomLeaveByScope(org.apache.openmeetings.db.entity.room.Client client, org.red5.server.api.scope.IScope scope) Removes the Client from the List, stops recording, adds the Room-Leave event to running recordings, clear Polls and removes Client from any list This function is kind of private/protected as the client won't be able to call it with proper values.
void	roomLeaveByScope(String uid, Long roomId)
Map<String,String>	screenSharerAction(Map<String,Object> map)
int	sendBrowserMessageToMembers(Object newMessage) send status for shared browsing to all members except self
int	sendMessage(Object newMessage)
int	sendMessageAll(Object newMessage)
int	sendMessageById(Object newMessage, String clientId, org.red5.server.api.scope.IScope scope) Function is used to send the kick Trigger at the moment, it sends a general message to a specific clientId
Map<String,org.apache.openmeetings.db.entity.room.Client>	sendMessageByRoomAndDomain(Long roomId, Object message) used by the Screen-Sharing Servlet to trigger events
void	sendMessageToCurrentScope(String remoteMethodName, Object newMessage, boolean sendSelf) General sync mechanism for all messages that are send from within the scope of the current client, but: optionally do not send to self (see param: sendSelf) do not send to clients that are screen sharing clients do not send to clients that are audio/video clients (or potentially ones) do not send to connections where no RoomClient is registered
void	sendMessageToCurrentScope(String method, Object msg, boolean sendSelf, boolean sendScreen) General sync mechanism for all messages that are send from within the scope of the current client, but: optionally do not send to self (see param: sendSelf) send to clients that are screen sharing clients based on parameter do not send to clients that are audio/video clients (or potentially ones) do not send to connections where no RoomClient is registered
void	sendMessageToCurrentScope(String scopeName, String remoteMethodName, Object newMessage, boolean sendSelf)
void	sendMessageToCurrentScope(String scopeName, String remoteMethodName, Object newMessage, boolean sendSelf, boolean sendScreen)
void	sendMessageToMembers(List<?> newMessage) wrapper method
int	sendMessageWithClient(Object newMessage) wrapper method
int	sendMessageWithClientById(Object newMessage, String clientId) Sends a message to a user in the same room by its clientId
void	sendMessageWithClientByPublicSID(Object message, String publicSID)
int	sendMessageWithClientWithSyncObject(Object newMessage, boolean sync) wrapper method
boolean	sendRemoteCursorEvent(String streamid, Map messageObj)
void	sendToScope(Long roomId, String method, Object obj)
void	sendToWhiteboard(String uid, Long wbId, org.apache.openmeetings.db.entity.file.FileItem fi, String url, boolean clean)
int	sendVarsByWhiteboardId(List<?> whiteboardObjParam, Long whiteboardId) This Function is triggered from the Whiteboard
Map<String,Object>	setConnectionAsSharingClient(Map<String,Object> map)
void	setNewCursorPosition(Object item)
org.apache.openmeetings.db.dto.room.RoomStatus	setRoomValues(Long roomId, boolean becomeModerator, boolean isSuperModerator, String colorObj) This function is called once a User enters a Room It contains several different mechanism depending on what roomtype and what options are available for the room to find out if the current user will be a moderator of that room or not Some rules: If it is a room that was created through the calendar, the user that organized the room will be moderator, the param Boolean becomeModerator will be ignored then In regular rooms you can use the param Boolean becomeModerator to set any user to become a moderator of the room If a new moderator is detected a Push Call to all current users of the room is invoked "setNewModeratorByList" to notify them of the new moderator At the end of the mechanism a push call with the new client-object and all the informations about the new user is send to every user of the current conference room
void	setSipTransport(Long roomId, String publicSID, String broadCastId)
long	setUserAVSettings(boolean updateBroadcastId) This method is used to set/update broadCastID of current client
org.apache.openmeetings.db.entity.room.Client	setUsernameAndSession(String SID, Long userId, String username, String firstname, String lastname) this is set initial directly after login/loading language
boolean	startInterviewRecording() Deprecated. @see getInterviewRecordingStatus()
boolean	stopInterviewRecording() Stop the recording of the streams and send event to connected users of scope
void	streamBroadcastClose(org.red5.server.api.stream.IBroadcastStream stream) This method handles the Event after a stream has been removed all connected Clients in the same room will get a notification
void	streamPublishStart(org.red5.server.api.stream.IBroadcastStream stream) This method handles the Event after a stream has been added all connected Clients in the same room will get a notification
long	switchMicMuted(String publicSID, boolean mute)
int	updateSipTransport()

Methods inherited from class org.red5.server.adapter.MultiThreadedApplicationAdapter

addListener, addScheduledJob, addScheduledJobAfterDelay, addScheduledOnceJob, addScheduledOnceJob, appConnect, appDisconnect, appJoin, appLeave, appStop, clearSharedObjects, connect, connect, createSharedObject, disconnect, FCPublish, FCSubscribe, FCUnpublish, FCUnpublish, getBroadcastStream, getBroadcastStreamNames, getClientTTL, getGhostConnsCleanupPeriod, getListeners, getOnDemandStream, getScheduledJobNames, getSharedObject, getSharedObject, getSharedObjectNames, getSharedObjectSecurity, getStreamLength, getStreamPlaybackSecurity, getStreamPublishSecurity, getSubscriberStream, handleEvent, hasBroadcastStream, hasOnDemandStream, hasSharedObject, join, leave, measureBandwidth, measureBandwidth, pauseScheduledJob, registerSharedObjectSecurity, registerStreamPlaybackSecurity, registerStreamPublishSecurity, rejectClient, rejectClient, removeListener, removeScheduledJob, resumeScheduledJob, roomDisconnect, roomJoin, roomStart, roomStop, setClientTTL, setGhostConnsCleanupPeriod, start, startTransmit, stop, stopTransmit, stopTransmit, streamBroadcastStart, streamPlayItemPause, streamPlayItemPlay, streamPlayItemResume, streamPlayItemSeek, streamPlayItemStop, streamRecordStart, streamRecordStop, streamSubscriberClose, streamSubscriberStart, unregisterSharedObjectSecurity, unregisterStreamPlaybackSecurity, unregisterStreamPublishSecurity

Methods inherited from class org.red5.server.adapter.StatefulScopeWrappingAdapter

createChildScope, getAttribute, getAttribute, getAttributeNames, getAttributes, getChildScope, getChildScopeNames, getClients, getConnections, getContext, getDepth, getName, getParent, getPath, getPlugins, getResource, getResources, getScope, hasAttribute, hasChildScope, hasParent, lookupConnections, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes, setPlugins, setScope, size

Methods inherited from class org.red5.server.adapter.AbstractScopeAdapter

addChildScope, checkBandwidth, checkBandwidthUp, removeChildScope, serviceCall, setCanCallService, setCanConnect, setCanStart, setJoin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.red5.server.api.scope.IScopeHandler

addChildScope, removeChildScope, serviceCall

Constructor Detail

ScopeApplicationAdapter

public ScopeApplicationAdapter()

Method Detail

resultReceived

public void resultReceived(org.red5.server.api.service.IPendingServiceCall arg0)

Specified by:

resultReceived in interface org.red5.server.api.service.IPendingServiceCallback

appStart

public boolean appStart(org.red5.server.api.scope.IScope scope)

Specified by:

appStart in interface org.red5.server.jmx.mxbeans.ApplicationMXBean

Overrides:

appStart in class org.red5.server.adapter.MultiThreadedApplicationAdapter

roomConnect

public boolean roomConnect(org.red5.server.api.IConnection conn,
                           Object[] params)

Specified by:

roomConnect in interface org.red5.server.jmx.mxbeans.ApplicationMXBean

Overrides:

roomConnect in class org.red5.server.adapter.MultiThreadedApplicationAdapter

screenSharerAction

public Map<String,String> screenSharerAction(Map<String,Object> map)

checkScreenSharing

public List<org.apache.openmeetings.db.entity.room.Client> checkScreenSharing()

setConnectionAsSharingClient

public Map<String,Object> setConnectionAsSharingClient(Map<String,Object> map)

Parameters:

map -

Returns:

returns key,value Map with multiple return values or null in case of exception

listRoomBroadcast

public List<Long> listRoomBroadcast()

getPublicSID

public String getPublicSID()

this function is invoked directly after initial connecting

Returns:

publicSID of current client

overwritePublicSID

public boolean overwritePublicSID(String newPublicSID)

this function is invoked after a reconnect

Parameters:

newPublicSID -

roomLeave

public void roomLeave(org.red5.server.api.IClient client,
                      org.red5.server.api.scope.IScope room)

Logic must be before roomDisconnect cause otherwise you cannot throw a message to each one

Specified by:

roomLeave in interface org.red5.server.jmx.mxbeans.ApplicationMXBean

Overrides:

roomLeave in class org.red5.server.adapter.MultiThreadedApplicationAdapter

roomLeaveByScope

public void roomLeaveByScope(String uid,
                             Long roomId)

roomLeaveByScope

public void roomLeaveByScope(org.apache.openmeetings.db.entity.room.Client client,
                             org.red5.server.api.scope.IScope scope)

Removes the Client from the List, stops recording, adds the Room-Leave event to running recordings, clear Polls and removes Client from any list This function is kind of private/protected as the client won't be able to call it with proper values.

Parameters:

client -

scope -

streamPublishStart

public void streamPublishStart(org.red5.server.api.stream.IBroadcastStream stream)

This method handles the Event after a stream has been added all connected Clients in the same room will get a notification

Specified by:

streamPublishStart in interface org.red5.server.api.stream.IStreamAwareScopeHandler

Overrides:

streamPublishStart in class org.red5.server.adapter.MultiThreadedApplicationAdapter

getBroadcastScope

public org.red5.server.api.scope.IBroadcastScope getBroadcastScope(org.red5.server.api.scope.IScope scope,
                                                                   String name)

streamBroadcastClose

public void streamBroadcastClose(org.red5.server.api.stream.IBroadcastStream stream)

This method handles the Event after a stream has been removed all connected Clients in the same room will get a notification

Specified by:

streamBroadcastClose in interface org.red5.server.api.stream.IStreamAwareScopeHandler

Overrides:

streamBroadcastClose in class org.red5.server.adapter.MultiThreadedApplicationAdapter

setNewCursorPosition

public void setNewCursorPosition(Object item)

removeModerator

public long removeModerator(String publicSID)

switchMicMuted

public long switchMicMuted(String publicSID,
                           boolean mute)

getMicMutedByPublicSID

public boolean getMicMutedByPublicSID(String publicSID)

nextBroadCastId

public static long nextBroadCastId()

setUserAVSettings

public long setUserAVSettings(boolean updateBroadcastId)

This method is used to set/update broadCastID of current client

Parameters:

updateBroadcastId - boolean flag

Returns:

BroadcastId in case of no errors, -1 otherwise

checkRoomValues

public boolean checkRoomValues(Long roomId)

setRoomValues

public org.apache.openmeetings.db.dto.room.RoomStatus setRoomValues(Long roomId,
                                                                    boolean becomeModerator,
                                                                    boolean isSuperModerator,
                                                                    String colorObj)

This function is called once a User enters a Room It contains several different mechanism depending on what roomtype and what options are available for the room to find out if the current user will be a moderator of that room or not

Some rules:

• If it is a room that was created through the calendar, the user that organized the room will be moderator, the param Boolean becomeModerator will be ignored then
• In regular rooms you can use the param Boolean becomeModerator to set any user to become a moderator of the room

If a new moderator is detected a Push Call to all current users of the room is invoked "setNewModeratorByList" to notify them of the new moderator

At the end of the mechanism a push call with the new client-object and all the informations about the new user is send to every user of the current conference room

Parameters:

roomId - - id of the room

becomeModerator - - is user will become moderator

isSuperModerator - - is user super moderator

groupId - - group id of the user

colorObj - - some color

Returns:

RoomStatus object

setUsernameAndSession

public org.apache.openmeetings.db.entity.room.Client setUsernameAndSession(String SID,
                                                                           Long userId,
                                                                           String username,
                                                                           String firstname,
                                                                           String lastname)

this is set initial directly after login/loading language

Parameters:

SID - - id of the session

userId - - id of the user being set

username - - username of the user

firstname - - firstname of the user

lastname - - lastname of the user

Returns:

RoomClient in case of everything is OK, null otherwise

sendMessageByRoomAndDomain

public Map<String,org.apache.openmeetings.db.entity.room.Client> sendMessageByRoomAndDomain(Long roomId,
                                                                                            Object message)

used by the Screen-Sharing Servlet to trigger events

Parameters:

roomId -

message -

Returns:

the list of room clients

getCurrentModeratorList

public List<org.apache.openmeetings.db.entity.room.Client> getCurrentModeratorList()

sendVarsByWhiteboardId

public int sendVarsByWhiteboardId(List<?> whiteboardObjParam,
                                  Long whiteboardId)

This Function is triggered from the Whiteboard

Parameters:

whiteboardObjParam - - array of parameters being sended to whiteboard

whiteboardId - - id of whiteboard parameters will be send to

Returns:

1 in case of no errors, -1 otherwise

sendToWhiteboard

public void sendToWhiteboard(String uid,
                             Long wbId,
                             org.apache.openmeetings.db.entity.file.FileItem fi,
                             String url,
                             boolean clean)

sendMessage

public int sendMessage(Object newMessage)

sendMessageAll

public int sendMessageAll(Object newMessage)

sendBrowserMessageToMembers

public int sendBrowserMessageToMembers(Object newMessage)

send status for shared browsing to all members except self

Parameters:

newMessage -

Returns:

1

sendMessageToMembers

public void sendMessageToMembers(List<?> newMessage)

wrapper method

Parameters:

newMessage -

sendMessageToCurrentScope

public void sendMessageToCurrentScope(String remoteMethodName,
                                      Object newMessage,
                                      boolean sendSelf)

General sync mechanism for all messages that are send from within the scope of the current client, but:

• optionally do not send to self (see param: sendSelf)
• do not send to clients that are screen sharing clients
• do not send to clients that are audio/video clients (or potentially ones)
• do not send to connections where no RoomClient is registered

Parameters:

remoteMethodName - The method to be called

newMessage - parameters

sendSelf - send to the current client as well

sendMessageToCurrentScope

public void sendMessageToCurrentScope(String scopeName,
                                      String remoteMethodName,
                                      Object newMessage,
                                      boolean sendSelf)

sendToScope

public void sendToScope(Long roomId,
                        String method,
                        Object obj)

loadTestSyncMessage

@Deprecated
public boolean loadTestSyncMessage(String remoteMethodName,
                                               Object newMessage,
                                               boolean sendSelf)

Deprecated.

Only temporary for load test, with return argument for the client to have a result

Parameters:

remoteMethodName -

newMessage -

sendSelf -

Returns:

true

sendMessageToCurrentScope

public void sendMessageToCurrentScope(String method,
                                      Object msg,
                                      boolean sendSelf,
                                      boolean sendScreen)

General sync mechanism for all messages that are send from within the scope of the current client, but:

• optionally do not send to self (see param: sendSelf)
• send to clients that are screen sharing clients based on parameter
• do not send to clients that are audio/video clients (or potentially ones)
• do not send to connections where no RoomClient is registered

Parameters:

method - The method to be called

msg - parameters

sendSelf - send to the current client as well

sendScreen - send to the current client as well

sendMessageToCurrentScope

public void sendMessageToCurrentScope(String scopeName,
                                      String remoteMethodName,
                                      Object newMessage,
                                      boolean sendSelf,
                                      boolean sendScreen)

sendMessageWithClient

public int sendMessageWithClient(Object newMessage)

wrapper method

Parameters:

newMessage -

Returns:

1 in case of success, -1 otherwise

sendMessageWithClientWithSyncObject

public int sendMessageWithClientWithSyncObject(Object newMessage,
                                               boolean sync)

wrapper method

Parameters:

newMessage -

sync -

Returns:

1 in case of success, -1 otherwise

sendMessageById

public int sendMessageById(Object newMessage,
                           String clientId,
                           org.red5.server.api.scope.IScope scope)

Function is used to send the kick Trigger at the moment, it sends a general message to a specific clientId

Parameters:

newMessage -

clientId -

Returns:

1 in case of success, -1 otherwise

sendMessageWithClientById

public int sendMessageWithClientById(Object newMessage,
                                     String clientId)

Sends a message to a user in the same room by its clientId

Parameters:

newMessage -

clientId -

Returns:

1 in case of no exceptions, -1 otherwise

sendMessageWithClientByPublicSID

public void sendMessageWithClientByPublicSID(Object message,
                                             String publicSID)

getInterviewRecordingStatus

@Deprecated
public boolean getInterviewRecordingStatus()

Deprecated. this method should be reworked to use a single SQL query in the cache to get any client in the current room that is recording instead of iterating through connections!

Returns:

true in case there is recording session, false otherwise, null if any exception happend

startInterviewRecording

@Deprecated
public boolean startInterviewRecording()

Deprecated. @see getInterviewRecordingStatus()

Returns:

- false if there were existing recording, true if recording was started successfully, null if any exception happens

sendRemoteCursorEvent

public boolean sendRemoteCursorEvent(String streamid,
                                     Map messageObj)

stopInterviewRecording

public boolean stopInterviewRecording()

Stop the recording of the streams and send event to connected users of scope

Returns:

true if interview was found

getClientListScope

public List<org.apache.openmeetings.db.entity.room.Client> getClientListScope()

Get all ClientList Objects of that room and domain Used in lz.applyForModeration.lzx

Returns:

all ClientList Objects of that room

getCryptKey

public String getCryptKey()

getRoomScope

public org.red5.server.api.scope.IScope getRoomScope(String room)

getActiveRoomIds

public List<Long> getActiveRoomIds()

updateSipTransport

public int updateSipTransport()

setSipTransport

public void setSipTransport(Long roomId,
                            String publicSID,
                            String broadCastId)