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
protected org.slf4j.Logger	_logger	logger
static final String	ROLE	The Avalon role.

Constructor Summary

Constructors

Constructor	Description
IcsReader()

Method Summary

Modifier and Type	Method	Description
protected IcsReader.IcsEvents	_getEventList(String url, EventsFilterHelper.DateTimeRange dateRange, Long nbEvents, Long maxFileSize)	Get a list of events from an ics file, without trying the cache
List<LocalVEvent>	getEventDates(VEvent event, EventsFilterHelper.DateTimeRange dateRange, Tag tag)	Get a list of LocalDate covered by this event
IcsReader.IcsEvents	getEventList(String name, String content, EventsFilterHelper.DateTimeRange dateRange, Long nbEvents)	Transform a ical string into a list of events
IcsReader.IcsEvents	getEventList(String url, EventsFilterHelper.DateTimeRange dateRange, Long nbEvents, Long maxFileSize)	Get a list of events from an ics file
protected List<VEvent>	getEventsInRangeFromCalendar(Calendar calendar, EventsFilterHelper.DateTimeRange dateRange, Long nbEvents)	Extract events from a calendar
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 Details

ROLE

public static final String ROLE

The Avalon role.

_logger

protected org.slf4j.Logger _logger

logger

Constructor Details

IcsReader

public IcsReader()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEventList

public IcsReader.IcsEvents getEventList(String url,
 EventsFilterHelper.DateTimeRange 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.DateTimeRange 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

getEventList

public IcsReader.IcsEvents getEventList(String name,
 String content,
 EventsFilterHelper.DateTimeRange dateRange,
 Long nbEvents)

Transform a ical string into a list of events

Parameters:

name - the name of the ical

content - the ical content

dateRange - a date range to filter the events (can be null)

nbEvents - the maximum number of event to retrieve

Returns:

the list of events

getEventsInRangeFromCalendar

protected List<VEvent> getEventsInRangeFromCalendar(Calendar calendar,
 EventsFilterHelper.DateTimeRange dateRange,
 Long nbEvents)

Extract events from a calendar

Parameters:

calendar - the calendar to use

dateRange - a range to limit event (can be null)

nbEvents - a maximum number of events

Returns:

the list of events

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getEventDates

public List<LocalVEvent> getEventDates(VEvent event,
 EventsFilterHelper.DateTimeRange 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

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.