org.jasig.schedassist.impl.caldav
Class CaldavCalendarDataDaoImpl

java.lang.Object
  org.jasig.schedassist.impl.caldav.CaldavCalendarDataDaoImpl

All Implemented Interfaces:

ICalendarDataDao, org.springframework.beans.factory.InitializingBean

@Service(value="caldavCalendarDataDao")
public class CaldavCalendarDataDaoImpl
extends Object
implements ICalendarDataDao, org.springframework.beans.factory.InitializingBean

Implementation of ICalendarDataDao for CalDAV-capable calendar servers. Requires the following be provided (via setter injection):

• HttpClient instance.
• HttpCredentialsProvider for authentication.
• CaldavDialect instance.
• A String containing the value of the caldav.cancelUpdatesVisitorCalendar property (false by default).

The cancelUpdatesVisitorCalendar property can be useful for CalDAV servers that do not delete appointments in an attendee's calendar when the organizer deletes the event. Oracle Communications Suite Calendar server for example will not delete the event from the visitor's calendar when the event is removed from the owner's calendar; the event remains with it's STATUS property set to CANCELLED. Setting the caldav.cancelUpdatesVisitorCalendar property to true will add behavior to cancelAppointment(IScheduleVisitor, IScheduleOwner, VEvent) and leaveAppointment(IScheduleVisitor, IScheduleOwner, VEvent) remove the CANCELLED entries from the visitor's calendar. This instance constructs a DefaultCaldavEventUtilsImpl instance with a NullAffiliationSourceImpl; if you need to override the IEventUtils instance, a setter is provided (setEventUtils(IEventUtils)). Lastly this instance constructs a NoopHttpMethodInterceptorImpl instance; if you need to override the HttpMethodInterceptor a setter is provided (setMethodInterceptor(HttpMethodInterceptor)).

Version:

$Id: CaldavCalendarDataDaoImpl.java 50 2011-05-05 21:07:25Z nblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

CaldavCalendarDataDaoImpl()

Method Summary

