org.kurento.room.internal

Class DefaultNotificationRoomHandler

java.lang.Object

org.kurento.room.internal.DefaultNotificationRoomHandler

All Implemented Interfaces:

NotificationRoomHandler, RoomHandler

public class DefaultNotificationRoomHandler
extends Object
implements NotificationRoomHandler

Default implementation that assumes that JSON-RPC messages specification was used for the client-server communications.

Author:

Radu Tom Vlad

Constructor Summary

Constructors

Constructor and Description
DefaultNotificationRoomHandler(UserNotificationService notifService)

Method Summary

Modifier and Type	Method and Description
void	onIceCandidate(String roomName, String participantId, String endpointName, org.kurento.client.IceCandidate candidate) Called when a new IceCandidate is gathered for the local WebRTC endpoint.
void	onMediaElementError(String roomName, String participantId, String description) Called as a result of an error intercepted on a media element of a participant.
void	onParticipantEvicted(UserParticipant participant) Called as a result of NotificationRoomManager.evictParticipant(String) - application-originated method, not as a consequence of a client request.
void	onParticipantJoined(ParticipantRequest request, String roomName, String newUserName, Set<UserParticipant> existingParticipants, RoomException error) Called as a result of NotificationRoomManager#joinRoom(String, String, ParticipantRequest) .
void	onParticipantLeft(ParticipantRequest request, String userName, Set<UserParticipant> remainingParticipants, RoomException error) Called as a result of NotificationRoomManager#leaveRoom(String, String, ParticipantRequest) .
void	onParticipantLeft(String userName, Set<UserParticipant> remainingParticipants) Called as a result of NotificationRoomManager.evictParticipant(String) (application-originated action).
void	onPipelineError(String roomName, Set<String> participantIds, String description) Called as a result of an error intercepted on the media pipeline.
void	onPublishMedia(ParticipantRequest request, String publisherName, String sdpAnswer, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager#publishMedia(String, ParticipantRequest, MediaElement...) .
void	onRecvIceCandidate(ParticipantRequest request, RoomException error) Called as a result of NotificationRoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) .
void	onRoomClosed(String roomName, Set<UserParticipant> participants) Called as a result of NotificationRoomManager.closeRoom(String) - application-originated method, not as a consequence of a client request.
void	onSendMessage(ParticipantRequest request, String message, String userName, String roomName, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager.sendMessage(String, String, String, ParticipantRequest) .
void	onSubscribe(ParticipantRequest request, String sdpAnswer, RoomException error) Called as a result of NotificationRoomManager.subscribe(String, String, ParticipantRequest) .
void	onUnpublishMedia(ParticipantRequest request, String publisherName, Set<UserParticipant> participants, RoomException error) Called as a result of NotificationRoomManager.unpublishMedia(ParticipantRequest).
void	onUnsubscribe(ParticipantRequest request, RoomException error) Called as a result of NotificationRoomManager.unsubscribe(String, ParticipantRequest).

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNotificationRoomHandler

public DefaultNotificationRoomHandler(UserNotificationService notifService)

Method Detail

onRoomClosed

public void onRoomClosed(String roomName,
                         Set<UserParticipant> participants)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.closeRoom(String) - application-originated method, not as a consequence of a client request. All resources on the server, associated with the room, have been released. The existing participants in the room should be notified of this event so that the client-side application acts accordingly.

Specified by:

onRoomClosed in interface NotificationRoomHandler

Parameters:

roomName - the room that's just been closed

participants - instances of UserParticipant POJO representing the peers of the closed room

onParticipantJoined

public void onParticipantJoined(ParticipantRequest request,
                                String roomName,
                                String newUserName,
                                Set<UserParticipant> existingParticipants,
                                RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager#joinRoom(String, String, ParticipantRequest) . The new participant should be responded with all the available information: the existing peers and, for any publishers, their stream names. The current peers should receive a notification of the join event.

Specified by:

onParticipantJoined in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

roomName - the room's name

newUserName - the new user

existingParticipants - instances of UserParticipant POJO representing the already existing peers

error - instance of RoomException POJO, includes a code and error message. If not null, then the join was unsuccessful and the user should be responded accordingly.

onParticipantLeft

public void onParticipantLeft(ParticipantRequest request,
                              String userName,
                              Set<UserParticipant> remainingParticipants,
                              RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager#leaveRoom(String, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully, and the remaining peers should be notified of this event.

Specified by:

onParticipantLeft in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

userName - the departing user's name

remainingParticipants - instances of UserParticipant representing the remaining participants in the room

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onPublishMedia

public void onPublishMedia(ParticipantRequest request,
                           String publisherName,
                           String sdpAnswer,
                           Set<UserParticipant> participants,
                           RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager#publishMedia(String, ParticipantRequest, MediaElement...) . The user should receive the generated SPD answer from the local WebRTC endpoint, and the other peers should be notified of this event.

Specified by:

onPublishMedia in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

publisherName - the user name

sdpAnswer - String with generated SPD answer from the local WebRTC endpoint

participants - instances of UserParticipant for ALL the participants in the room (includes the publisher)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onUnpublishMedia

public void onUnpublishMedia(ParticipantRequest request,
                             String publisherName,
                             Set<UserParticipant> participants,
                             RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.unpublishMedia(ParticipantRequest). The user should receive an acknowledgement if the operation completed successfully, and all other peers in the room should be notified of this event.

Specified by:

onUnpublishMedia in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

publisherName - the user name

participants - instances of UserParticipant for ALL the participants in the room (includes the publisher)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onSubscribe

public void onSubscribe(ParticipantRequest request,
                        String sdpAnswer,
                        RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.subscribe(String, String, ParticipantRequest) . The user should be responded with generated SPD answer from the local WebRTC endpoint.

Specified by:

onSubscribe in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

sdpAnswer - String with generated SPD answer from the local WebRTC endpoint

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onUnsubscribe

public void onUnsubscribe(ParticipantRequest request,
                          RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.unsubscribe(String, ParticipantRequest). The user should receive an acknowledgement if the operation completed successfully (no error).

Specified by:

onUnsubscribe in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onSendMessage

public void onSendMessage(ParticipantRequest request,
                          String message,
                          String userName,
                          String roomName,
                          Set<UserParticipant> participants,
                          RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.sendMessage(String, String, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully, and all the peers in the room should be notified with the message contents and its origin.

Specified by:

onSendMessage in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

message - String with the message body

userName - name of the peer that sent it

roomName - the current room name

participants - instances of UserParticipant for ALL the participants in the room (includes the sender)

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onRecvIceCandidate

public void onRecvIceCandidate(ParticipantRequest request,
                               RoomException error)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.onIceCandidate(String, String, int, String, ParticipantRequest) . The user should receive an acknowledgement if the operation completed successfully (no error).

Specified by:

onRecvIceCandidate in interface NotificationRoomHandler

Parameters:

request - instance of ParticipantRequest POJO to identify the user and the request

error - instance of RoomException POJO, includes a code and error message. If not null, then the operation was unsuccessful and the user should be responded accordingly.

onParticipantLeft

public void onParticipantLeft(String userName,
                              Set<UserParticipant> remainingParticipants)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.evictParticipant(String) (application-originated action). The remaining peers should be notified of this event.

Specified by:

onParticipantLeft in interface NotificationRoomHandler

Parameters:

userName - the departing user's name

remainingParticipants - instances of UserParticipant representing the remaining participants in the room

onParticipantEvicted

public void onParticipantEvicted(UserParticipant participant)

Description copied from interface: NotificationRoomHandler

Called as a result of NotificationRoomManager.evictParticipant(String) - application-originated method, not as a consequence of a client request. The participant should be notified so that the client-side application would terminate gracefully.

Specified by:

onParticipantEvicted in interface NotificationRoomHandler

Parameters:

participant - instance of UserParticipant POJO representing the evicted peer

onIceCandidate

public void onIceCandidate(String roomName,
                           String participantId,
                           String endpointName,
                           org.kurento.client.IceCandidate candidate)

Description copied from interface: RoomHandler

Called when a new IceCandidate is gathered for the local WebRTC endpoint. The user should receive a notification with all the provided information so that the candidate is added to the remote WebRTC peer.

Specified by:

onIceCandidate in interface RoomHandler

Parameters:

roomName - name of the room

participantId - identifier of the participant

endpointName - String the identifier of the local WebRTC endpoint (created in the server)

candidate - the gathered IceCandidate

onPipelineError

public void onPipelineError(String roomName,
                            Set<String> participantIds,
                            String description)

Description copied from interface: RoomHandler

Called as a result of an error intercepted on the media pipeline. The affected participants should be notified.

Specified by:

onPipelineError in interface RoomHandler

Parameters:

roomName - the room where the error occurred

participantIds - the participants identifiers

onMediaElementError

public void onMediaElementError(String roomName,
                                String participantId,
                                String description)

Description copied from interface: RoomHandler

Called as a result of an error intercepted on a media element of a participant. The participant should be notified.

Specified by:

onMediaElementError in interface RoomHandler

Parameters:

roomName - name of the room

participantId - identifier of the participant