org.exoplatform.chat.services

Interface ChatDataStorage

All Known Implementing Classes:

ChatMongoDataStorage

public interface ChatDataStorage

Method Summary

Modifier and Type	Method and Description
void	delete(String room, String user, String messageId, String dbName)
void	deleteTeamRoom(String roomId, String user, String dbName) Delete a Team Room by its corresponding ID. Nothing happen if : the roomId doesn't exists the roomId doesn't correspond to a Team Room the specified user is not the owner of the Team Room
void	edit(String room, String user, String messageId, String message, String dbName)
List<org.exoplatform.chat.model.RoomBean>	getExistingRooms(String user, boolean withPublic, boolean isAdmin, org.exoplatform.chat.services.NotificationService notificationService, org.exoplatform.chat.services.TokenService tokenService, String dbName)
String	getExternalRoom(String identifier, String dbName)
org.exoplatform.chat.model.MessageBean	getMessage(String roomId, String messageId, String dbName)
int	getNumberOfMessages(String dbName)
int	getNumberOfRooms(String dbName)
String	getRoom(List<String> users, String dbName)
org.exoplatform.chat.model.RoomsBean	getRooms(String user, List<String> onlineUsers, String filter, boolean withUsers, boolean withSpaces, boolean withPublic, boolean withOffline, boolean isAdmin, int limit, org.exoplatform.chat.services.NotificationService notificationService, org.exoplatform.chat.services.TokenService tokenService, String dbName)
String	getSpaceRoom(String space, String dbName)
String	getSpaceRoomByName(String name, String dbName)
String	getTeamCreator(String room, String dbName)
String	getTeamRoom(String team, String user, String dbName)
org.exoplatform.chat.model.RoomBean	getTeamRoomById(String roomId, String dbName) Retrieve a Room by its ID
List<org.exoplatform.chat.model.RoomBean>	getTeamRoomByName(String teamName, String dbName) Return rooms by name
String	getTypeRoomChat(String roomId, String dbName)
String	read(String room, boolean isTextOnly, Long fromTimestamp, Long toTimestamp, String dbName, int limitToLoad) Read messages from room from a dedicated timestamp to another usin dbName with limit.
String	read(String room, boolean isTextOnly, Long fromTimestamp, String dbName)
String	read(String room, String dbName)
String	save(String message, String user, String room, String isSystem, String options, String dbName)
void	setRoomName(String room, String name, String dbName)
void	write(String message, String user, String room, String isSystem, String dbName)
void	write(String message, String user, String room, String isSystem, String options, String dbName)

Method Detail

write

void write(String message,
           String user,
           String room,
           String isSystem,
           String dbName)

write

void write(String message,
           String user,
           String room,
           String isSystem,
           String options,
           String dbName)

save

String save(String message,
            String user,
            String room,
            String isSystem,
            String options,
            String dbName)

delete

void delete(String room,
            String user,
            String messageId,
            String dbName)

deleteTeamRoom

void deleteTeamRoom(String roomId,
                    String user,
                    String dbName)

Delete a Team Room by its corresponding ID.
Nothing happen if :

• the roomId doesn't exists
• the roomId doesn't correspond to a Team Room
• the specified user is not the owner of the Team Room

Parameters:

roomId - the team room ID to delete

user - the owner of the team room

dbName - the database to use for the query

edit

void edit(String room,
          String user,
          String messageId,
          String message,
          String dbName)

read

String read(String room,
            String dbName)

read

String read(String room,
            boolean isTextOnly,
            Long fromTimestamp,
            String dbName)

read

String read(String room,
            boolean isTextOnly,
            Long fromTimestamp,
            Long toTimestamp,
            String dbName,
            int limitToLoad)

Read messages from room from a dedicated timestamp to another usin dbName with limit.

Parameters:

room -

isTextOnly -

fromTimestamp -

toTimestamp -

dbName -

limitToLoad -

Returns:

getMessage

org.exoplatform.chat.model.MessageBean getMessage(String roomId,
                                                  String messageId,
                                                  String dbName)

getSpaceRoom

String getSpaceRoom(String space,
                    String dbName)

getSpaceRoomByName

String getSpaceRoomByName(String name,
                          String dbName)

getTeamRoom

String getTeamRoom(String team,
                   String user,
                   String dbName)

getExternalRoom

String getExternalRoom(String identifier,
                       String dbName)

getTeamCreator

String getTeamCreator(String room,
                      String dbName)

setRoomName

void setRoomName(String room,
                 String name,
                 String dbName)

getTeamRoomById

org.exoplatform.chat.model.RoomBean getTeamRoomById(String roomId,
                                                    String dbName)

Retrieve a Room by its ID

Parameters:

roomId - the ID of the room

dbName - the database to use for the query

Returns:

the room or null if the room doesn't exists

getRoom

String getRoom(List<String> users,
               String dbName)

getTypeRoomChat

String getTypeRoomChat(String roomId,
                       String dbName)

getExistingRooms

List<org.exoplatform.chat.model.RoomBean> getExistingRooms(String user,
                                                           boolean withPublic,
                                                           boolean isAdmin,
                                                           org.exoplatform.chat.services.NotificationService notificationService,
                                                           org.exoplatform.chat.services.TokenService tokenService,
                                                           String dbName)

Parameters:

user -

withPublic -

isAdmin -

notificationService -

tokenService -

dbName -

Returns:

All existing personal rooms of given user

getRooms

org.exoplatform.chat.model.RoomsBean getRooms(String user,
                                              List<String> onlineUsers,
                                              String filter,
                                              boolean withUsers,
                                              boolean withSpaces,
                                              boolean withPublic,
                                              boolean withOffline,
                                              boolean isAdmin,
                                              int limit,
                                              org.exoplatform.chat.services.NotificationService notificationService,
                                              org.exoplatform.chat.services.TokenService tokenService,
                                              String dbName)

getNumberOfRooms

int getNumberOfRooms(String dbName)

getNumberOfMessages

int getNumberOfMessages(String dbName)

getTeamRoomByName

List<org.exoplatform.chat.model.RoomBean> getTeamRoomByName(String teamName,
                                                            String dbName)

Return rooms by name

Parameters:

teamName -

dbName -

Returns: