de.gerdiproject.harvest.rest

Class AbstractRestObject<T extends AbstractRestObject<T,P>,P>

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestObject<T,P>

Type Parameters:

T - the type of the object itself, ugly but necessary Java solution

P - the return type of the getAsJson() function used to retrieve a JSON representation of this object

All Implemented Interfaces:

IEventListener

Direct Known Subclasses:

Configuration, ETLManager, Scheduler

public abstract class AbstractRestObject<T extends AbstractRestObject<T,P>,P>
extends Object
implements IEventListener

This abstract class represents a singleton that is to be manipulated by an AbstractRestResource.

Author:

Robin Weiss

Field Summary

Fields

Modifier and Type	Field and Description
protected String	moduleName

Constructor Summary

Constructors

Constructor and Description
AbstractRestObject(String moduleName, Class<? extends GetRestObjectEvent<T>> getterEventClass) Constructor that requires the moduleName for pretty printing and the class of the GetRestObjectEvent that is used to retrieve the singleton instance of this object.

Method Summary

Modifier and Type	Method and Description
void	addEventListeners() Adds event listeners.
abstract P	getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query) Returns a JSON representation of this object.
String	getAsPlainText() Returns a pretty print representation of this object along with a title.
protected abstract String	getPrettyPlainText() Returns a pretty print representation of this object.
protected void	onContextDestroyed(ContextDestroyedEvent event) Cleans up all objects that are used by this object and removes event listeners.
void	removeEventListeners() Removes all event listeners of this class.

Methods inherited from class java.lang.Object

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

Field Detail

moduleName

protected final String moduleName

Constructor Detail

AbstractRestObject

public AbstractRestObject(String moduleName,
                          Class<? extends GetRestObjectEvent<T>> getterEventClass)

Constructor that requires the moduleName for pretty printing and the class of the GetRestObjectEvent that is used to retrieve the singleton instance of this object.

Parameters:

moduleName - the name of the service

getterEventClass - the class of a GetRestObjectEvent

Method Detail

addEventListeners

public void addEventListeners()

Description copied from interface: IEventListener

Adds event listeners.

Specified by:

addEventListeners in interface IEventListener

removeEventListeners

public void removeEventListeners()

Description copied from interface: IEventListener

Removes all event listeners of this class.

Specified by:

removeEventListeners in interface IEventListener

getAsPlainText

public final String getAsPlainText()

Returns a pretty print representation of this object along with a title.

Returns:

a title and a pretty print representation of this object

getPrettyPlainText

protected abstract String getPrettyPlainText()

Returns a pretty print representation of this object.

Returns:

a pretty print representation of this object

getAsJson

public abstract P getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query)

Returns a JSON representation of this object.

Parameters:

query - optional query parameters from the HTTP request

Returns:

a JSON representation of this object

onContextDestroyed

protected void onContextDestroyed(ContextDestroyedEvent event)

Cleans up all objects that are used by this object and removes event listeners.

Parameters:

event - the event that triggered the callback function