JCRDataStorage (eXo PLF:: Calendar Service 5.0.3 API)

java.lang.Object
- org.exoplatform.calendar.service.impl.JCRDataStorage

All Implemented Interfaces:

DataStorage
```
public class JCRDataStorage
extends Object
implements DataStorage
```
Created by The eXo Platform SARL Author : Hung Nguyen Quang hung.nguyen@exoplatform.com Jul 10, 2007

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JCRDataStorage.KeyValuePair

Nested Classes
Modifier and Type	Class and Description
`static class`	`JCRDataStorage.KeyValuePair`

Field Summary
- Fields inherited from interface org.exoplatform.calendar.service.DataStorage
  USERS_PATH

Constructor Summary

Constructors
Constructor and Description
`JCRDataStorage(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.services.jcr.RepositoryService repoService, org.exoplatform.services.cache.CacheService cservice)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttachment(javax.jcr.Node eventNode, Attachment attachment, boolean isNew)` Add an attachment to event
`void`	`addCalendarSetting(javax.jcr.Node calendarHome, CalendarSetting setting)`
`void`	`addEvent(CalendarEvent event)` creates a virtual event for a new event in a public folder of storage this virtual event is search-able (by XPATH query) and used to find the free/busy time in Schedule tab
`void`	`addReminder(javax.jcr.Node eventNode, javax.jcr.Node reminderFolder, Reminder reminder)` Add a reminder to event
`void`	`assignGroupTask(String taskId, String calendarId, String assignee)`
`void`	`autoRemoveShareCalendar(String groupId, String username)`
`void`	`autoShareCalendar(List<String> groupsOfUser, String receiver)`
`Collection<CalendarEvent>`	`buildSeriesByTime(CalendarEvent recurEvent, Calendar from, Calendar to, String userId)`
`Date`	`calculateRecurrenceFinishDate(CalendarEvent originalEvent)` Calculate the end-date of recurrence event
`boolean`	`canEdit(javax.jcr.Node calNode, String username)` Get the permission to edit of user on the calendar
`Map<String,String>`	`checkFreeBusy(EventQuery eventQuery)`
`Map<String,String>`	`checkFreeBusy(EventQuery eventQuery, Date date)`
`void`	`closeSessionProvider(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)` Safely closes JCR session provider.
`void`	`confirmInvitation(String fromUserId, String toUserId, int calType, String calendarId, String eventId, int answer)`
`void`	`confirmInvitation(String fromUserId, String confirmingEmail, String confirmingUser, int calType, String calendarId, String eventId, int answer)`
`Calendar`	`createRemoteCalendar(RemoteCalendar remoteCalendar)` Create a new eXo calendar with mixin type 'exo:remoteCalendar' to store data from remote calendar, this method also creates a 'Remote' category
`org.exoplatform.services.jcr.ext.common.SessionProvider`	`createSessionProvider()` Create a session provider for current context.
`org.exoplatform.services.jcr.ext.common.SessionProvider`	`createSystemProvider()`
`org.exoplatform.services.jcr.ext.common.SessionProvider`	`createUserProvider()`
`int`	`generateRss(String username, LinkedHashMap<String,Calendar> calendars, RssData rssData, CalendarImportExport importExport)`
`int`	`generateRss(String username, List<String> calendarIds, RssData rssData, CalendarImportExport importExport)`
`Collection<CalendarEvent>`	`getAllExcludedEvent(CalendarEvent originEvent, Calendar from, Calendar to, String userId)`
`List<CalendarEvent>`	`getAllNoRepeatEvents(String username, EventQuery eventQuery, String[] publicCalendarIds)` Deprecated.
`List<CalendarEvent>`	`getAllNoRepeatEventsSQL(String username, EventQuery eventQuery, String[] privateCalendars, String[] publicCalendars, List<String> emptyCalendars)`
`Calendar`	`getCalendar(String[] defaultFilterCalendars, String username, javax.jcr.Node calNode, boolean isShowAll)`
`Calendar`	`getCalendarById(String calId)`
`javax.jcr.Node`	`getCalendarEventNode(String username, String calType, String calendarId, String eventId)`
`CalendarSetting`	`getCalendarSetting(String username)` Get calendar settings of a user
`javax.jcr.Node`	`getDateFolder(javax.jcr.Node publicApp, Date date)`
`String`	`getEntryUrl(String portalName, String wsName, String username, String path, String baseUrl)`
`CalendarEvent`	`getEvent(javax.jcr.Node eventNode)` Get a event from event node
`CalendarEvent`	`getEvent(String username, String eventId)` Get a user event
`CalendarEvent`	`getEventById(String eventId)`
`List<EventCategory>`	`getEventCategories(String username)` === Event Category APIs ===
`EventCategory`	`getEventCategory(javax.jcr.Node eventCatNode)` Get a event category from node
`EventCategory`	`getEventCategory(String username, String eventcategoryId)` Get event category from name
`protected javax.jcr.Node`	`getEventCategoryHome(String username)`
`javax.jcr.Node`	`getEventFolder(Date fromDate)`
`List<CalendarEvent>`	`getEvents(String username, EventQuery eventQuery, String[] publicCalendarIds)`
`List<CalendarEvent>`	`getExceptionEvents(String username, CalendarEvent recurEvent)` Get all exception occurrence from original recurrence event
`List<FeedData>`	`getFeeds(String username)`
`Calendar`	`getGroupCalendar(String calendarId)` Get a group calendar
`List<GroupCalendarData>`	`getGroupCalendars(String[] groupIds, boolean isShowAll, String username)`
`CalendarEvent`	`getGroupEvent(String eventId)` Get a group event with given eventId
`CalendarEvent`	`getGroupEvent(String calendarId, String eventId)` Get a group event
`List<CalendarEvent>`	`getGroupEventByCalendar(List<String> calendarIds)` Get all group events from list of calendars
`List<CalendarEvent>`	`getHighLightOriginalRecurrenceEvents(String username, Calendar from, Calendar to, String[] publicCalendarIds)` Another version of getOriginalRecurrenceEvents using Thread
`List<CalendarEvent>`	`getHighLightOriginalRecurrenceEventsSQL(String username, Calendar from, Calendar to, EventQuery eventQuery, String[] privateCalendars, String[] publicCalendars, List<String> emptyCalendars)` Another version of getOriginalRecurrenceEvents
`javax.jcr.Node`	`getNodeByPath(String nodePath, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)`
`org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator`	`getNodeHierarchyCreator()`
`Map<String,CalendarEvent>`	`getOccurrenceEvents(CalendarEvent recurEvent, Calendar from, Calendar to, String timezone)` Query all occurrences of recurrence event between from and to date.
`List<CalendarEvent>`	`getOriginalRecurrenceEvents(javax.jcr.Node calendar, String calType, Calendar from, Calendar to, String[] calendarIds, String[] filterCalendarIds)`
`List<CalendarEvent>`	`getOriginalRecurrenceEvents(String username, Calendar from, Calendar to, String[] publicCalendarIds)` Get all active 'original' recurrence event The result list includes all 'original' recurrence event in all three types: private, public and shared
`List<CalendarEvent>`	`getOriginalRecurrenceEvents1(javax.jcr.Node calendar, String calType, Calendar from, Calendar to, String[] calendarIds, String[] filterCalendarIds)` A faster version getOriginalRecurrenceEvents with improved JCR queries
`List<CalendarEvent>`	`getOriginalRecurrenceEventsSQL(javax.jcr.Node calendar, String calType, Calendar from, Calendar to, EventQuery eventQuery, String[] calendarIds, List<String> emptyCalendars)` Another version for getOriginalRecurrenceEvents1 using SQL with different queries
`javax.jcr.Node`	`getPublicCalendarHome()` Get the home node of all public calendars under public Calendar storage
`javax.jcr.Node`	`getPublicCalendarServiceHome()` Get the public Calendar application storage
`List<CalendarEvent>`	`getPublicEventByCategory(String username, String eventCategoryId)` Get all user public events from a category
`List<CalendarEvent>`	`getPublicEvents(EventQuery eventQuery)` Get all public events from a event query
`javax.jcr.Node`	`getPublicRoot()`
`javax.jcr.Node`	`getReminderFolder(Date fromDate)`
`javax.jcr.Node`	`getReminderFolder(Date fromDate, boolean create)`
`RemoteCalendar`	`getRemoteCalendar(String username, String remoteCalendarId)`
`Calendar`	`getRemoteCalendar(String username, String remoteUrl, String remoteType)`
`int`	`getRemoteCalendarCount(String username)`
`javax.jcr.Node`	`getRssHome(String username)` Get the home node of user feeds in Calendar application
`javax.jcr.Session`	`getSession(org.exoplatform.services.jcr.ext.common.SessionProvider sprovider)`
`javax.jcr.Node`	`getSharedCalendarHome()` Get the shared Calendar application storage
`GroupCalendarData`	`getSharedCalendars(String username, boolean isShowAll)` Get all shared calendars of a user
`CalendarEvent`	`getSharedEvent(String username, String calendarId, String eventId)`
`List<CalendarEvent>`	`getSharedEventByCalendars(String username, List<String> calendarIds)` Get all shared events from list of calendars
`List<CalendarEvent>`	`getSharedEventByCategory(String username, String eventCategoryId)` Get all user shared events from a category
`List<CalendarEvent>`	`getSharedEvents(String username, EventQuery eventQuery)` Get all shared events with a EventQuery
`javax.jcr.Session`	`getSystemSession()`
`int`	`getTypeOfCalendar(String userName, String calendarId)`
`int`	`getTypeOfCalendarFromStore(String calendarId, String userName)`
`Calendar`	`getUserCalendar(String username, String calendarId)` Get a calendar under user calendar data storage
`javax.jcr.Node`	`getUserCalendarHome(String username)` Get the home node of user calendars under user calendar data storage
`List<Calendar>`	`getUserCalendars(String username, boolean isShowAll)` Get all calendars of a user
`javax.jcr.Node`	`getUserCalendarServiceHome(String username)` Get the Calendar application user data storage root
`CalendarEvent`	`getUserEvent(String username, String calendarId, String eventId)` Get a user event from calendarId and eventId
`List<CalendarEvent>`	`getUserEventByCalendar(String username, List<String> calendarIds)` Get all user events from a calendar
`List<CalendarEvent>`	`getUserEventByCategory(String username, String eventCategoryId)` Get all user events from a category
`List<CalendarEvent>`	`getUserEvents(String username, EventQuery eventQuery)` Get all user event with a event query
`boolean`	`isRemoteCalendar(String username, String calendarId)` Check if a calendar is a remote calendar by checking mixin type of calendar node
`Calendar`	`loadCalendar(javax.jcr.Node calNode)`
`void`	`moveEvent(String formCalendar, String toCalendar, String fromType, String toType, List<CalendarEvent> calEvents, String username)` Move events between calendars
`void`	`removeAttachmentById(String attId)`
`void`	`removeEventCategory(String username, String eventCategoryId)` Remove a user event category
`void`	`removeFeed(String username, String calendarId)`
`void`	`removeFeedData(String username, String title)`
`Calendar`	`removeGroupCalendar(String calendarId)` Remove a group calendar
`void`	`removeOccurrenceInstance(String username, CalendarEvent occurrence)`
`CalendarEvent`	`removePublicEvent(String calendarId, String eventId)` Remove a public event
`void`	`removeRecurrenceSeries(String username, CalendarEvent originalEvent)`
`void`	`removeReminder(javax.jcr.Node eventNode)` Remove reminder from event
`void`	`removeSharedCalendar(String username, String calendarId)` Remove a shared calendar
`void`	`removeSharedCalendarFolder(String username)`
`void`	`removeSharedEvent(String username, String calendarId, String eventId)`
`Calendar`	`removeUserCalendar(String username, String calendarId)` Remove a user calendar
`CalendarEvent`	`removeUserEvent(String username, String calendarId, String eventId)` Remove a user event
`void`	`saveCalendarSetting(String username, CalendarSetting setting)` Save calendar setting of a user to JCR
`void`	`saveEvent(javax.jcr.Node calendarNode, CalendarEvent event, javax.jcr.Node reminderFolder, boolean isNew)` Save a event
`void`	`saveEventCategory(String username, EventCategory eventCategory, boolean isNew)` Save a user event category to JCR
`void`	`saveEventCategory(String username, EventCategory eventCategory, String[] values, boolean isNew)`
`void`	`saveEventToSharedCalendar(String username, String calendarId, CalendarEvent event, boolean isNew)` Save a event to a shared calendar
`void`	`saveOccurrenceEvent(javax.jcr.Node calendarNode, CalendarEvent event, javax.jcr.Node reminderFolder, boolean isNew)`
`void`	`saveOccurrenceEvent(String username, String calendarId, CalendarEvent event, boolean isNew)` Save a occurrence event
`void`	`savePublicCalendar(Calendar calendar, boolean isNew, String username)` Save a public calendar
`void`	`savePublicEvent(String calendarId, CalendarEvent event, boolean isNew)` Save a public event
`void`	`saveSharedCalendar(String username, Calendar calendar)` Save a shared calendar to JCR
`void`	`saveUserCalendar(String username, Calendar calendar, boolean isNew)` Save a user calendar
`void`	`saveUserEvent(String username, String calendarId, CalendarEvent event, boolean isNew)` Save a user event
`EventPageList`	`searchEvent(String username, EventQuery eventQuery, String[] publicCalendarIds)`
`List<CalendarEvent>`	`searchHighLightOriginalRecurrenceEventsSQL(String username, Calendar from, Calendar to, EventQuery eventQuery, String[] privateCalendars, String[] publicCalendars)`
`Map<Integer,String>`	`searchHighlightRecurrenceEvent(String username, EventQuery eventQuery, String[] publicCalendarIds, String timezone)`
`List<Map<Integer,String>>`	`searchHighlightRecurrenceEventSQL(String username, EventQuery eventQuery, String timezone, String[] privateCalendars, String[] publicCalendars)`
`Map<Integer,String>`	`searchHightLightEvent(String username, EventQuery eventQuery, String[] publicCalendarIds)` Deprecated.
`List<Map<Integer,String>>`	`searchHightLightEventSQL(String username, EventQuery eventQuery, String[] privateCalendars, String[] publicCalendars)`
`List<CalendarEvent>`	`searchOriginalRecurrenceEventsSQL(javax.jcr.Node calendar, String calType, Calendar from, Calendar to, String[] calendarIds, List<String> emptyCalendars)`
`void`	`setCalDavResourceEtag(String username, String calendarId, String eventId, String etag)`
`void`	`setCalDavResourceHref(String username, String calendarId, String eventId, String href)`
`void`	`setGroupTaskStatus(String taskId, String calendarId, String status)`
`void`	`setRemoteCalendarLastUpdated(String username, String calendarId, Calendar timeGMT)`
`void`	`setRemoteEvent(String username, String calendarId, String eventId, String href, String etag)`
`void`	`shareCalendar(String username, String calendarId, List<String> receiverUsers)` Shared a calendar to list of users
`void`	`storeXML(String feedXML, javax.jcr.Node rssHome, RssData rssData)`
`void`	`syncRemoveEvent(javax.jcr.Node eventFolder, String rootEventId)`
`void`	`updateOccurrenceEvent(String fromCalendar, String toCalendar, String fromCalendarType, String toCalendarType, List<CalendarEvent> events, String username)` This function is used to update a occurrence event.
`void`	`updateRecurrenceSeries(String fromCalendar, String toCalendar, String fromType, String toType, CalendarEvent occurrence, String username)` Update recurrence series
`Calendar`	`updateRemoteCalendarInfo(RemoteCalendar remoteCalendar)` Update information about remote calendar

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JCRDataStorage

