de.hawhamburg.reachability.tools.googleCalendar

Class GoogleCalendarHookService

java.lang.Object

java.lang.Thread

de.hawhamburg.reachability.tools.googleCalendar.GoogleCalendarHookService

All Implemented Interfaces:

StopableObject, java.lang.Runnable

public final class GoogleCalendarHookService
extends java.lang.Thread
implements StopableObject

Google calendar hook service which receives requests and returns results via the ActiveMQ.

This service connects to a google calendar web-service using the GoogleCalendarHook and awaits external requests via the ActiveMQ. If a request arises, it will search for fitting results and return them via the ActiveMQ again. This service is designed as stand-alone application.

Version:

"2013.42"

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private GoogleCalendarHook	calendar The connection to the google calendar web-service as GoogleCalendarHook.
private static java.lang.String	GCS_REQUEST_TOPIC The name of the ActiveMQ topic as String on which the service expects requests.
private static java.lang.String	GCS_RESULT_TOPIC The name of the ActiveMQ topic as String on which the service publishes its results.
private static java.lang.String	GOOGLE_CALENDAR The name of the google calendar which shall be used.
private static java.lang.String	GOOGLE_PASSWORD The (fixed...) password of the google user.
private static java.lang.String	GOOGLE_USER The (fixed...) name of the google user.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	requestTopic The LPSubscriber, which reads requests from the ActiveMQ.
private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	resultTopic The LPPublisher, which writes request messags to the ActiveMQ.
private boolean	shutDown Determines if the method shutDown() has been called.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	GoogleCalendarHookService() Private constructor method to prevent external created instances of this class.

Method Summary

Methods

Modifier and Type	Method and Description
private JsonGoogleCalendarResult	createResultMessage(JsonGoogleCalendarRequest request, java.util.List<com.google.gdata.data.calendar.CalendarEventEntry> entries) Creates a new JsonGoogleCalendarResult message object which contains the results of the request forwarded to the GoogleCalendarHook.
private void	end() Gracefully shutdown all open connections.
private void	getAndPushCalendarEvents(JsonGoogleCalendarRequest request) This method forwords a request to the GoogleCalendarHook and publishes its results via the ActiveMQ.
private void	handleRequest() The methods handles arising requests via the ActiveMQ and forwards them to the GoogleCalendarHook by using getAndPushCalendarEvents(JsonGoogleCalendarRequest).
private void	init() Initializes connections and class field structures.
boolean	isActive() Determines whether the method StopableObject.shutDown() has been called on this object or not.
static void	main(java.lang.String[] args) This method starts a new GoogleCalendarHookService.
void	run() Runs the google calendar service.
void	shutDown() Shuts the object down.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

GCS_REQUEST_TOPIC

private static final java.lang.String GCS_REQUEST_TOPIC

The name of the ActiveMQ topic as String on which the service expects requests.

See Also:

Constant Field Values

GCS_RESULT_TOPIC

private static final java.lang.String GCS_RESULT_TOPIC

The name of the ActiveMQ topic as String on which the service publishes its results.

See Also:

Constant Field Values

GOOGLE_USER

private static final java.lang.String GOOGLE_USER

The (fixed...) name of the google user.
This needs to be exported to an external file or the message communication during further works.

See Also:

Constant Field Values

GOOGLE_PASSWORD

private static final java.lang.String GOOGLE_PASSWORD

The (fixed...) password of the google user.
This needs to be exported to an external file or the message communication during further works.

See Also:

Constant Field Values

GOOGLE_CALENDAR

private static final java.lang.String GOOGLE_CALENDAR

The name of the google calendar which shall be used.

See Also:

Constant Field Values

requestTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber requestTopic

The LPSubscriber, which reads requests from the ActiveMQ.

resultTopic

private de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher resultTopic

The LPPublisher, which writes request messags to the ActiveMQ.

calendar

private GoogleCalendarHook calendar

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

shutDown

private boolean shutDown

Determines if the method shutDown() has been called.

Constructor Detail

GoogleCalendarHookService

private GoogleCalendarHookService()

Private constructor method to prevent external created instances of this class. Instances will only be created by the main(String[]) method.

Method Detail

isActive

public boolean isActive()

Description copied from interface: StopableObject

Determines whether the method StopableObject.shutDown() has been called on this object or not.

Specified by:

isActive in interface StopableObject

Returns:

true if shutDown() wasn't called, otherwise false.

See Also:

StopableObject.isActive()

shutDown

public void shutDown()

Description copied from interface: StopableObject

Shuts the object down. The method shall ensure, that all opened or started resources (e.g. ActiveMQ connections, started threads) will be controlled shut down before the objects ends itself.

Specified by:

shutDown in interface StopableObject

See Also:

StopableObject.shutDown()

run

public void run()

Runs the google calendar service. It opens the ActiveMQ connections and the GoogleCalendarHook. It waits for requests and sends the results via the ActiveMQ if one arises. After the shutDown() method has been called, it gracefully ends this service.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

init

private void init()

Initializes connections and class field structures.

end

private void end()

Gracefully shutdown all open connections.

handleRequest

private void handleRequest()

The methods handles arising requests via the ActiveMQ and forwards them to the GoogleCalendarHook by using getAndPushCalendarEvents(JsonGoogleCalendarRequest).

getAndPushCalendarEvents

private void getAndPushCalendarEvents(JsonGoogleCalendarRequest request)

This method forwords a request to the GoogleCalendarHook and publishes its results via the ActiveMQ.

Parameters:

request - The users request as JsonGoogleCalendarRequest message object.

createResultMessage

private JsonGoogleCalendarResult createResultMessage(JsonGoogleCalendarRequest request,
                                           java.util.List<com.google.gdata.data.calendar.CalendarEventEntry> entries)

Creates a new JsonGoogleCalendarResult message object which contains the results of the request forwarded to the GoogleCalendarHook.

Parameters:

request - The original request message as JsonGoogleCalendarRequest.

entries - The search results of the GoogleCalendarHook as List of CalendarEventEntry.

Returns:

A new proper JsonGoogleCalendarResult containing the request results.

main

public static void main(java.lang.String[] args)

This method starts a new GoogleCalendarHookService.

Parameters:

args - The command line arguments as array of String.