org.exoplatform.moxtra.calendar

Class MoxtraCalendarService

java.lang.Object

org.exoplatform.moxtra.calendar.MoxtraCalendarService

public class MoxtraCalendarService
extends Object

Business logic of Moxtra in eXo Calendar integration.
Created by The eXo Platform SAS

Version:

$Id: MoxtraCalendarService.java 00000 Mar 2, 2015 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MoxtraCalendarService.Environment Setup environment for jobs execution in eXo Container.
protected class	MoxtraCalendarService.UserSettings

Field Summary

Fields

Modifier and Type	Field and Description
protected org.exoplatform.calendar.service.impl.CalendarServiceImpl	calendar CalendarService implementation required to access JCR data storage.
protected ThreadLocal<MoxtraCalendarApplication>	contextApp Moxtra app enabled in current context.
protected org.exoplatform.services.cms.drives.ManageDriveService	driveService
protected org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator	hierarchyCreator
protected MoxtraCalendarService.Environment	jobEnvironment
protected static org.exoplatform.services.log.Log	LOG
static String	MEET_VIDEO_DOWNLOAD_JOB_GROUP_NAME
protected org.exoplatform.commons.utils.MimeTypeResolver	mimetypeResolver
protected org.exoplatform.moxtra.MoxtraService	moxtraService
protected org.exoplatform.services.organization.OrganizationService	orgService OrganizationService to find eXo users email.
protected org.exoplatform.services.scheduler.impl.JobSchedulerServiceImpl	schedulerService
protected org.exoplatform.services.jcr.ext.app.SessionProviderService	sessionProviderService

Constructor Summary

Constructors

Constructor and Description

MoxtraCalendarService(org.exoplatform.moxtra.MoxtraService moxtra, org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviderService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator, org.exoplatform.calendar.service.impl.CalendarServiceImpl calendar, org.exoplatform.services.organization.OrganizationService orgService, org.exoplatform.services.scheduler.impl.JobSchedulerServiceImpl schedulerService, org.exoplatform.services.cms.drives.ManageDriveService driveService)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanupJobEnvironment(org.quartz.JobDetail job)
protected String	createDownloadJob(org.exoplatform.calendar.service.CalendarEvent event, org.exoplatform.moxtra.client.MoxtraMeet meet, javax.jcr.Node meetNode, Date jobTime) Schedule a local job to download a meet video.
void	deleteMeet() Delete Meet from context app.
void	deleteMeet(String calendarId, org.exoplatform.calendar.service.CalendarEvent event) Deprecated.
String	downloadMeetVideo(String userName, org.exoplatform.calendar.service.CalendarEvent event) Download meet video associated with given event and save the video to a location configured in the meet node.
org.exoplatform.calendar.service.CalendarSetting	getCalendarSetting()
List<org.exoplatform.moxtra.client.MoxtraUser>	getContacts() Current user contacts in Moxtra.
org.exoplatform.calendar.service.CalendarEvent	getEvent(String eventId)
org.exoplatform.calendar.service.CalendarEvent	getGroupEvent(String eventId)
protected org.exoplatform.moxtra.client.MoxtraUser	getHostUser(org.exoplatform.moxtra.client.MoxtraMeet meet)
org.exoplatform.moxtra.client.MoxtraMeet	getMeet(org.exoplatform.calendar.service.CalendarEvent event)
protected javax.jcr.Node	getMeetingsFolder(javax.jcr.Node parent, String name) Get, create if not found, a meetings folder in given parent node.
String	getOAuth2Link()
protected javax.jcr.Node	getSpaceDocumentsNode(String userName, String groupName) Find given group Documents folder using system session.
org.exoplatform.moxtra.client.MoxtraUser	getUser() Current user in Moxtra.
protected javax.jcr.Node	getUserDocumentsNode(String userName) Find given user Personal Documents folder using system session.
protected Calendar	getUserMoxtraCalendar() Deprecated.
protected void	initEventMeet(org.exoplatform.moxtra.client.MoxtraMeet meet, org.exoplatform.calendar.service.CalendarEvent event) Set required fields from the event to meet.
boolean	isAuthorized() Checks if current user is already authorized to access Moxtra services.
protected String	meetJobName(org.exoplatform.calendar.service.CalendarEvent event, org.exoplatform.moxtra.client.MoxtraMeet meet)
org.exoplatform.moxtra.client.MoxtraMeet	newMeet() Return EventMeet instance that can be used for meet creation.
void	prepareJobEnvironment(org.quartz.JobDetail job)
protected javax.jcr.Node	readEventNode(String userName, String calType, String calId, String eventId)
protected org.exoplatform.moxtra.client.MoxtraMeet	readMeet(javax.jcr.Node meetNode) Read meet from the node, refresh it with remote state, save refreshed meet in the node.
protected void	removeDownloadJob(org.exoplatform.calendar.service.CalendarEvent event, org.exoplatform.moxtra.client.MoxtraMeet meet)
void	saveMeet(String calendarId, org.exoplatform.calendar.service.CalendarEvent event) Confirm Meet for given Event or Task.
protected void	updateDownloadJob(org.exoplatform.calendar.service.CalendarEvent event, org.exoplatform.moxtra.client.MoxtraMeet meet)
protected void	writeMeet(javax.jcr.Node meetNode, org.exoplatform.moxtra.client.MoxtraMeet meet, List<org.exoplatform.moxtra.client.MoxtraUser> users) Write meet's data to the node.