public JCRDataStorage(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                      org.exoplatform.services.jcr.RepositoryService repoService,
                      org.exoplatform.services.cache.CacheService cservice)
               throws Exception

Throws:: Exception

Method Detail

getPublicCalendarServiceHome
```
public javax.jcr.Node getPublicCalendarServiceHome()
                                            throws Exception
```
Get the public Calendar application storage

Specified by:

getPublicCalendarServiceHome in interface DataStorage

Returns:

the node that is on top of Calendar application public storage

Throws:

Exception

getSharedCalendarHome
```
public javax.jcr.Node getSharedCalendarHome()
                                     throws Exception
```
Get the shared Calendar application storage

Specified by:

getSharedCalendarHome in interface DataStorage

Returns:

the node that is on top of Calendar application shared storage

Throws:

Exception

getPublicRoot

public javax.jcr.Node getPublicRoot()
                             throws Exception

Specified by:: getPublicRoot in interface DataStorage
Returns:
Throws:: Exception

getUserCalendarServiceHome
```
public javax.jcr.Node getUserCalendarServiceHome(String username)
                                          throws Exception
```
Get the Calendar application user data storage root

Specified by:

getUserCalendarServiceHome in interface DataStorage

Returns:

Node object represents the node that is on top of user data storage

Throws:

