org.jasig.portlet.calendar.adapter

Class ConfigurableFileCalendarAdapter

java.lang.Object

org.jasig.portlet.calendar.adapter.AbstractCalendarAdapter

org.jasig.portlet.calendar.adapter.ConfigurableFileCalendarAdapter

All Implemented Interfaces:

ICalendarAdapter

public class ConfigurableFileCalendarAdapter
extends AbstractCalendarAdapter
implements ICalendarAdapter

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ConfigurableFileCalendarAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
CalendarEventSet	getEvents(CalendarConfiguration calendarConfiguration, org.joda.time.Interval interval, javax.portlet.PortletRequest request) Get events for the defined calendar and time period.
protected net.fortuna.ical4j.model.Calendar	retrieveCalendar(String fileName)
void	setCache(net.sf.ehcache.Cache cache)
void	setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator)
void	setCacheKeyPrefix(String cacheKeyPrefix)
void	setContentProcessor(IContentProcessor contentProcessor)

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

getDescriptionKey, getLink, 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, getLink, getParameters, getTitleKey

Field Detail

log

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

Constructor Detail

ConfigurableFileCalendarAdapter

public ConfigurableFileCalendarAdapter()

Method Detail

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

retrieveCalendar

protected net.fortuna.ical4j.model.Calendar retrieveCalendar(String fileName)
                                                      throws CalendarException

Throws:

CalendarException

setCache

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

setContentProcessor

public void setContentProcessor(IContentProcessor contentProcessor)

setCacheKeyGenerator

public void setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator)

setCacheKeyPrefix

public void setCacheKeyPrefix(String cacheKeyPrefix)