Methods inherited from class java.lang.Object

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

Field Detail

MEET_VIDEO_DOWNLOAD_JOB_GROUP_NAME

public static final String MEET_VIDEO_DOWNLOAD_JOB_GROUP_NAME

See Also:

Constant Field Values

LOG

protected static final org.exoplatform.services.log.Log LOG

contextApp

protected final ThreadLocal<MoxtraCalendarApplication> contextApp

Moxtra app enabled in current context.

mimetypeResolver

protected final org.exoplatform.commons.utils.MimeTypeResolver mimetypeResolver

jobEnvironment

protected final MoxtraCalendarService.Environment jobEnvironment

moxtraService

protected final org.exoplatform.moxtra.MoxtraService moxtraService

calendar

protected final org.exoplatform.calendar.service.impl.CalendarServiceImpl calendar

CalendarService implementation required to access JCR data storage.

orgService

protected final org.exoplatform.services.organization.OrganizationService orgService

OrganizationService to find eXo users email.

schedulerService

protected final org.exoplatform.services.scheduler.impl.JobSchedulerServiceImpl schedulerService

hierarchyCreator

protected final org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator

sessionProviderService

protected final org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviderService

driveService

protected final org.exoplatform.services.cms.drives.ManageDriveService driveService

Constructor Detail

MoxtraCalendarService

public MoxtraCalendarService(org.exoplatform.moxtra.MoxtraService moxtra,
                     org.exoplatform.services.jcr.ext.app.SessionProviderService sessionProviderService,
                     org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator hierarchyCreator,
                     org.exoplatform.calendar.service.impl.CalendarServiceImpl calendar,
                     org.exoplatform.services.organization.OrganizationService orgService,
                     org.exoplatform.services.scheduler.impl.JobSchedulerServiceImpl schedulerService,
                     org.exoplatform.services.cms.drives.ManageDriveService driveService)

Throws:

org.exoplatform.moxtra.client.MoxtraConfigurationException

Method Detail

getOAuth2Link

public String getOAuth2Link()
                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

getEvent

public org.exoplatform.calendar.service.CalendarEvent getEvent(String eventId)
                                                        throws Exception

Throws:

Exception

getGroupEvent

public org.exoplatform.calendar.service.CalendarEvent getGroupEvent(String eventId)
                                                             throws Exception

Throws:

Exception

getCalendarSetting

public org.exoplatform.calendar.service.CalendarSetting getCalendarSetting()
                                                                    throws Exception

Throws:

Exception

getMeet

public org.exoplatform.moxtra.client.MoxtraMeet getMeet(org.exoplatform.calendar.service.CalendarEvent event)
                                                 throws MoxtraCalendarException

Throws:

MoxtraCalendarException

newMeet

public org.exoplatform.moxtra.client.MoxtraMeet newMeet()

Return EventMeet instance that can be used for meet creation. This method doesn't create or schedule a meet in Moxtra. Returned instance is an editor of the meet.

Returns:

EventMeet

saveMeet

public void saveMeet(String calendarId,
            org.exoplatform.calendar.service.CalendarEvent event)

Confirm Meet for given Event or Task.

Throws:

MoxtraCalendarException

deleteMeet

@Deprecated
public void deleteMeet(String calendarId,
                         org.exoplatform.calendar.service.CalendarEvent event)

Deprecated.

Delete Meet for given Event or Task. This method doesn't use context app and its meet, instead it assumes that given event exists and meet object can be read from it. In any case context app will be reset on the end.

Parameters:

calendarId -

event -

deleteMeet

public void deleteMeet()

Delete Meet from context app. An app should be initialized for some WebUI component, otherwise this method will delete nothing. An app will be reset on the end.
This method designed for use after event deletion when its node cannot be found to read a meet.

downloadMeetVideo

public String downloadMeetVideo(String userName,
                       org.exoplatform.calendar.service.CalendarEvent event)
                         throws MoxtraCalendarException

Download meet video associated with given event and save the video to a location configured in the meet node. This method should be called by a meet owner (host user) only.

Parameters:

userName - String event/meet owner in eXo

event - CalendarEvent event with enabled meet

Throws:

MoxtraCalendarException

getContacts

public List<org.exoplatform.moxtra.client.MoxtraUser> getContacts()
                                                           throws MoxtraCalendarException,
                                                                  org.exoplatform.moxtra.client.MoxtraAuthenticationException,
                                                                  org.exoplatform.moxtra.MoxtraException