Exception

getPublicCalendarHome
```
public javax.jcr.Node getPublicCalendarHome()
                                     throws Exception
```
Get the home node of all public calendars under public Calendar storage

Specified by:

getPublicCalendarHome in interface DataStorage

Returns:

Node object represents the home node of all public calendars

Throws:

Exception

getUserCalendarHome
```
public javax.jcr.Node getUserCalendarHome(String username)
                                   throws Exception
```
Get the home node of user calendars under user calendar data storage

Specified by:

getUserCalendarHome in interface DataStorage

Returns:

Node object represents home node of user calendars

Throws:

Exception

getRssHome
```
public javax.jcr.Node getRssHome(String username)
                          throws Exception
```
Get the home node of user feeds in Calendar application

Specified by:

getRssHome in interface DataStorage

Returns:

Node object represents the home node of user feeds

Throws:

Exception

getEventCategoryHome

protected javax.jcr.Node getEventCategoryHome(String username)
                                       throws Exception

Parameters:: username -
Returns:
Throws:: Exception

getUserCalendar

public Calendar getUserCalendar(String username,
                                String calendarId)
                         throws Exception

Get a calendar under user calendar data storage

Specified by:: getUserCalendar in interface DataStorage
Returns:: the Calendar object represents user calendar
Throws:: Exception

