Package org.ametys.plugins.messagingconnector

Class AbstractMessagingConnector

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.messagingconnector.AbstractMessagingConnector

All Implemented Interfaces:

MessagingConnector, LogEnabled, Initializable, Component, Serviceable

Direct Known Subclasses:

EWSConnector, ExchangeConnector, GraphConnector, ZimbraConnector

public abstract class AbstractMessagingConnector
extends AbstractLogEnabled
implements MessagingConnector, Initializable, Serviceable

Abstract implementation of MessagingConnector with cache.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.plugins.messagingconnector.MessagingConnector

MessagingConnector.AttendeeInformation, MessagingConnector.FreeBusyStatus, MessagingConnector.ResponseType

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	CacheManager used to create and get cache
protected CryptoHelper	_cryptoHelper	The crypto helper
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected UserPopulationDAO	_userPopulationDAO	The user population DAO
protected UserPreferencesManager	_userPref	The user preferences

Fields inherited from interface org.ametys.plugins.messagingconnector.MessagingConnector

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractMessagingConnector()

Method Summary

Modifier and Type	Method	Description
String	createEvent(String title, String description, String place, boolean isAllDay, ZonedDateTime startDate, ZonedDateTime endDate, EventRecurrenceTypeEnum recurrenceType, ZonedDateTime untilDate, Map<String,Boolean> attendees, UserIdentity organiser)	Create an event
void	deleteEvent(String eventId, UserIdentity organiser)	Delete an event
List<String>	getAllowedPopulationIds()	Get the list of population id allowed to the messaging connector
Map<String,MessagingConnector.AttendeeInformation>	getAttendees(String eventId, UserIdentity organiser)	Get the map of attendees for an event
List<CalendarEvent>	getEvents(UserIdentity userIdentity, int maxDays, int maxEvents)	Get the list of upcoming events from now for a given user
int	getEventsCount(UserIdentity userIdentity, int maxDays)	Return the number of upcoming events
Map<String,MessagingConnector.FreeBusyStatus>	getFreeBusy(Date startDate, Date endDate, boolean isAllDay, Set<String> attendees, UserIdentity organiser)	Get free/busy status for attendees for a time window
int	getUnreadEmailCount(UserIdentity userIdentity)	Return the number of unread mails for a given user
List<EmailMessage>	getUnreadEmails(UserIdentity userIdentity, int maxEmails)	Return the unread emails for a given user
protected String	getUserCryptedPassword(UserIdentity userIdentity)	Get the user password, still crypted
protected String	getUserPassword(UserIdentity userIdentity)	Get the user password for the messaging connector
void	initialize()
protected String	internalCreateEvent(String title, String description, String place, boolean isAllDay, ZonedDateTime startDate, ZonedDateTime endDate, EventRecurrenceTypeEnum recurrenceType, ZonedDateTime untilDate, Map<String,Boolean> attendees, UserIdentity organiser)	Create an event
protected void	internalDeleteEvent(String eventId, UserIdentity organiser)	Delete an event
protected Map<String,MessagingConnector.AttendeeInformation>	internalGetAttendees(String eventId, UserIdentity organiser)	Get the map of attendees for an event
protected abstract List<EmailMessage>	internalGetEmails(UserIdentity userIdentity, int maxEmails)	Get emails (no caching)
protected abstract int	internalGetEmailsCount(UserIdentity userIdentity)	Get emails count (no caching)
protected abstract List<CalendarEvent>	internalGetEvents(UserIdentity userIdentity, int maxDays, int maxEvents)	Get upcoming events (no caching)
protected abstract int	internalGetEventsCount(UserIdentity userIdentity, int maxDays)	Get upcoming events count (no caching)
protected Map<String,MessagingConnector.FreeBusyStatus>	internalGetFreeBusy(Date startDate, Date endDate, boolean isAllDay, Set<String> attendees, UserIdentity organiser)	Get free/busy status for attendees for a time window
protected boolean	internalIsEventExist(String eventId, UserIdentity organiser)	True if the event exist in the messaging connector
protected void	internalSetAttendees(String eventId, Map<String,Boolean> attendees, UserIdentity organiser)	Set attendees for an event
protected void	internalUpdateEvent(String eventId, String title, String description, String place, boolean isAllDay, ZonedDateTime startDate, ZonedDateTime endDate, EventRecurrenceTypeEnum recurrenceType, ZonedDateTime untilDate, Map<String,Boolean> attendees, UserIdentity organiser)	Update an event
protected boolean	isAllowed(UserIdentity userIdentity)	True if the user is allowed
boolean	isEventExist(String eventId, UserIdentity organiser)	True if the event exist in the messaging connector
boolean	isUserExist(UserIdentity userIdentity)	True if the user exist
void	service(ServiceManager manager)
void	setAttendees(String eventId, Map<String,Boolean> attendees, UserIdentity organiser)	Set attendees for an event
void	setUserPassword(UserIdentity userIdentity, String password)	Set a new password for the user
boolean	supportInvitation()	Tell if the messaging connector supports event invitation
boolean	supportUserCredential(UserIdentity userIdentity)	Check if a user credential should be saved
void	updateEvent(String eventId, String title, String description, String place, boolean isAllDay, ZonedDateTime startDate, ZonedDateTime endDate, EventRecurrenceTypeEnum recurrenceType, ZonedDateTime untilDate, Map<String,Boolean> attendees, UserIdentity organiser)	Update an event
boolean	userCredentialNeeded(UserIdentity userIdentity)	Check if the service needs user credential (some implementation can use a central API key or impersonation, some don't)

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 Detail

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

_userPref

protected UserPreferencesManager _userPref

The user preferences

_cryptoHelper

protected CryptoHelper _cryptoHelper

The crypto helper

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_cacheManager

protected AbstractCacheManager _cacheManager

CacheManager used to create and get cache

Constructor Detail

AbstractMessagingConnector

public AbstractMessagingConnector()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()

Specified by:

initialize in interface Initializable

getAllowedPopulationIds

public List<String> getAllowedPopulationIds()

Description copied from interface: MessagingConnector

Get the list of population id allowed to the messaging connector

Specified by:

getAllowedPopulationIds in interface MessagingConnector

Returns:

the list of population id allowed to the messaging connector

isAllowed

protected boolean isAllowed(UserIdentity userIdentity)

True if the user is allowed

Parameters:

userIdentity - the user identity

Returns:

true if the user is allowed

getEvents

public List<CalendarEvent> getEvents(UserIdentity userIdentity,
                                     int maxDays,
                                     int maxEvents)
                              throws MessagingConnectorException

Description copied from interface: MessagingConnector

Get the list of upcoming events from now for a given user

Specified by:

getEvents in interface MessagingConnector

Parameters:

userIdentity - the owner of the events

maxDays - The maximum number of days to search for from now

maxEvents - the maximum number of events to retrieve

Returns:

the next events

Throws:

MessagingConnectorException - if failed to get events

getEventsCount

public int getEventsCount(UserIdentity userIdentity,
                          int maxDays)
                   throws MessagingConnectorException

Description copied from interface: MessagingConnector

Return the number of upcoming events

Specified by:

getEventsCount in interface MessagingConnector

Parameters:

userIdentity - the owner of the events

maxDays - The maximum number of days to search for from now

Returns:

the number of upcoming events

Throws:

MessagingConnectorException - if failed to get events' count

getUnreadEmails

public List<EmailMessage> getUnreadEmails(UserIdentity userIdentity,
                                          int maxEmails)
                                   throws MessagingConnectorException

Description copied from interface: MessagingConnector

Return the unread emails for a given user

Specified by:

getUnreadEmails in interface MessagingConnector

Parameters:

userIdentity - the recipient of the mails

maxEmails - The max number of emails to return

Returns:

a mail messsages

Throws:

MessagingConnectorException - if failed to get mails

getUnreadEmailCount

public int getUnreadEmailCount(UserIdentity userIdentity)
                        throws MessagingConnectorException

Description copied from interface: MessagingConnector

Return the number of unread mails for a given user

Specified by:

getUnreadEmailCount in interface MessagingConnector

Parameters:

userIdentity - the receiver of the mails

Returns:

the number of unread mails

Throws:

MessagingConnectorException - if failed to get unread mails ' count

internalGetEvents

protected abstract List<CalendarEvent> internalGetEvents(UserIdentity userIdentity,
                                                         int maxDays,
                                                         int maxEvents)
                                                  throws MessagingConnectorException

Get upcoming events (no caching)

Parameters:

userIdentity - The user identity

maxDays - The maximum number of days to search for

maxEvents - The maximum number of events to retrieve

Returns:

The calendar events

Throws:

MessagingConnectorException - if failed to get events from server

internalGetEventsCount

protected abstract int internalGetEventsCount(UserIdentity userIdentity,
                                              int maxDays)
                                       throws MessagingConnectorException

Get upcoming events count (no caching)

Parameters:

userIdentity - The user identity

maxDays - The maximum number of days to search for

Returns:

The number of calendar events

Throws:

MessagingConnectorException - if failed to get events from server

internalGetEmails

protected abstract List<EmailMessage> internalGetEmails(UserIdentity userIdentity,
                                                        int maxEmails)
                                                 throws MessagingConnectorException

Get emails (no caching)

Parameters:

userIdentity - The user identity

maxEmails - The maximum number of emails to retrieve

Returns:

The emails

Throws:

MessagingConnectorException - if failed to get events from server

getUserPassword

protected String getUserPassword(UserIdentity userIdentity)
                          throws UserPreferencesException

Get the user password for the messaging connector

Parameters:

userIdentity - user to check

Returns:

the decrypted user password

Throws:

UserPreferencesException - error while reading user preferences

getUserCryptedPassword

protected String getUserCryptedPassword(UserIdentity userIdentity)
                                 throws UserPreferencesException

Get the user password, still crypted

Parameters:

userIdentity - user to check

Returns:

the still crypted user password

Throws:

UserPreferencesException - error while reading user preferences

setUserPassword

public void setUserPassword(UserIdentity userIdentity,
                            String password)
                     throws UserPreferencesException,
                            MessagingConnectorException

Description copied from interface: MessagingConnector

Set a new password for the user

Specified by:

setUserPassword in interface MessagingConnector

Parameters:

userIdentity - user that have a password change

password - new password

Throws:

UserPreferencesException - An exception occured while saving the password

MessagingConnectorException - Thrown when the messaging connector does not support user credentials

internalGetEmailsCount

protected abstract int internalGetEmailsCount(UserIdentity userIdentity)
                                       throws MessagingConnectorException

Get emails count (no caching)

Parameters:

userIdentity - The user identity

Returns:

The emails count

Throws:

MessagingConnectorException - if failed to get events from server

supportInvitation

public boolean supportInvitation()
                          throws MessagingConnectorException

Description copied from interface: MessagingConnector

Tell if the messaging connector supports event invitation

Specified by:

supportInvitation in interface MessagingConnector

Returns:

true if the messaging connector supports event invitation

Throws:

MessagingConnectorException - if failed to get events from server

isEventExist

public boolean isEventExist(String eventId,
                            UserIdentity organiser)
                     throws MessagingConnectorException

Description copied from interface: MessagingConnector

True if the event exist in the messaging connector

Specified by:

isEventExist in interface MessagingConnector

Parameters:

eventId - the event id

organiser - the organiser

Returns:

true if the event exist

Throws:

MessagingConnectorException - if an error occurred

internalIsEventExist

protected boolean internalIsEventExist(String eventId,
                                       UserIdentity organiser)
                                throws MessagingConnectorException

True if the event exist in the messaging connector

Parameters:

eventId - the event id

organiser - the organiser

Returns:

true if the event exist

Throws:

MessagingConnectorException - if an error occurred

createEvent

public String createEvent(String title,
                          String description,
                          String place,
                          boolean isAllDay,
                          ZonedDateTime startDate,
                          ZonedDateTime endDate,
                          EventRecurrenceTypeEnum recurrenceType,
                          ZonedDateTime untilDate,
                          Map<String,Boolean> attendees,
                          UserIdentity organiser)
                   throws MessagingConnectorException

Description copied from interface: MessagingConnector

Create an event

Specified by:

createEvent in interface MessagingConnector

Parameters:

title - the event title

description - the event description

place - the event place

isAllDay - if the event is all day

startDate - the event start date

endDate - the event end date

recurrenceType - recurrence type

untilDate - until date of the recurring event

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Returns:

the id of the event created

Throws:

MessagingConnectorException - if failed to get events from server

internalCreateEvent

protected String internalCreateEvent(String title,
                                     String description,
                                     String place,
                                     boolean isAllDay,
                                     ZonedDateTime startDate,
                                     ZonedDateTime endDate,
                                     EventRecurrenceTypeEnum recurrenceType,
                                     ZonedDateTime untilDate,
                                     Map<String,Boolean> attendees,
                                     UserIdentity organiser)
                              throws MessagingConnectorException

Create an event

Parameters:

title - the event title

description - the event description

place - the event place

isAllDay - if the event is all day

startDate - the event start date

endDate - the event end date

recurrenceType - recurrence type

untilDate - until date of the recurring event

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Returns:

the id of the event created

Throws:

MessagingConnectorException - if failed to get events from server

updateEvent

public void updateEvent(String eventId,
                        String title,
                        String description,
                        String place,
                        boolean isAllDay,
                        ZonedDateTime startDate,
                        ZonedDateTime endDate,
                        EventRecurrenceTypeEnum recurrenceType,
                        ZonedDateTime untilDate,
                        Map<String,Boolean> attendees,
                        UserIdentity organiser)
                 throws MessagingConnectorException

Description copied from interface: MessagingConnector

Update an event

Specified by:

updateEvent in interface MessagingConnector

Parameters:

eventId - the event id to delete

title - the event title

description - the event description

place - the event place

isAllDay - if the event is all day

startDate - the event start date

endDate - the event end date

recurrenceType - recurrence type

untilDate - until date of the recurring event

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

internalUpdateEvent

protected void internalUpdateEvent(String eventId,
                                   String title,
                                   String description,
                                   String place,
                                   boolean isAllDay,
                                   ZonedDateTime startDate,
                                   ZonedDateTime endDate,
                                   EventRecurrenceTypeEnum recurrenceType,
                                   ZonedDateTime untilDate,
                                   Map<String,Boolean> attendees,
                                   UserIdentity organiser)
                            throws MessagingConnectorException

Update an event

Parameters:

eventId - the event id to delete

title - the event title

description - the event description

place - the event place

isAllDay - if the event is all day

startDate - the event start date

endDate - the event end date

recurrenceType - recurrence type

untilDate - until date of the recurring event

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

deleteEvent

public void deleteEvent(String eventId,
                        UserIdentity organiser)
                 throws MessagingConnectorException

Description copied from interface: MessagingConnector

Delete an event

Specified by:

deleteEvent in interface MessagingConnector

Parameters:

eventId - the event id to delete

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

internalDeleteEvent

protected void internalDeleteEvent(String eventId,
                                   UserIdentity organiser)
                            throws MessagingConnectorException

Delete an event

Parameters:

eventId - the event id to delete

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

getAttendees

public Map<String,MessagingConnector.AttendeeInformation> getAttendees(String eventId,
                                                                             UserIdentity organiser)
                                                                      throws MessagingConnectorException

Description copied from interface: MessagingConnector

Get the map of attendees for an event

Specified by:

getAttendees in interface MessagingConnector

Parameters:

eventId - the event id

organiser - the event organiser

Returns:

the map of attendees (email -> attendee information)

Throws:

MessagingConnectorException - if failed to get events from server

internalGetAttendees

protected Map<String,MessagingConnector.AttendeeInformation> internalGetAttendees(String eventId,
                                                                                        UserIdentity organiser)
                                                                                 throws MessagingConnectorException

Get the map of attendees for an event

Parameters:

eventId - the event id

organiser - the event organiser

Returns:

the map of attendees (email -> attendee information)

Throws:

MessagingConnectorException - if failed to get events from server

setAttendees

public void setAttendees(String eventId,
                         Map<String,Boolean> attendees,
                         UserIdentity organiser)
                  throws MessagingConnectorException

Description copied from interface: MessagingConnector

Set attendees for an event

Specified by:

setAttendees in interface MessagingConnector

Parameters:

eventId - the event id

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

internalSetAttendees

protected void internalSetAttendees(String eventId,
                                    Map<String,Boolean> attendees,
                                    UserIdentity organiser)
                             throws MessagingConnectorException

Set attendees for an event

Parameters:

eventId - the event id

attendees - the map of attendees (email -> optional or requested) to set

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

getFreeBusy

public Map<String,MessagingConnector.FreeBusyStatus> getFreeBusy(Date startDate,
                                                                       Date endDate,
                                                                       boolean isAllDay,
                                                                       Set<String> attendees,
                                                                       UserIdentity organiser)
                                                                throws MessagingConnectorException

Description copied from interface: MessagingConnector

Get free/busy status for attendees for a time window

Specified by:

getFreeBusy in interface MessagingConnector

Parameters:

startDate - the start date

endDate - the end date

isAllDay - true if is an allday event

attendees - the list of attendees email

organiser - the event organiser

Returns:

the map of attendees (email -> freeBusy status)

Throws:

MessagingConnectorException - if failed to get events from server

internalGetFreeBusy

protected Map<String,MessagingConnector.FreeBusyStatus> internalGetFreeBusy(Date startDate,
                                                                                  Date endDate,
                                                                                  boolean isAllDay,
                                                                                  Set<String> attendees,
                                                                                  UserIdentity organiser)
                                                                           throws MessagingConnectorException

Get free/busy status for attendees for a time window

Parameters:

startDate - the start date

endDate - the end date

isAllDay - true if is an allday event

attendees - the list of attendees email

organiser - the event organiser

Returns:

the map of attendees (email -> freeBusy status)

Throws:

MessagingConnectorException - if failed to get events from server

userCredentialNeeded

public boolean userCredentialNeeded(UserIdentity userIdentity)

Description copied from interface: MessagingConnector

Check if the service needs user credential (some implementation can use a central API key or impersonation, some don't)

Specified by:

userCredentialNeeded in interface MessagingConnector

Parameters:

userIdentity - The useridentity involved in the demand

Returns:

True if the service is configured to ask for user credential

supportUserCredential

public boolean supportUserCredential(UserIdentity userIdentity)

Description copied from interface: MessagingConnector

Check if a user credential should be saved

Specified by:

supportUserCredential in interface MessagingConnector

Parameters:

userIdentity - The useridentity involved in the demand

Returns:

true if this implementation supports user credential (and is configured to use them)

isUserExist

public boolean isUserExist(UserIdentity userIdentity)
                    throws MessagingConnectorException

Description copied from interface: MessagingConnector

True if the user exist

Specified by:

isUserExist in interface MessagingConnector

Parameters:

userIdentity - the user identity

Returns:

true if the user exist

Throws:

MessagingConnectorException - if failed to get events from server