CometdWebConferencingService (eXo Web Conferencing :: Extension Services 1.3.0-M02 API)

java.lang.Object
- org.exoplatform.webconferencing.cometd.CometdWebConferencingService

All Implemented Interfaces:

org.picocontainer.Startable
```
public class CometdWebConferencingService
extends Object
implements org.picocontainer.Startable
```
Created by The eXo Platform SAS.

Version:

$Id: CometdWebConferencingService.java 00000 Aug 17, 2017 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CometdWebConferencingService.CallService
The Class CallService.

Nested Classes
Modifier and Type	Class and Description
`class`	`CometdWebConferencingService.CallService` The Class CallService.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CALL_MAX_FACTOR` Maximum threads per CPU for thread executors of user call channel.
`static int`	`CALL_QUEUE_FACTOR` Queue size per CPU for thread executors of user call channel.
`static String`	`CALL_SUBSCRIPTION_CHANNEL_NAME` The Constant CALL_SUBSCRIPTION_CHANNEL_NAME.
`static String`	`CALL_SUBSCRIPTION_CHANNEL_NAME_ALL` The Constant CALL_SUBSCRIPTION_CHANNEL_NAME_ALL.
`static String`	`CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS` The Constant CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS.
`static String`	`CALL_THREAD_PREFIX` Thread name used for calls executor.
`protected ExecutorService`	`callHandlers` The call handlers.
`protected CallLogService`	`callLogs` The call logs.
`static String`	`CALLS_CHANNEL_NAME` The Constant CALLS_CHANNEL_NAME.
`static String`	`COMMAND_CREATE` The Constant COMMAND_CREATE.
`static String`	`COMMAND_DELETE` The Constant COMMAND_DELETE.
`static String`	`COMMAND_GET` The Constant COMMAND_GET.
`static String`	`COMMAND_GET_CALLS_STATE` The Constant COMMAND_GET_CALLS_STATE.
`static String`	`COMMAND_UPDATE` The Constant COMMAND_UPDATE.
`protected org.mortbay.cometd.continuation.EXoContinuationBayeux`	`exoBayeux` The exo bayeux.
`protected org.exoplatform.services.security.IdentityRegistry`	`identityRegistry` The identity registry.
`static String`	`LOG_OK` The Constant LOG_OK.
`static String`	`LOGS_CHANNEL_NAME` The Constant LOGS_CHANNEL_NAME.
`static int`	`MIN_MAX_THREADS` Minimal number of threads maximum possible for remote calls' thread executors.
`static int`	`MIN_THREADS` Base minimum number of threads for remote calls' thread executors.
`protected org.exoplatform.services.organization.OrganizationService`	`organization` The organization.
`protected CometdWebConferencingService.CallService`	`service` The service.
`protected org.exoplatform.services.jcr.ext.app.SessionProviderService`	`sessionProviders` The session providers.
`static int`	`THREAD_IDLE_TIME` Thread idle time for thread executors (in seconds).
`static String`	`USER_SUBSCRIPTION_CHANNEL_NAME` The Constant USER_SUBSCRIPTION_CHANNEL_NAME.
`static String`	`USER_SUBSCRIPTION_CHANNEL_PATTERN` The Constant USER_SUBSCRIPTION_CHANNEL_PATTERN.
`protected WebConferencingService`	`webConferencing` The web conferencing.

Constructor Summary

Constructors
Constructor and Description
`CometdWebConferencingService(org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders, org.exoplatform.services.security.IdentityRegistry identityRegistry, org.exoplatform.services.organization.OrganizationService organization, WebConferencingService webConferencing, org.mortbay.cometd.continuation.EXoContinuationBayeux exoBayeux, CallLogService callLogs)` Instantiates a new CometD interaction service for WebConferencing.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`asString(Object obj)` Return object if it's String instance or null if it is not.
`protected String`	`callId(String type, String info)` Call id.
`protected String`	`channelsAsString(Set<org.cometd.bayeux.server.ServerChannel> channels)` Channels as string.
`protected String`	`channelUserId(String channelId)` Channel user id.
`protected ExecutorService`	`createThreadExecutor(String threadNamePrefix, int maxFactor, int queueFactor)` Create a new thread executor service.
`protected String`	`currentUserId(org.cometd.bayeux.server.ServerMessage message)` Current user id.
`String`	`getCometdServerPath()` Gets the cometd server path.
`String`	`getUserToken(String userId)` Gets the user token.
`void`	`start()`
`void`	`stop()`

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

- Field Detail
  - CALLS_CHANNEL_NAME
```
public static final String CALLS_CHANNEL_NAME
```
    The Constant CALLS_CHANNEL_NAME.
    
    See Also:
    
    Constant Field Values
  - LOGS_CHANNEL_NAME
```
public static final String LOGS_CHANNEL_NAME
```
    The Constant LOGS_CHANNEL_NAME.
    
    See Also:
    
    Constant Field Values
  - CALL_SUBSCRIPTION_CHANNEL_NAME
```
public static final String CALL_SUBSCRIPTION_CHANNEL_NAME
```
    The Constant CALL_SUBSCRIPTION_CHANNEL_NAME.
    
    See Also:
    
    Constant Field Values
  - CALL_SUBSCRIPTION_CHANNEL_NAME_ALL
```
public static final String CALL_SUBSCRIPTION_CHANNEL_NAME_ALL
```
    The Constant CALL_SUBSCRIPTION_CHANNEL_NAME_ALL.
    
    See Also:
    
    Constant Field Values
  - CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS
```
public static final String CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS
```
    The Constant CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS.
    
    See Also:
    
    Constant Field Values
  - USER_SUBSCRIPTION_CHANNEL_NAME
```
public static final String USER_SUBSCRIPTION_CHANNEL_NAME
```
    The Constant USER_SUBSCRIPTION_CHANNEL_NAME.
    
    See Also:
    
    Constant Field Values
  - USER_SUBSCRIPTION_CHANNEL_PATTERN
```
public static final String USER_SUBSCRIPTION_CHANNEL_PATTERN
```
    The Constant USER_SUBSCRIPTION_CHANNEL_PATTERN.
    
    See Also:
    
    Constant Field Values
  - COMMAND_GET
```
public static final String COMMAND_GET
```
    The Constant COMMAND_GET.
    
    See Also:
    
    Constant Field Values
  - COMMAND_CREATE
```
public static final String COMMAND_CREATE
```
    The Constant COMMAND_CREATE.
    
    See Also:
    
    Constant Field Values
  - COMMAND_UPDATE
```
public static final String COMMAND_UPDATE
```
    The Constant COMMAND_UPDATE.
    
    See Also:
    
    Constant Field Values
  - COMMAND_DELETE
```
public static final String COMMAND_DELETE
```
    The Constant COMMAND_DELETE.
    
    See Also:
    
    Constant Field Values
  - COMMAND_GET_CALLS_STATE
```
public static final String COMMAND_GET_CALLS_STATE
```
    The Constant COMMAND_GET_CALLS_STATE.
    
    See Also:
    
    Constant Field Values
  - LOG_OK
```
public static final String LOG_OK
```
    The Constant LOG_OK.
    
    See Also:
    
    Constant Field Values
  - MIN_THREADS
```
public static final int MIN_THREADS
```
    Base minimum number of threads for remote calls' thread executors.
    
    See Also:
    
    Constant Field Values
  - MIN_MAX_THREADS
```
public static final int MIN_MAX_THREADS
```
    Minimal number of threads maximum possible for remote calls' thread executors.
    
    See Also:
    
    Constant Field Values
  - THREAD_IDLE_TIME
```
public static final int THREAD_IDLE_TIME
```
    Thread idle time for thread executors (in seconds).
    
    See Also:
    
    Constant Field Values
  - CALL_MAX_FACTOR
```
public static final int CALL_MAX_FACTOR
```
    Maximum threads per CPU for thread executors of user call channel.
    
    See Also:
    
    Constant Field Values
  - CALL_QUEUE_FACTOR
```
public static final int CALL_QUEUE_FACTOR
```
    Queue size per CPU for thread executors of user call channel.
    
    See Also:
    
    Constant Field Values
  - CALL_THREAD_PREFIX
```
public static final String CALL_THREAD_PREFIX
```
    Thread name used for calls executor.
    
    See Also:
    
    Constant Field Values
  - webConferencing
```
protected final WebConferencingService webConferencing
```
    The web conferencing.
  - exoBayeux
```
protected final org.mortbay.cometd.continuation.EXoContinuationBayeux exoBayeux
```
    The exo bayeux.
  - service
```
protected final CometdWebConferencingService.CallService service
```
    The service.
  - organization
```
protected final org.exoplatform.services.organization.OrganizationService organization
```
    The organization.
  - sessionProviders
```
protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders
```
    The session providers.
  - identityRegistry
```
protected final org.exoplatform.services.security.IdentityRegistry identityRegistry
```
    The identity registry.
  - callLogs
```
protected final CallLogService callLogs
```
    The call logs.
  - callHandlers
```
protected final ExecutorService callHandlers
```
    The call handlers.
- Constructor Detail
  - CometdWebConferencingService
```
public CometdWebConferencingService(org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviders,
                                    org.exoplatform.services.security.IdentityRegistry identityRegistry,
                                    org.exoplatform.services.organization.OrganizationService organization,
                                    WebConferencingService webConferencing,
                                    org.mortbay.cometd.continuation.EXoContinuationBayeux exoBayeux,
                                    CallLogService callLogs)
```
    Instantiates a new CometD interaction service for WebConferencing.
    
    Parameters:
    
    sessionProviders - the session providers
    
    identityRegistry - the identity registry
    
    organization - the organization
    
    webConferencing - the web conferencing
    
    exoBayeux - the exo bayeux
    
    callLogs - the call logs
- Method Detail
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.picocontainer.Startable
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.picocontainer.Startable
  - getCometdServerPath
```
public String getCometdServerPath()
```
    Gets the cometd server path.
    
    Returns:
    
    the cometd server path
  - getUserToken
```
public String getUserToken(String userId)
```
    Gets the user token.
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    the user token
  - currentUserId
```
protected String currentUserId(org.cometd.bayeux.server.ServerMessage message)
```
    Current user id.
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the string, if user cannot be defined it will be IdentityConstants.ANONIM
  - channelUserId
```
protected String channelUserId(String channelId)
                        throws IndexOutOfBoundsException
```
    Channel user id. It's assumed an user channel USER_SUBSCRIPTION_CHANNEL_NAME.
    
    Parameters:
    
    channelId - the channel id
    
    Returns:
    
    the string
    
    Throws:
    
    IndexOutOfBoundsException - if channel id doesn't look like an user channel
  - channelsAsString
```
protected String channelsAsString(Set<org.cometd.bayeux.server.ServerChannel> channels)
```
    Channels as string.
    
    Parameters:
    
    channels - the channels
    
    Returns:
    
    the string
  - callId
```
protected String callId(String type,
                        String info)