getUserCalendars

public List<Calendar> getUserCalendars(String username,
                                       boolean isShowAll)
                                throws Exception

Get all calendars of a user

Specified by:: getUserCalendars in interface DataStorage
Returns:: the list of all calendars of user
Throws:: Exception

saveUserCalendar

public void saveUserCalendar(String username,
                             Calendar calendar,
                             boolean isNew)
                      throws Exception

Save a user calendar

Specified by:: saveUserCalendar in interface DataStorage
Throws:: Exception

removeUserCalendar

public Calendar removeUserCalendar(String username,
                                   String calendarId)
                            throws Exception

Remove a user calendar

Specified by:: removeUserCalendar in interface DataStorage
Returns:: the Calendar which is removed
Throws:: Exception

getGroupCalendar
```
public Calendar getGroupCalendar(String calendarId)
                          throws Exception
```
Get a group calendar

Specified by:

getGroupCalendar in interface DataStorage

Returns:

the group calendar

Throws:

Exception

getGroupCalendars

public List<GroupCalendarData> getGroupCalendars(String[] groupIds,
                                                 boolean isShowAll,
                                                 String username)
                                          throws Exception

Specified by:: getGroupCalendars in interface DataStorage
Returns:: the list of GroupCalendarData objects
Throws:: Exception