void	afterPropertiesSet()
void	cancelAppointment(IScheduleVisitor visitor, IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent appointment)
void	checkForConflicts(IScheduleOwner owner, AvailableBlock block)
protected net.fortuna.ical4j.model.Calendar	consolidate(List<CalendarWithURI> calendars) Consolidate the Calendars within the argument, returning 1.
protected org.apache.http.protocol.HttpContext	constructHttpContext(ICalendarAccount calendarAccount) Construct an HttpContext with a CredentialsProvider appropriate for the ICalendarAccount argument.
net.fortuna.ical4j.model.component.VEvent	createAppointment(IScheduleVisitor visitor, IScheduleOwner owner, AvailableBlock block, String eventDescription)
protected int	deleteCalendar(CalendarWithURI calendarWithURI, ICalendarAccount calendarAccount)
protected String	generateEventUri(ICalendarAccount owner, String eventUid)
protected String	generateEventUri(ICalendarAccount owner, net.fortuna.ical4j.model.component.VEvent event) This method is intended to generate a unique URI to use with the PUT method in createAppointment(IScheduleVisitor, IScheduleOwner, AvailableBlock, String).
org.apache.http.auth.AuthScope	getCaldavAdminAuthScope()
CaldavDialect	getCaldavDialect()
net.fortuna.ical4j.model.Calendar	getCalendar(ICalendarAccount calendarAccount, Date startDate, Date endDate)
protected List<CalendarWithURI>	getCalendarsInternal(ICalendarAccount calendarAccount, Date startDate, Date endDate)
CredentialsProviderFactory	getCredentialsProviderFactory()
IEventUtils	getEventUtils()
net.fortuna.ical4j.model.component.VEvent	getExistingAppointment(IScheduleOwner owner, AvailableBlock block)
protected CalendarWithURI	getExistingAppointmentInternal(IScheduleOwner owner, Date startTime, Date endTime) This method returns the CalendarWithURI containing a single VEvent that was created with the Scheduling Assistant with the specified IScheduleOwner as the owner and the specified start and end times.
protected CalendarWithURI	getExistingAppointmentInternalForVisitor(IScheduleVisitor visitor, Date startTime, Date endTime, net.fortuna.ical4j.model.property.Uid eventUid) Special method used when cancelUpdatesVisitorCalendar is set to true.
org.apache.http.client.HttpClient	getHttpClient()
org.apache.http.HttpHost	getHttpHost()
HttpMethodInterceptor	getMethodInterceptor()
protected org.apache.http.auth.AuthScheme	identifyScheme(String scheme)
boolean	isCancelUpdatesVisitorCalendar()
boolean	isGetCalendarPerformsPurgeDeclinedAttendees()
boolean	isPreemptiveAuthenticationEnabled()
boolean	isReflectionEnabled()
net.fortuna.ical4j.model.component.VEvent	joinAppointment(IScheduleVisitor visitor, IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent appointment)
net.fortuna.ical4j.model.component.VEvent	leaveAppointment(IScheduleVisitor visitor, IScheduleOwner owner, net.fortuna.ical4j.model.component.VEvent appointment)
protected net.fortuna.ical4j.model.Calendar	merge(net.fortuna.ical4j.model.Calendar left, net.fortuna.ical4j.model.Calendar right) Merge the components from all calendars into one result.
protected void	merge(net.fortuna.ical4j.model.Calendar target, net.fortuna.ical4j.model.Calendar left, net.fortuna.ical4j.model.Calendar right) Mutative method.
List<CalendarWithURI>	peekAtAvailableScheduleReflections(IScheduleOwner owner, Date startDate, Date endDate)
void	purgeAvailableScheduleReflections(IScheduleOwner owner, Date startDate, Date endDate)
protected CalendarWithURI	purgeDeclinedAttendees(CalendarWithURI calendarWithURI, ICalendarAccount owner) This method will inspect IScheduleVisitor Attendees among the SchedulingAssistantAppointments in the Calendar argument.
protected int	putExistingEvent(ICalendarAccount eventOwner, net.fortuna.ical4j.model.component.VEvent event, String etag) Update an existing event using CalDAV PUT.
protected int	putNewCalendar(ICalendarAccount eventOwner, net.fortuna.ical4j.model.Calendar calendar, String eventUid) Store a new calendar using CalDAV PUT.
protected int	putNewEvent(ICalendarAccount eventOwner, net.fortuna.ical4j.model.component.VEvent event) Store a new event using CalDAV PUT.
void	reflectAvailableSchedule(IScheduleOwner owner, AvailableSchedule schedule)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setCaldavAdminAuthScope(org.apache.http.auth.AuthScope caldavAdminAuthScope)
void	setCaldavDialect(CaldavDialect caldavDialect)
void	setCancelUpdatesVisitorCalendar(boolean cancelUpdatesVisitorCalendar)
void	setCancelUpdatesVisitorCalendar(String cancelUpdatesVisitorCalendar)
void	setCredentialsProviderFactory(CredentialsProviderFactory credentialsProviderFactory)
void	setEventUtils(IEventUtils eventUtils)
void	setGetCalendarPerformsPurgeDeclinedAttendees(boolean getCalendarPerformsPurgeDeclinedAttendees)
void	setHttpClient(org.apache.http.client.HttpClient httpClient)
void	setHttpHost(org.apache.http.HttpHost httpHost)
void	setMethodInterceptor(HttpMethodInterceptor methodInterceptor)
void	setPreemptiveAuthenticationEnabled(boolean preemptiveAuthenticationEnabled)
void	setReflectionEnabled(boolean reflectionEnabled)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

CaldavCalendarDataDaoImpl

public CaldavCalendarDataDaoImpl()

Method Detail

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient httpClient)

Parameters:

httpClient - the httpClient to set

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Returns:

