org.ametys.plugins.messagingconnector

Interface MessagingConnector

All Superinterfaces:

Component

All Known Implementing Classes:

AbstractMessagingConnector, BluemindConnector, ExchangeConnector, ZimbraConnector

public interface MessagingConnector
extends Component

This interface describe the methods used by the different mail servers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessagingConnector.AttendeeInformation Internal class for attendee information
static class	MessagingConnector.FreeBusyStatus Enum for free/busy status
static class	MessagingConnector.ResponseType Enum for answer status

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE The avalon role

Method Summary

Modifier and Type	Method and Description
String	createEvent(String title, String description, String place, boolean isAllDay, Date startDate, Date endDate, EventRecurrenceTypeEnum recurrenceType, Date 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
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	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() Check if a user credential should be saved
void	updateEvent(String eventId, String title, String description, String place, boolean isAllDay, Date startDate, Date endDate, EventRecurrenceTypeEnum recurrenceType, Date untilDate, Map<String,Boolean> attendees, UserIdentity organiser) Update an event
boolean	userCredentialNeeded() Check if the service needs user credential (some implementation can use a central API key or impersonation, some don't)

Field Detail

ROLE

static final String ROLE

The avalon role

Method Detail

getAllowedPopulationIds

List<String> getAllowedPopulationIds()

Get the list of population id allowed to the messaging connector

Returns:

the list of population id allowed to the messaging connector

getEvents

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

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

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

int getEventsCount(UserIdentity userIdentity,
                   int maxDays)
            throws MessagingConnectorException

Return the number of upcoming events

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

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

Return the unread emails for a given user

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

int getUnreadEmailCount(UserIdentity userIdentity)
                 throws MessagingConnectorException

Return the number of unread mails for a given user

Parameters:

userIdentity - the receiver of the mails

Returns:

the number of unread mails

Throws:

MessagingConnectorException - if failed to get unread mails ' count

supportInvitation

boolean supportInvitation()
                   throws MessagingConnectorException

Tell if the messaging connector supports event invitation

Returns:

true if the messaging connector supports event invitation

Throws:

MessagingConnectorException - if failed to get events from server

isEventExist

boolean isEventExist(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

String createEvent(String title,
                   String description,
                   String place,
                   boolean isAllDay,
                   Date startDate,
                   Date endDate,
                   EventRecurrenceTypeEnum recurrenceType,
                   Date 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

void updateEvent(String eventId,
                 String title,
                 String description,
                 String place,
                 boolean isAllDay,
                 Date startDate,
                 Date endDate,
                 EventRecurrenceTypeEnum recurrenceType,
                 Date 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

void deleteEvent(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

Map<String,MessagingConnector.AttendeeInformation> getAttendees(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

void setAttendees(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

Map<String,MessagingConnector.FreeBusyStatus> getFreeBusy(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

isUserExist

boolean isUserExist(UserIdentity userIdentity)
             throws MessagingConnectorException

True if the user exist

Parameters:

userIdentity - the user identity

Returns:

true if the user exist

Throws:

MessagingConnectorException - if failed to get events from server

userCredentialNeeded

boolean userCredentialNeeded()

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

Returns:

True if the service is configured to ask for user credential

supportUserCredential

boolean supportUserCredential()

Check if a user credential should be saved

Returns:

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

setUserPassword

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

Set a new password for the user

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