savePublicCalendar

public void savePublicCalendar(Calendar calendar,
                               boolean isNew,
                               String username)
                        throws Exception

Save a public calendar

Specified by:: savePublicCalendar in interface DataStorage
Throws:: Exception

removeGroupCalendar
```
public Calendar removeGroupCalendar(String calendarId)
                             throws Exception
```
Remove a group calendar

Specified by:

removeGroupCalendar in interface DataStorage

Returns:

Throws:

Exception

getCalendar

public Calendar getCalendar(String[] defaultFilterCalendars,
                            String username,
                            javax.jcr.Node calNode,
                            boolean isShowAll)
                     throws Exception

Specified by:: getCalendar in interface DataStorage
Returns:: Calendar object
Throws:: Exception

loadCalendar

public Calendar loadCalendar(javax.jcr.Node calNode)
                      throws Exception

Throws:: Exception

getEventCategories
```
public List<EventCategory> getEventCategories(String username)
                                       throws Exception
```
=== Event Category APIs ===

Specified by:

getEventCategories in interface DataStorage

Returns:

the list of EventCategory objects

Throws:

Exception

saveEventCategory

public void saveEventCategory(String username,
                              EventCategory eventCategory,
                              String[] values,
                              boolean isNew)
                       throws Exception

Throws:: Exception