Package org.ametys.plugins.exchange

Class EWSConnector

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.messagingconnector.AbstractMessagingConnector

org.ametys.plugins.exchange.EWSConnector

All Implemented Interfaces:

MessagingConnector, LogEnabled, Initializable, Component, Serviceable

public class EWSConnector
extends AbstractMessagingConnector

The connector used by the messaging connector plugin when connecting to Exchange Server.
Implemented through the Microsoft EWS API.

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
static String	INNER_ROLE	The avalon role

Fields inherited from class org.ametys.plugins.messagingconnector.AbstractMessagingConnector

_cacheManager, _cryptoHelper, _currentUserProvider, _userPopulationDAO, _userPref

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

ROLE

Constructor Summary

Constructors

Constructor	Description
EWSConnector()

Method Summary

Modifier and Type	Method	Description
protected microsoft.exchange.webservices.data.core.ExchangeService	getService(UserIdentity userIdentity)	Get the service of connexion to the server exchange
protected static String	html2text(String html)	Converts a given html String into a plain text String
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
void	internalDeleteEvent(String eventId, UserIdentity organiser)	Delete an event
Map<String,MessagingConnector.AttendeeInformation>	internalGetAttendees(String eventId, UserIdentity organiser)	Get the map of attendees for an event
protected List<EmailMessage>	internalGetEmails(UserIdentity userIdentity, int maxEmails)	Get emails (no caching)
protected int	internalGetEmailsCount(UserIdentity userIdentity)	Get emails count (no caching)
protected List<CalendarEvent>	internalGetEvents(UserIdentity userIdentity, int maxDays, int maxEvents)	Get upcoming events (no caching)
protected int	internalGetEventsCount(UserIdentity userIdentity, int maxDays)	Get upcoming events count (no caching)
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
boolean	internalIsEventExist(String eventId, UserIdentity organiser)	True if the event exist in the messaging connector
void	internalSetAttendees(String eventId, Map<String,Boolean> attendees, UserIdentity organiser)	Set attendees for an event
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
boolean	isUserExist(UserIdentity userIdentity)	True if the user exist
void	service(ServiceManager manager)
boolean	supportInvitation()	Tell if the messaging connector supports event invitation
boolean	supportUserCredential(UserIdentity userIdentity)	Check if a user credential should be saved

Methods inherited from class org.ametys.plugins.messagingconnector.AbstractMessagingConnector

createEvent, deleteEvent, getAllowedPopulationIds, getAttendees, getEvents, getEventsCount, getFreeBusy, getUnreadEmailCount, getUnreadEmails, getUserCryptedPassword, getUserPassword, initialize, isAllowed, isEventExist, setAttendees, setUserPassword, updateEvent, userCredentialNeeded

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

INNER_ROLE

public static final String INNER_ROLE

The avalon role

Constructor Detail

EWSConnector

public EWSConnector()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractMessagingConnector

Throws:

ServiceException

getService

protected microsoft.exchange.webservices.data.core.ExchangeService getService(UserIdentity userIdentity)
                                                                       throws URISyntaxException

Get the service of connexion to the server exchange

Parameters:

userIdentity - The user identity

Returns:

the service

Throws:

URISyntaxException - if an error occurred

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

Overrides:

supportUserCredential in class AbstractMessagingConnector

Parameters:

userIdentity - The useridentity involved in the demand

Returns:

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

internalGetEvents

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

Description copied from class: AbstractMessagingConnector

Get upcoming events (no caching)

Specified by:

internalGetEvents in class AbstractMessagingConnector

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 int internalGetEventsCount(UserIdentity userIdentity,
                                     int maxDays)
                              throws MessagingConnectorException

Description copied from class: AbstractMessagingConnector

Get upcoming events count (no caching)

Specified by:

internalGetEventsCount in class AbstractMessagingConnector

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 List<EmailMessage> internalGetEmails(UserIdentity userIdentity,
                                               int maxEmails)
                                        throws MessagingConnectorException

Description copied from class: AbstractMessagingConnector

Get emails (no caching)

Specified by:

internalGetEmails in class AbstractMessagingConnector

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

internalGetEmailsCount

protected int internalGetEmailsCount(UserIdentity userIdentity)
                              throws MessagingConnectorException

Description copied from class: AbstractMessagingConnector

Get emails count (no caching)

Specified by:

internalGetEmailsCount in class AbstractMessagingConnector

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

Overrides:

supportInvitation in class AbstractMessagingConnector

Returns:

true if the messaging connector supports event invitation

Throws:

MessagingConnectorException - if failed to get events from server

internalIsEventExist

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

Description copied from class: AbstractMessagingConnector

True if the event exist in the messaging connector

Overrides:

internalIsEventExist in class AbstractMessagingConnector

Parameters:

eventId - the event id

organiser - the organiser

Returns:

true if the event exist

Throws:

MessagingConnectorException - if an error occurred

internalCreateEvent

public 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

Description copied from class: AbstractMessagingConnector

Create an event

Overrides:

internalCreateEvent in class AbstractMessagingConnector

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

internalUpdateEvent

public 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

Description copied from class: AbstractMessagingConnector

Update an event

Overrides:

internalUpdateEvent in class AbstractMessagingConnector

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

internalDeleteEvent

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

Description copied from class: AbstractMessagingConnector

Delete an event

Overrides:

internalDeleteEvent in class AbstractMessagingConnector

Parameters:

eventId - the event id to delete

organiser - the event organiser

Throws:

MessagingConnectorException - if failed to get events from server

internalGetAttendees

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

Description copied from class: AbstractMessagingConnector

Get the map of attendees for an event

Overrides:

internalGetAttendees in class AbstractMessagingConnector

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

internalSetAttendees

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

Description copied from class: AbstractMessagingConnector

Set attendees for an event

Overrides:

internalSetAttendees in class AbstractMessagingConnector

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

internalGetFreeBusy

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

Description copied from class: AbstractMessagingConnector

Get free/busy status for attendees for a time window

Overrides:

internalGetFreeBusy in class AbstractMessagingConnector

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

isUserExist

public boolean isUserExist(UserIdentity userIdentity)
                    throws MessagingConnectorException

Description copied from interface: MessagingConnector

True if the user exist

Specified by:

isUserExist in interface MessagingConnector

Overrides:

isUserExist in class AbstractMessagingConnector

Parameters:

userIdentity - the user identity

Returns:

true if the user exist

Throws:

MessagingConnectorException - if failed to get events from server

html2text

protected static String html2text(String html)

Converts a given html String into a plain text String

Parameters:

html - the html String that will be converted

Returns:

a String plain text of the given html