org.jasig.portlet.calendar.adapter

Class CalDavCalendarAdapter

java.lang.Object

org.jasig.portlet.calendar.adapter.AbstractCalendarAdapter

org.jasig.portlet.calendar.adapter.CalDavCalendarAdapter

All Implemented Interfaces:

ICalendarAdapter

public class CalDavCalendarAdapter
extends AbstractCalendarAdapter
implements ICalendarAdapter

Implementation of ICalendarAdapter that uses CalDAV for retrieving ical-based CalendarEventSets. Useful background articles: URL format varies per provider (see links above). For Google an URL would be https://www.google.com/calendar/dav/CALENDERID/events where CALENDARID is obtained from the properties of the calendars, such as jameswennmacher@gmail.com for a user's personal calendar, or en.usa%23holiday%40group.v.calendar.google.com for the US Holidays calendar. Google uses Basic Authentication (or oAuth 2.0 though this is not implemented yet).

Version:

$Header: CalDavCalendarAdapter.java Exp $

Author:

Jen Bourey, jennifer.bourey@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
CalDavCalendarAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<net.fortuna.ical4j.model.component.VEvent>	convertCalendarToEvents(net.fortuna.ical4j.model.Calendar calendar, org.joda.time.Interval interval)
CalendarEventSet	getEvents(CalendarConfiguration calendarConfiguration, org.joda.time.Interval interval, javax.portlet.PortletRequest request) Get events for the defined calendar and time period.
String	getLink(CalendarConfiguration calendar, org.joda.time.Interval interval, javax.portlet.PortletRequest request) Get hyper link for the defined calendar.
protected net.fortuna.ical4j.model.Calendar	retrieveCalendar(String url, org.joda.time.Interval interval, org.apache.commons.httpclient.Credentials credentials)
void	setCache(net.sf.ehcache.Cache cache)
void	setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator)
void	setCacheKeyPrefix(String cacheKeyPrefix)
void	setCredentialsExtractor(ICredentialsExtractor credentialsExtractor)
void	setUrlCreator(IUrlCreator urlCreator)

Methods inherited from class org.jasig.portlet.calendar.adapter.AbstractCalendarAdapter

getDescriptionKey, getParameters, getTitleKey, insertCalendarEventSetIntoCache, insertCalendarEventSetIntoCache, setDescriptionKey, setParameters, setTitleKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portlet.calendar.adapter.ICalendarAdapter

getDescriptionKey, getParameters, getTitleKey

Field Detail

log

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

Constructor Detail

CalDavCalendarAdapter

public CalDavCalendarAdapter()

Method Detail

setCache

public void setCache(net.sf.ehcache.Cache cache)

setUrlCreator

public void setUrlCreator(IUrlCreator urlCreator)

setCredentialsExtractor

public void setCredentialsExtractor(ICredentialsExtractor credentialsExtractor)

setCacheKeyGenerator

public void setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator)

setCacheKeyPrefix

public void setCacheKeyPrefix(String cacheKeyPrefix)

getEvents

public CalendarEventSet getEvents(CalendarConfiguration calendarConfiguration,
                         org.joda.time.Interval interval,
                         javax.portlet.PortletRequest request)
                           throws CalendarException

Description copied from interface: ICalendarAdapter

Get events for the defined calendar and time period. The user's PortletRequest is made available to give the calendar adapter access to useful information such as the UserInfo map, session data, etc. These items can be used to identify the user, provide access to authentication resources, or other useful operations.

Specified by:

getEvents in interface ICalendarAdapter

Parameters:

calendarConfiguration - calendar configuration for which to retrieve events

interval - time period for which to retrieve events

request - user's portlet request

Returns:

Set of events for this calendar and time period

Throws:

CalendarException

getLink

public String getLink(CalendarConfiguration calendar,
             org.joda.time.Interval interval,
             javax.portlet.PortletRequest request)
               throws CalendarLinkException

Description copied from interface: ICalendarAdapter

Get hyper link for the defined calendar. In cases where the calendar resource has a web interface, this method allows provides access to the url.

Specified by:

getLink in interface ICalendarAdapter

Parameters:

calendar - calendar configuration for which to retrieve events

interval - time period for which to retrieve events

request - user's servlet request

Returns:

Set of events for this calendar and time period

Throws:

CalendarLinkException

retrieveCalendar

protected final net.fortuna.ical4j.model.Calendar retrieveCalendar(String url,
                                                 org.joda.time.Interval interval,
                                                 org.apache.commons.httpclient.Credentials credentials)

convertCalendarToEvents

protected final Set<net.fortuna.ical4j.model.component.VEvent> convertCalendarToEvents(net.fortuna.ical4j.model.Calendar calendar,
                                                                     org.joda.time.Interval interval)
                                                                                throws CalendarException

Throws:

CalendarException