Package org.ametys.plugins.rocket.chat

Class RocketChatHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.rocket.chat.RocketChatHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Contextualizable, Serviceable

public class RocketChatHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable, Initializable

Helper for the rocket.chat link

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RocketChatHelper.Message	A Rocket.Chat message
static final record	RocketChatHelper.RoomInfo	A Rocket.Chat room info for a user

Field Summary

Fields

Modifier and Type	Field	Description
protected CryptoHelper	_cryptoHelper	Cryptography
protected CurrentUserProvider	_currentUserProvider	Current user provider
protected JSONUtils	_jsonUtils	JSON Utils
protected UserManager	_userManager	User Manager
protected UserPreferencesManager	_userPreferencesManager	User Preferences
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
RocketChatHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_createCaches()	Creates the caches
protected boolean	_isOperationSuccessful(Map<String,Object> result)	Read the JSON result to test for success
void	contextualize(Context context)
String	createChat(List<String> users)	Creates a new chat with the current user and the given users
Map<String,String>	getAmetysUserInfo(User user, boolean externalUrl, int imageSize)	Get the user info
Collection<Map<String,Object>>	getLastMessages()	Get the last messages of the current user
List<RocketChatHelper.Message>	getLastMessages(UserIdentity user, String roomId, int count, ZonedDateTime since)	Get the n last messages of the user in the room
Map<String,String>	getStatusCache()	Get the current cache status
Set<RocketChatHelper.RoomInfo>	getThreadsWithUnreadMessages(UserIdentity user, ZonedDateTime since)	List the unread messages of a user in the given time window
Map<String,Object>	getUser(UserIdentity userIdentity, boolean updateIfNotNew)	Get (or create) a new user.
Set<UserIdentity>	getUsersWithRecentMessages(ZonedDateTime since)	List all the users with messages in the given time window
void	initialize()
Map<String,Object>	login()	Login the current user
void	service(ServiceManager manager)
void	setStatus(String newStatus)	Set the current user new status
void	updateUserInfos(UserIdentity userIdentity, boolean changePassword)	Update user name, email, avatar...

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

_jsonUtils

protected JSONUtils _jsonUtils

JSON Utils

_userManager

protected UserManager _userManager

User Manager

_userPreferencesManager

protected UserPreferencesManager _userPreferencesManager

User Preferences

_cryptoHelper

protected CryptoHelper _cryptoHelper

Cryptography

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

Current user provider

Constructor Details

RocketChatHelper

public RocketChatHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_createCaches

protected void _createCaches()

Creates the caches

getUser

public Map<String,Object> getUser(UserIdentity userIdentity,
 boolean updateIfNotNew)
                           throws IOException,
UserPreferencesException,
InterruptedException

Get (or create) a new user.

Parameters:

userIdentity - the user that will be mirrored into chat

updateIfNotNew - If the user was already existing, should it be updated (except password)?

Returns:

the user info or null if user does not exist in chat and create was not required

Throws:

IOException - something went wrong

UserPreferencesException - error while reading the user preferences

InterruptedException - error while reading the user preferences

getAmetysUserInfo

public Map<String,String> getAmetysUserInfo(User user,
 boolean externalUrl,
 int imageSize)

Get the user info

Parameters:

user - The user

externalUrl - Is the image url external?

imageSize - The size of the avatar

Returns:

The name, email and avatar

updateUserInfos

public void updateUserInfos(UserIdentity userIdentity,
 boolean changePassword)
                     throws IOException,
UserPreferencesException,
InterruptedException

Update user name, email, avatar... on chat server

Parameters:

userIdentity - The user to update

changePassword - Update the user password (slow)

Throws:

UserPreferencesException - If an error occurred while getting user infos

IOException - If an error occurred while updating

InterruptedException - If an error occurred while updating

_isOperationSuccessful

protected boolean _isOperationSuccessful(Map<String,Object> result)

Read the JSON result to test for success

Parameters:

result - the JSON result of a rest call

Returns:

true if success

login

public Map<String,Object> login()
                         throws IOException,
UserPreferencesException,
InterruptedException

Login the current user

Returns:

The info about the user

Throws:

UserPreferencesException - If the user password stored in prefs has an issue

IOException - If an error occurred

InterruptedException - If an error occurred

getStatusCache

public Map<String,String> getStatusCache()
                                  throws UserPreferencesException,
IOException,
InterruptedException

Get the current cache status

Returns:

The association login#populationId <-> status (online, offline...)

Throws:

InterruptedException - If an error occurred

IOException - If an error occurred

UserPreferencesException - If an error occurred

setStatus

public void setStatus(String newStatus)
               throws UserPreferencesException,
IOException,
InterruptedException

Set the current user new status

Parameters:

newStatus - The new status between online, offline, busy or away

Throws:

InterruptedException - If an error occurred

IOException - If an error occurred

UserPreferencesException - If an error occurred

getLastMessages

public Collection<Map<String,Object>> getLastMessages()
                                               throws IOException,
UserPreferencesException,
InterruptedException

Get the last messages of the current user

Returns:

The messages

Throws:

IOException - something went wrong

UserPreferencesException - something went wrong

InterruptedException - something went wrong

createChat

public String createChat(List<String> users)
                  throws UserPreferencesException,
IOException,
InterruptedException

Creates a new chat with the current user and the given users

Parameters:

users - The parteners

Returns:

The chat id

Throws:

InterruptedException - If an error occurred

IOException - If an error occurred

UserPreferencesException - If an error occurred

getUsersWithRecentMessages

public Set<UserIdentity> getUsersWithRecentMessages(ZonedDateTime since)
                                             throws IOException

List all the users with messages in the given time window

Parameters:

since - The date since the messages should be considered

Returns:

The list of users

Throws:

IOException - If an error occurred

getThreadsWithUnreadMessages

public Set<RocketChatHelper.RoomInfo> getThreadsWithUnreadMessages(UserIdentity user,
 ZonedDateTime since)
                                                            throws IOException,
UserPreferencesException,
InterruptedException

List the unread messages of a user in the given time window

Parameters:

user - The user to consider

since - The date to consider

Returns:

The ids of the room containing unread messages

Throws:

IOException - If an error occurred

UserPreferencesException - If an error occurred

InterruptedException - If an error occurred

getLastMessages

public List<RocketChatHelper.Message> getLastMessages(UserIdentity user,
 String roomId,
 int count,
 ZonedDateTime since)
                                               throws IOException,
UserPreferencesException,
InterruptedException

Get the n last messages of the user in the room

Parameters:

user - The user to consider

roomId - The room id to consider

count - The number of messages to retrieve

since - Since the max date

Returns:

The message

Throws:

IOException - If an error occurred

UserPreferencesException - If an error occurred

InterruptedException - If an error occurred