the httpClient

getCredentialsProviderFactory

public CredentialsProviderFactory getCredentialsProviderFactory()

Returns:

the credentialsProviderFactory

setCredentialsProviderFactory

public void setCredentialsProviderFactory(CredentialsProviderFactory credentialsProviderFactory)

Parameters:

credentialsProviderFactory - the credentialsProviderFactory to set

getHttpHost

public org.apache.http.HttpHost getHttpHost()

Returns:

setHttpHost

public void setHttpHost(org.apache.http.HttpHost httpHost)

Parameters:

httpHost -

setCaldavAdminAuthScope

public void setCaldavAdminAuthScope(org.apache.http.auth.AuthScope caldavAdminAuthScope)

Parameters:

caldavAdminAuthScope - the caldavAdminAuthScope to set

getCaldavAdminAuthScope

public org.apache.http.auth.AuthScope getCaldavAdminAuthScope()

Returns:

the caldavAdminAuthScope

setEventUtils

public void setEventUtils(IEventUtils eventUtils)

Parameters:

eventUtils - the eventUtils to set

setCaldavDialect

public void setCaldavDialect(CaldavDialect caldavDialect)

Parameters:

caldavDialect - the caldavDialect to set

setMethodInterceptor

public void setMethodInterceptor(HttpMethodInterceptor methodInterceptor)

Parameters:

methodInterceptor - the methodInterceptor to set

getMethodInterceptor

public HttpMethodInterceptor getMethodInterceptor()

Returns:

the methodInterceptor

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Parameters:

applicationEventPublisher - the applicationEventPublisher to set

setCancelUpdatesVisitorCalendar

public void setCancelUpdatesVisitorCalendar(String cancelUpdatesVisitorCalendar)

Parameters:

cancelUpdatesVisitorCalendar - the cancelUpdatesVisitorCalendar to set

setReflectionEnabled

public void setReflectionEnabled(boolean reflectionEnabled)

Parameters:

reflectionEnabled - the reflectionEnabled to set

isCancelUpdatesVisitorCalendar

public boolean isCancelUpdatesVisitorCalendar()

Returns:

the cancelUpdatesVisitorCalendar

setCancelUpdatesVisitorCalendar

public void setCancelUpdatesVisitorCalendar(boolean cancelUpdatesVisitorCalendar)

Parameters:

cancelUpdatesVisitorCalendar - the cancelUpdatesVisitorCalendar to set

getEventUtils

public IEventUtils getEventUtils()

Returns:

the eventUtils

getCaldavDialect

public CaldavDialect getCaldavDialect()

Returns:

the caldavDialect

isReflectionEnabled

public boolean isReflectionEnabled()

Returns:

the reflectionEnabled

isPreemptiveAuthenticationEnabled

public boolean isPreemptiveAuthenticationEnabled()

Returns:

the preemptiveAuthenticationEnabled

setPreemptiveAuthenticationEnabled

public void setPreemptiveAuthenticationEnabled(boolean preemptiveAuthenticationEnabled)

Parameters:

preemptiveAuthenticationEnabled - the preemptiveAuthenticationEnabled to set

isGetCalendarPerformsPurgeDeclinedAttendees

public boolean isGetCalendarPerformsPurgeDeclinedAttendees()

Returns:

the getCalendarPerformsPurgeDeclinedAttendees

setGetCalendarPerformsPurgeDeclinedAttendees

public void setGetCalendarPerformsPurgeDeclinedAttendees(boolean getCalendarPerformsPurgeDeclinedAttendees)

Parameters:

getCalendarPerformsPurgeDeclinedAttendees - the getCalendarPerformsPurgeDeclinedAttendees to set

identifyScheme

protected org.apache.http.auth.AuthScheme identifyScheme(String scheme)

Parameters:

scheme -

Returns:

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getCalendar

public net.fortuna.ical4j.model.Calendar getCalendar(ICalendarAccount calendarAccount,
                                                     Date startDate,
                                                     Date endDate)