```
    Call id.
    
    Parameters:
    
    type - the type
    
    info - the id
    
    Returns:
    
    the string
  - asString
```
protected String asString(Object obj)
```
    Return object if it's String instance or null if it is not.
    
    Parameters:
    
    obj - the obj
    
    Returns:
    
    the string or null
  - createThreadExecutor
```
protected ExecutorService createThreadExecutor(String threadNamePrefix,
                                               int maxFactor,
                                               int queueFactor)
```
    Create a new thread executor service.
    
    Parameters:
    
    threadNamePrefix - the thread name prefix
    
    maxFactor - - max processes per CPU core
    
    queueFactor - - queue size per CPU core
    
    Returns:
    
    the executor service

Class CometdWebConferencingService

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CALLS_CHANNEL_NAME

LOGS_CHANNEL_NAME

CALL_SUBSCRIPTION_CHANNEL_NAME

CALL_SUBSCRIPTION_CHANNEL_NAME_ALL

CALL_SUBSCRIPTION_CHANNEL_NAME_PARAMS

USER_SUBSCRIPTION_CHANNEL_NAME

USER_SUBSCRIPTION_CHANNEL_PATTERN

COMMAND_GET

COMMAND_CREATE

COMMAND_UPDATE

COMMAND_DELETE

COMMAND_GET_CALLS_STATE

LOG_OK

MIN_THREADS

MIN_MAX_THREADS

THREAD_IDLE_TIME

CALL_MAX_FACTOR

CALL_QUEUE_FACTOR

CALL_THREAD_PREFIX

webConferencing

exoBayeux

service

organization

sessionProviders

identityRegistry

callLogs

callHandlers

Constructor Detail

CometdWebConferencingService

Method Detail

start

stop

getCometdServerPath

getUserToken

currentUserId

channelUserId

channelsAsString

callId

asString

createThreadExecutor