Current user contacts in Moxtra.

Returns:

Collection of MoxtraUser.

Throws:

MoxtraCalendarException - if no current app activated

org.exoplatform.moxtra.MoxtraException

org.exoplatform.moxtra.client.MoxtraAuthenticationException

isAuthorized

public boolean isAuthorized()

Checks if current user is already authorized to access Moxtra services.

Returns:

true if user is authorized to access Moxtra services, false otherwise

getUser

public org.exoplatform.moxtra.client.MoxtraUser getUser()
                                                 throws org.exoplatform.moxtra.MoxtraException

Current user in Moxtra.

Returns:

MoxtraUser.

Throws:

org.exoplatform.moxtra.MoxtraException

prepareJobEnvironment

public void prepareJobEnvironment(org.quartz.JobDetail job)
                           throws MoxtraCalendarException

Throws:

MoxtraCalendarException

cleanupJobEnvironment

public void cleanupJobEnvironment(org.quartz.JobDetail job)
                           throws MoxtraCalendarException

Throws:

MoxtraCalendarException

readEventNode

protected javax.jcr.Node readEventNode(String userName,
                           String calType,
                           String calId,
                           String eventId)
                                throws MoxtraCalendarException

Throws:

MoxtraCalendarException

initEventMeet

protected void initEventMeet(org.exoplatform.moxtra.client.MoxtraMeet meet,
                 org.exoplatform.calendar.service.CalendarEvent event)
                      throws Exception

Set required fields from the event to meet.

Parameters:

meet -

event -

Throws:

Exception

writeMeet

protected void writeMeet(javax.jcr.Node meetNode,
             org.exoplatform.moxtra.client.MoxtraMeet meet,
             List<org.exoplatform.moxtra.client.MoxtraUser> users)
                  throws javax.jcr.RepositoryException

Write meet's data to the node. Node will not be saved.

Parameters:

meetNode - Node

meet - MoxtraMeet meet object to save, should be an editor instance

users - actual users for a new meet (as in remote meet on Moxtra)

Throws:

javax.jcr.RepositoryException

readMeet

protected org.exoplatform.moxtra.client.MoxtraMeet readMeet(javax.jcr.Node meetNode)
                                                     throws javax.jcr.RepositoryException,
                                                            org.exoplatform.moxtra.client.MoxtraClientException,
                                                            org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                            org.exoplatform.moxtra.MoxtraException

Read meet from the node, refresh it with remote state, save refreshed meet in the node.

Parameters:

meetNode -

Throws:

javax.jcr.RepositoryException

org.exoplatform.moxtra.MoxtraException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.exoplatform.moxtra.client.MoxtraClientException

createDownloadJob

protected String createDownloadJob(org.exoplatform.calendar.service.CalendarEvent event,
                       org.exoplatform.moxtra.client.MoxtraMeet meet,
                       javax.jcr.Node meetNode,
                       Date jobTime)
                            throws Exception

Schedule a local job to download a meet video.

Throws:

Exception

updateDownloadJob

protected void updateDownloadJob(org.exoplatform.calendar.service.CalendarEvent event,
                     org.exoplatform.moxtra.client.MoxtraMeet meet)
                          throws Exception

Throws:

Exception

removeDownloadJob

protected void removeDownloadJob(org.exoplatform.calendar.service.CalendarEvent event,
                     org.exoplatform.moxtra.client.MoxtraMeet meet)
                          throws Exception

Throws:

Exception

meetJobName

protected String meetJobName(org.exoplatform.calendar.service.CalendarEvent event,
                 org.exoplatform.moxtra.client.MoxtraMeet meet)

getUserDocumentsNode

protected javax.jcr.Node getUserDocumentsNode(String userName)
                                       throws Exception

Find given user Personal Documents folder using system session.

Parameters:

userName - String

Returns:

Node Personal Documents folder node or null

Throws:

Exception

getSpaceDocumentsNode

protected javax.jcr.Node getSpaceDocumentsNode(String userName,
                                   String groupName)
                                        throws Exception

Find given group Documents folder using system session.

Parameters:

groupName - String

Returns:

Node space's Documents folder node or null

Throws:

Exception

getMeetingsFolder

protected javax.jcr.Node getMeetingsFolder(javax.jcr.Node parent,
                               String name)
                                    throws javax.jcr.RepositoryException

Get, create if not found, a meetings folder in given parent node.

Parameters:

parent - Node

name - String

Returns:

Node

Throws:

javax.jcr.RepositoryException

getUserMoxtraCalendar

@Deprecated
protected Calendar getUserMoxtraCalendar()
                                  throws Exception

Deprecated.

TODO NOT USED. Java Calendar instance with Moxtra timezone and other user settings from eXo Calendar.

Returns:

Calendar

Throws:

Exception

getHostUser

protected org.exoplatform.moxtra.client.MoxtraUser getHostUser(org.exoplatform.moxtra.client.MoxtraMeet meet)