Package org.ametys.plugins.calendar.icsreader

Class IcsReader

java.lang.Object

org.ametys.plugins.calendar.icsreader.IcsReader

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

public class IcsReader
extends Object
implements Serviceable, Component, Initializable, LogEnabled

Read a distant ICS file for a certain number of events in the future

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IcsReader.IcsEvents	Object wrapper for ics events

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__ICS_CACHE_ID
private AbstractCacheManager	_abstractCacheManager
protected org.slf4j.Logger	_logger	logger
static String	ROLE	The Avalon role.

Constructor Summary

Constructors

Constructor	Description
IcsReader()

Method Summary

Modifier and Type	Method	Description
private Date	_getEventDateTime(CalendarComponent event, String property)	Return a string representing the start/end date of an event, or null if no start/end date was found
protected IcsReader.IcsEvents	_getEventList(String url, EventsFilterHelper.DateRange dateRange, Long nbEvents, Long maxFileSize)	Get a list of events from an ics file, without trying the cache
List<LocalVEvent>	getEventDates(VEvent event, EventsFilterHelper.DateRange dateRange, Tag tag)	Get a list of LocalDate covered by this event
IcsReader.IcsEvents	getEventList(String url, EventsFilterHelper.DateRange dateRange, Long nbEvents, Long maxFileSize)	Get a list of events from an ics file
private long	getFileSize(String url)	Try to get the size of the file, and download it if needed
private Cache<CacheKey,IcsReader.IcsEvents>	getIcsCache()
private org.slf4j.Logger	getLogger()
void	initialize()
void	service(ServiceManager smanager)
void	setLogger(org.slf4j.Logger logger)	Called at creation time to provide a Logger.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role.

__ICS_CACHE_ID

private static final String __ICS_CACHE_ID

_logger

protected org.slf4j.Logger _logger

logger

_abstractCacheManager

private AbstractCacheManager _abstractCacheManager

Constructor Detail

IcsReader

public IcsReader()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEventList

public IcsReader.IcsEvents getEventList(String url,
                                        EventsFilterHelper.DateRange dateRange,
                                        Long nbEvents,
                                        Long maxFileSize)

Get a list of events from an ics file

Parameters:

url - url of the ics file

dateRange - range of dates to fetch

nbEvents - number of events to read

maxFileSize - max ics file size (in bytes)

Returns:

a List of VEvent

_getEventList

protected IcsReader.IcsEvents _getEventList(String url,
                                            EventsFilterHelper.DateRange dateRange,
                                            Long nbEvents,
                                            Long maxFileSize)

Get a list of events from an ics file, without trying the cache

Parameters:

url - url of the ics file

dateRange - range of dates to fetch

nbEvents - number of events to read

maxFileSize - max ics file size (in bytes)

Returns:

a List of VEvent

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getIcsCache

private Cache<CacheKey,IcsReader.IcsEvents> getIcsCache()

getFileSize

private long getFileSize(String url)
                  throws IOException

Try to get the size of the file, and download it if needed

Parameters:

url - the url to get

Returns:

size in octet, or -1 if error

Throws:

IOException - Something went wrong

getEventDates

public List<LocalVEvent> getEventDates(VEvent event,
                                       EventsFilterHelper.DateRange dateRange,
                                       Tag tag)

Get a list of LocalDate covered by this event

Parameters:

event - the event to test

dateRange - the dates to check, can be null but this will return null

tag - the tag used for this ICS

Returns:

a list of LocalDate for the days in which this event appears, or null if nothing matches

_getEventDateTime

private Date _getEventDateTime(CalendarComponent event,
                               String property)

Return a string representing the start/end date of an event, or null if no start/end date was found

Parameters:

event - the event to read

property - a Property to check ( Property.DTSTART or Property.DTEND )

Returns:

a string representing the date

setLogger

public void setLogger(org.slf4j.Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

getLogger

private org.slf4j.Logger getLogger()