Specified by:

getCalendar in interface ICalendarDataDao

getExistingAppointment

public net.fortuna.ical4j.model.component.VEvent getExistingAppointment(IScheduleOwner owner,
                                                                        AvailableBlock block)

Specified by:

getExistingAppointment in interface ICalendarDataDao

createAppointment

public net.fortuna.ical4j.model.component.VEvent createAppointment(IScheduleVisitor visitor,
                                                                   IScheduleOwner owner,
                                                                   AvailableBlock block,
                                                                   String eventDescription)

Specified by:

createAppointment in interface ICalendarDataDao

cancelAppointment

public void cancelAppointment(IScheduleVisitor visitor,
                              IScheduleOwner owner,
                              net.fortuna.ical4j.model.component.VEvent appointment)

Specified by:

cancelAppointment in interface ICalendarDataDao

constructHttpContext

protected org.apache.http.protocol.HttpContext constructHttpContext(ICalendarAccount calendarAccount)

Construct an HttpContext with a CredentialsProvider appropriate for the ICalendarAccount argument. Returned value is intended for use with HttpClient.execute(HttpHost, HttpRequest, HttpContext).

Parameters:

calendarAccount -

Returns:

an appropriate HttpContext for the ICalendarAccount.

deleteCalendar

protected int deleteCalendar(CalendarWithURI calendarWithURI,
                             ICalendarAccount calendarAccount)

Parameters:

calendarWithURI -

calendarAccount -

Returns:

joinAppointment

public net.fortuna.ical4j.model.component.VEvent joinAppointment(IScheduleVisitor visitor,
                                                                 IScheduleOwner owner,
                                                                 net.fortuna.ical4j.model.component.VEvent appointment)
                                                          throws SchedulingException

Specified by:

joinAppointment in interface ICalendarDataDao

Throws:

SchedulingException

leaveAppointment

public net.fortuna.ical4j.model.component.VEvent leaveAppointment(IScheduleVisitor visitor,
                                                                  IScheduleOwner owner,
                                                                  net.fortuna.ical4j.model.component.VEvent appointment)
                                                           throws SchedulingException

Specified by:

leaveAppointment in interface ICalendarDataDao

Throws:

SchedulingException

checkForConflicts

public void checkForConflicts(IScheduleOwner owner,
                              AvailableBlock block)
                       throws ConflictExistsException

Specified by:

checkForConflicts in interface ICalendarDataDao

Throws:

ConflictExistsException

reflectAvailableSchedule

public void reflectAvailableSchedule(IScheduleOwner owner,
                                     AvailableSchedule schedule)

Specified by:

reflectAvailableSchedule in interface ICalendarDataDao

purgeAvailableScheduleReflections

public void purgeAvailableScheduleReflections(IScheduleOwner owner,
                                              Date startDate,
                                              Date endDate)

Specified by:

purgeAvailableScheduleReflections in interface ICalendarDataDao

peekAtAvailableScheduleReflections

public List<CalendarWithURI> peekAtAvailableScheduleReflections(IScheduleOwner owner,
                                                                Date startDate,
                                                                Date endDate)

Parameters:

owner -

startDate -

endDate -

Returns:

generateEventUri

protected String generateEventUri(ICalendarAccount owner,
                                  net.fortuna.ical4j.model.component.VEvent event)

This method is intended to generate a unique URI to use with the PUT method in createAppointment(IScheduleVisitor, IScheduleOwner, AvailableBlock, String). It is implemented by the following:

         caldavDialect.calculateCalendarAccountHome(owner.getCalendarAccount) + "/sched-assist-" + randomAlphanumeric + ".ics"
 

Parameters:

owner -

Returns:

generateEventUri

protected String generateEventUri(ICalendarAccount owner,
                                  String eventUid)

Parameters:

owner -

eventUid -

Returns:

getCalendarsInternal

