org.apache.openmeetings.core.session.store

Interface IClientPersistenceStore

All Known Implementing Classes:

DatabaseStore, HashMapStore

public interface IClientPersistenceStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IClientPersistenceStore.DEBUG_DETAILS

Method Summary

Modifier and Type	Method and Description
void	clear() called upon start of the session cache
boolean	containsKey(org.apache.openmeetings.db.entity.server.Server server, String streamId)
org.apache.openmeetings.db.entity.room.Client	get(org.apache.openmeetings.db.entity.server.Server server, String streamId) by server and publicSID
Collection<org.apache.openmeetings.db.entity.room.Client>	getClients()
List<org.apache.openmeetings.db.entity.room.Client>	getClientsByPublicSID(org.apache.openmeetings.db.entity.server.Server server, String publicSID)
Map<Long,List<org.apache.openmeetings.db.entity.room.Client>>	getClientsByPublicSID(String publicSID) Searches for the publicSID across all servers
List<org.apache.openmeetings.db.entity.room.Client>	getClientsByRoomId(Long roomId) We ignore the server here, cause ONE room can only be on ONE server and often we don't know where.
Collection<org.apache.openmeetings.db.entity.room.Client>	getClientsByServer(org.apache.openmeetings.db.entity.server.Server server) get all clients by a specific Server
Collection<org.apache.openmeetings.db.entity.room.Client>	getClientsByUserId(org.apache.openmeetings.db.entity.server.Server server, Long userId)
Collection<org.apache.openmeetings.db.entity.room.Client>	getClientsWithServer() if database cache + cluster is enabled, the server object will be loaded into the client
String	getDebugInformation(List<IClientPersistenceStore.DEBUG_DETAILS> detailLevel) Get some session statistics
List<Long>	getRoomsIdsByServer(org.apache.openmeetings.db.entity.server.Server server) returns a list of roomIds (unique) that are currently active on the given server In case the session is stored in the memory (no-cluster setup) it will always return simply all active roomIds
void	put(String streamId, org.apache.openmeetings.db.entity.room.Client rcl)
void	remove(org.apache.openmeetings.db.entity.server.Server server, String streamId)
int	size()
int	sizeByServer(org.apache.openmeetings.db.entity.server.Server server)
Collection<org.apache.openmeetings.db.entity.room.Client>	values()

Method Detail

clear

void clear()

called upon start of the session cache

put

void put(String streamId,
         org.apache.openmeetings.db.entity.room.Client rcl)

Parameters:

streamId -

rcl -

containsKey

boolean containsKey(org.apache.openmeetings.db.entity.server.Server server,
                    String streamId)

Parameters:

server -

streamId -

Returns:

get

org.apache.openmeetings.db.entity.room.Client get(org.apache.openmeetings.db.entity.server.Server server,
                                                  String streamId)

by server and publicSID

Parameters:

server -

streamId -

Returns:

will return null if the client does not exist in the list

getClientsByPublicSID

List<org.apache.openmeetings.db.entity.room.Client> getClientsByPublicSID(org.apache.openmeetings.db.entity.server.Server server,
                                                                          String publicSID)

Parameters:

server -

publicSID -

Returns:

will return an empty list if nothing available

getClientsByPublicSID

Map<Long,List<org.apache.openmeetings.db.entity.room.Client>> getClientsByPublicSID(String publicSID)

Searches for the publicSID across all servers

Parameters:

publicSID -

Returns:

will return a map with the serverId as key and the RoomClients as list in the value

getClients

Collection<org.apache.openmeetings.db.entity.room.Client> getClients()

getClientsByServer

Collection<org.apache.openmeetings.db.entity.room.Client> getClientsByServer(org.apache.openmeetings.db.entity.server.Server server)

get all clients by a specific Server

Parameters:

server -

Returns:

will return an empty map if nothing available

getClientsByUserId

Collection<org.apache.openmeetings.db.entity.room.Client> getClientsByUserId(org.apache.openmeetings.db.entity.server.Server server,
                                                                             Long userId)

Parameters:

server -

userId -

Returns:

will return an empty list if nothing available

getClientsByRoomId

List<org.apache.openmeetings.db.entity.room.Client> getClientsByRoomId(Long roomId)

We ignore the server here, cause ONE room can only be on ONE server and often we don't know where.

Parameters:

roomId -

Returns:

will return an empty map if nothing available

remove

void remove(org.apache.openmeetings.db.entity.server.Server server,
            String streamId)

size

int size()

sizeByServer

int sizeByServer(org.apache.openmeetings.db.entity.server.Server server)

values

Collection<org.apache.openmeetings.db.entity.room.Client> values()

getDebugInformation

String getDebugInformation(List<IClientPersistenceStore.DEBUG_DETAILS> detailLevel)

Get some session statistics

Parameters:

detailLevel -

Returns:

getRoomsIdsByServer

List<Long> getRoomsIdsByServer(org.apache.openmeetings.db.entity.server.Server server)

returns a list of roomIds (unique) that are currently active on the given server In case the session is stored in the memory (no-cluster setup) it will always return simply all active roomIds

Parameters:

server -

Returns:

getClientsWithServer

Collection<org.apache.openmeetings.db.entity.room.Client> getClientsWithServer()

if database cache + cluster is enabled, the server object will be loaded into the client

Returns: