org.jasig.portlet.calendar.adapter

Class ExchangeCalendarAdapter

java.lang.Object

org.jasig.portlet.calendar.adapter.AbstractCalendarAdapter

org.jasig.portlet.calendar.adapter.ExchangeCalendarAdapter

All Implemented Interfaces:

ICalendarAdapter

public class ExchangeCalendarAdapter
extends AbstractCalendarAdapter
implements ICalendarAdapter

Queries Exchange Web Services API for calendar events.

Version:

$Revision$

Author:

Jen Bourey, jbourey@unicon.net

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AVAILABILITY_SOAP_ACTION
protected org.slf4j.Logger	log
protected static String	UTC

Constructor Summary

Constructors

Constructor and Description
ExchangeCalendarAdapter()

Method Summary

Modifier and Type	Method and Description
protected GetUserAvailabilityRequest	getAvailabilityRequest(org.joda.time.Interval interval, String emailAddress)
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.component.VEvent	getInternalEvent(long calendarId, CalendarEvent msEvent) Return an internal API CalendarEvent for an Microsoft CalendarEvent object.
protected XMLGregorianCalendar	getXmlDate(org.joda.time.DateTime date) Get an XMLGregorianCalendar for the specified date.
void	setCache(net.sf.ehcache.Cache cache) Sets the cache to use for caching calendar events
void	setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator) Sets the cache key generator to use.
void	setCacheKeyPrefix(String cacheKeyPrefix) Sets the cache key prefix to use for this adapter.
void	setCredentialsService(IExchangeCredentialsInitializationService credentialsService) Set the Exchange Credentials service for interacting with credentials information.
void	setEmailAttribute(String emailAttribute)
void	setRequestServerVersion(String requestServerVersion) Sets the minimum Exchange Web Services messaging version required.
void	setWebServiceOperations(org.springframework.ws.client.core.WebServiceOperations webServiceOperations) Set the Spring WebService operations object to allow making Web Services calls.

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

AVAILABILITY_SOAP_ACTION

protected static final String AVAILABILITY_SOAP_ACTION

See Also:

Constant Field Values

UTC

protected static final String UTC

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

Constructor Detail

ExchangeCalendarAdapter

public ExchangeCalendarAdapter()

Method Detail

setWebServiceOperations

public void setWebServiceOperations(org.springframework.ws.client.core.WebServiceOperations webServiceOperations)

Set the Spring WebService operations object to allow making Web Services calls.

Parameters:

webServiceOperations - Spring WebService operations object

setCredentialsService

public void setCredentialsService(IExchangeCredentialsInitializationService credentialsService)

Set the Exchange Credentials service for interacting with credentials information.

Parameters:

credentialsService - Exchange Credentials service

setCache

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

Sets the cache to use for caching calendar events

Parameters:

cache - cache to use

setCacheKeyGenerator

public void setCacheKeyGenerator(ICacheKeyGenerator cacheKeyGenerator)

Sets the cache key generator to use. Defaults to DefaultCacheKeyGeneratorImpl

Parameters:

cacheKeyGenerator -

setCacheKeyPrefix

public void setCacheKeyPrefix(String cacheKeyPrefix)

Sets the cache key prefix to use for this adapter. Defaults to "exchange".

Parameters:

cacheKeyPrefix - cache key prefix to use

setEmailAttribute

public void setEmailAttribute(String emailAttribute)

setRequestServerVersion

public void setRequestServerVersion(String requestServerVersion)

Sets the minimum Exchange Web Services messaging version required. Defaults to Exchange2007_SP1.

Parameters:

requestServerVersion -

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

getAvailabilityRequest

protected GetUserAvailabilityRequest getAvailabilityRequest(org.joda.time.Interval interval,
                                                            String emailAddress)
                                                     throws DatatypeConfigurationException

Throws:

DatatypeConfigurationException

getInternalEvent

protected net.fortuna.ical4j.model.component.VEvent getInternalEvent(long calendarId,
                                                                     CalendarEvent msEvent)
                                                              throws DatatypeConfigurationException

Return an internal API CalendarEvent for an Microsoft CalendarEvent object.

Parameters:

calendarId -

msEvent -

Returns:

Throws:

DatatypeConfigurationException

getXmlDate

protected XMLGregorianCalendar getXmlDate(org.joda.time.DateTime date)
                                   throws DatatypeConfigurationException

Get an XMLGregorianCalendar for the specified date.

Parameters:

date -

Returns:

Throws:

DatatypeConfigurationException