protected List<CalendarWithURI> getCalendarsInternal(ICalendarAccount calendarAccount,
                                                     Date startDate,
                                                     Date endDate)

Parameters:

calendarAccount -

startDate -

endDate -

Returns:

Throws:

IOException

consolidate

protected net.fortuna.ical4j.model.Calendar consolidate(List<CalendarWithURI> calendars)

Consolidate the Calendars within the argument, returning 1.

Parameters:

calendars -

Returns:

never null

Throws:

net.fortuna.ical4j.data.ParserException

See Also:

Calendars.merge(Calendar, Calendar)

merge

protected net.fortuna.ical4j.model.Calendar merge(net.fortuna.ical4j.model.Calendar left,
                                                  net.fortuna.ical4j.model.Calendar right)

Merge the components from all calendars into one result.

Parameters:

calendars -

Returns:

merge

protected void merge(net.fortuna.ical4j.model.Calendar target,
                     net.fortuna.ical4j.model.Calendar left,
                     net.fortuna.ical4j.model.Calendar right)

Mutative method. The first Calendar argument is altered by this method.

Parameters:

target -

left -

right -

getExistingAppointmentInternal

protected CalendarWithURI getExistingAppointmentInternal(IScheduleOwner owner,
                                                         Date startTime,
                                                         Date endTime)

This method returns the CalendarWithURI containing a single VEvent that was created with the Scheduling Assistant with the specified IScheduleOwner as the owner and the specified start and end times.

Parameters:

owner -

startTime -

endTime -

Returns:

the matching Scheduling Assistant VEvent, or null if none for this IScheduleOwner at the specified times

getExistingAppointmentInternalForVisitor

protected CalendarWithURI getExistingAppointmentInternalForVisitor(IScheduleVisitor visitor,
                                                                   Date startTime,
                                                                   Date endTime,
                                                                   net.fortuna.ical4j.model.property.Uid eventUid)

Special method used when cancelUpdatesVisitorCalendar is set to true. Returns the CalendarWithURI in the visitor's account for the event with the specified start, end and eventuid.

Parameters:

owner -

startTime -

endTime -

eventUid -

Returns:

the matching event, or null if not found.

putNewCalendar

protected int putNewCalendar(ICalendarAccount eventOwner,
                             net.fortuna.ical4j.model.Calendar calendar,
                             String eventUid)
                      throws org.apache.http.HttpException,
                             IOException

Store a new calendar using CalDAV PUT.

Parameters:

eventOwner -

event -

Returns:

Throws:

org.apache.http.HttpException

IOException

putNewEvent

protected int putNewEvent(ICalendarAccount eventOwner,
                          net.fortuna.ical4j.model.component.VEvent event)
                   throws org.apache.http.HttpException,
                          IOException

Store a new event using CalDAV PUT.

Parameters:

eventOwner -

event -

Returns:

Throws:

org.apache.http.HttpException

IOException

putExistingEvent

protected int putExistingEvent(ICalendarAccount eventOwner,
                               net.fortuna.ical4j.model.component.VEvent event,
                               String etag)
                        throws IOException

Update an existing event using CalDAV PUT.

Parameters:

eventOwner -

event -

etag -

Returns:

Throws:

org.apache.http.HttpException

IOException

purgeDeclinedAttendees

protected CalendarWithURI purgeDeclinedAttendees(CalendarWithURI calendarWithURI,
                                                 ICalendarAccount owner)

This method will inspect IScheduleVisitor Attendees among the SchedulingAssistantAppointments in the Calendar argument. If an Attendee on an SchedulingAssistantAppointment has Partstat#DECLINED, the appointment will be cancelled (if one on one or lone visitor on group appt) or the attendee will be removed (group appointment with multiple attending visitors).

Parameters:

calendarWithURI -

session -

owner -

Returns:

the calendar minus any events or attendees that have been removed.

Throws:

SchedulingException

StatusException