de.hawhamburg.reachability.tools.googleCalendar

Class GoogleCalendarHook

java.lang.Object

de.hawhamburg.reachability.tools.googleCalendar.GoogleCalendarHook

public class GoogleCalendarHook
extends java.lang.Object

Adapter for the google calendar web-service.

This class serves as adapter to the google calendar web-service. It provides a connection to the webservice using the google gdata library. Furthermore it provides methods to fetch events from a certain calendar and to customize the request by using certain user defined conditions.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gdata.client.calendar.CalendarService	service The google calendar object.

Constructor Summary

Constructors

Constructor and Description
GoogleCalendarHook(java.lang.String user, java.lang.String password) Initializes a new GoogleCalendarHook with a supplied user and password.

Method Summary

Methods

Modifier and Type	Method and Description
private com.google.gdata.client.calendar.CalendarService	connect(java.lang.String app, java.lang.String user, java.lang.String password) Connects to the google calendar web-service using the supplied application name, user and password.
java.util.List<java.lang.String>	getCalendars() Fetches the accessible calendars within the established connection.
java.util.List<com.google.gdata.data.calendar.CalendarEventEntry>	getEvents(java.lang.String calendar, int amount, com.google.gdata.data.DateTime min, com.google.gdata.data.DateTime max, java.lang.String sortOrder) Fetches entries from a certain calendar within the established connection using supplied request conditions.
private <T extends com.google.gdata.data.IFeed> T	getFeed(com.google.gdata.client.Query query, java.lang.Class<T> feedClass) Fetches a feed by query.
private <T extends com.google.gdata.data.IFeed> T	getFeed(java.net.URL url, java.lang.Class<T> feedClass) Fetches a feed by URL.
boolean	isConnected() Determines if this object is connected to the google calendar web-service.

Methods inherited from class java.lang.Object

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

Field Detail

service

private com.google.gdata.client.calendar.CalendarService service

The google calendar object.

Constructor Detail

GoogleCalendarHook

public GoogleCalendarHook(java.lang.String user,
                  java.lang.String password)

Initializes a new GoogleCalendarHook with a supplied user and password. The connection to the google calendar will be established using these informations. The communication to the google calendar web-service will be done using an SSL connection.

Parameters:

user - The users id as String.

password - The users password as String.

Method Detail

connect

private com.google.gdata.client.calendar.CalendarService connect(java.lang.String app,
                                                       java.lang.String user,
                                                       java.lang.String password)

Connects to the google calendar web-service using the supplied application name, user and password. The connection to the google calendar will be established using these informations

Parameters:

app - The name of this application as String.

user - The users id as String.

password - The users password as String.

Returns:

The connection to the google calendar web-service as CalendarService.

isConnected

public final boolean isConnected()

Determines if this object is connected to the google calendar web-service.

Returns:

true if this object is connected, otherwise false.

getCalendars

public final java.util.List<java.lang.String> getCalendars()

Fetches the accessible calendars within the established connection.

Returns:

A List of calendars as String, which are accessible within the established connection.

getEvents

public final java.util.List<com.google.gdata.data.calendar.CalendarEventEntry> getEvents(java.lang.String calendar,
                                                                          int amount,
                                                                          com.google.gdata.data.DateTime min,
                                                                          com.google.gdata.data.DateTime max,
                                                                          java.lang.String sortOrder)

Fetches entries from a certain calendar within the established connection using supplied request conditions.

Parameters:

calendar - The calendars name as String for which the requests was launched.

amount - The maximum amount of results, -1 is used as wildcard for all.

min - The start time of the search as DateTime, null if indifferent.

max - The end time of the search as DateTime, null if indifferent.

sortOrder - The sorting order as String (ascending or descending).

Returns:

A List of CalendarEventEntry as search result.

getFeed

private <T extends com.google.gdata.data.IFeed> T getFeed(java.net.URL url,
                                                java.lang.Class<T> feedClass)

Fetches a feed by URL.

Type Parameters:

T - The result feeds object type implementing IFeed.

Parameters:

url - The URL to the feed.

feedClass - The result feeds object class.

Returns:

The feed as feedClass.

getFeed

private <T extends com.google.gdata.data.IFeed> T getFeed(com.google.gdata.client.Query query,
                                                java.lang.Class<T> feedClass)

Fetches a feed by query.

Type Parameters:

T - The result feeds object type implementing IFeed.

Parameters:

query - The query to the feed.

feedClass - The result feeds object class.

Returns:

The feed as feedClass.