de.gerdiproject.harvest.etls.utils

Class ETLManager

java.lang.Object

de.gerdiproject.harvest.rest.AbstractRestObject<ETLManager,ETLManagerJson>

de.gerdiproject.harvest.etls.utils.ETLManager

All Implemented Interfaces:

IEventListener, ICachedObject

public class ETLManager
extends AbstractRestObject<ETLManager,ETLManagerJson>
implements ICachedObject

This class serves as an interface for all AbstractETLs that are required to harvest the repository.

Author:

Robin Weiss

Field Summary

Fields inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

moduleName

Constructor Summary

Constructors

Constructor and Description
ETLManager(String moduleName, File cacheFolder) Constructor.

Method Summary

Modifier and Type	Method and Description
void	abortHarvest() Attempts to abort an ongoing harvest.
void	addEventListeners() Adds event listeners.
long	estimateRemainingHarvestTime() Estimates the remaining harvesting duration in milliseconds.
ETLManagerJson	getAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query) Returns a JSON representation of this object.
ETLJson	getETLAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query) Returns a specified ETL as JSON object.
ETLInfosJson	getETLsAsJson() Returns an info JSON object with detailed information about all ETLs.
int	getHarvestedCount() Retrieves the number of documents that have been loaded.
ETLHealth	getHealth() Retrieves an overall health status.
int	getMaxNumberOfDocuments() Sums up the expected number of harvestable documents of all registered ETLs.
protected String	getPrettyPlainText() Returns a pretty print representation of this object.
ETLState	getState() Returns a status representing the entirety of all registered ETL statuses.
void	harvest() Attempts to start a harvest, signaling all registered ETLs to start
boolean	hasOutdatedETLs() Updates all registered ETLs and checks if they are outdated.
void	loadFromDisk() Attempts to load and set values from a cached file.
void	register(AbstractETL<?,?> addedEtl) Registers an AbstractETL, adding it to the list of ETLs that can be controlled via REST.
void	removeEventListeners() Removes all event listeners of this class.
void	saveToDisk() Saves the object to a cache file on disk, which can be loaded via loadFromDisk().

Methods inherited from class de.gerdiproject.harvest.rest.AbstractRestObject

getAsPlainText, onContextDestroyed

Methods inherited from class java.lang.Object

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

Constructor Detail

ETLManager

public ETLManager(String moduleName,
                  File cacheFolder)

Constructor.

Parameters:

moduleName - the name of the harvester service

cacheFolder - the project's cache folder

Method Detail

loadFromDisk

public void loadFromDisk()

Description copied from interface: ICachedObject

Attempts to load and set values from a cached file.

Specified by:

loadFromDisk in interface ICachedObject

saveToDisk

public void saveToDisk()

Description copied from interface: ICachedObject

Saves the object to a cache file on disk, which can be loaded via loadFromDisk().

Specified by:

saveToDisk in interface ICachedObject

getPrettyPlainText

protected String getPrettyPlainText()

Description copied from class: AbstractRestObject

Returns a pretty print representation of this object.

Specified by:

getPrettyPlainText in class AbstractRestObject<ETLManager,ETLManagerJson>

Returns:

a pretty print representation of this object

getAsJson

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

Description copied from class: AbstractRestObject

Returns a JSON representation of this object.

Specified by:

getAsJson in class AbstractRestObject<ETLManager,ETLManagerJson>

Parameters:

query - optional query parameters from the HTTP request

Returns:

a JSON representation of this object

getETLsAsJson

public ETLInfosJson getETLsAsJson()

Returns an info JSON object with detailed information about all ETLs.

Returns:

an info JSON object with detailed information about all ETLs

getETLAsJson

public ETLJson getETLAsJson(javax.ws.rs.core.MultivaluedMap<String,String> query)
                     throws IllegalArgumentException

Returns a specified ETL as JSON object.

Parameters:

query - query parameters that should contain 'name'

Returns:

the ETL specified by the name-query-parameter

Throws:

IllegalArgumentException - if no name was specified or the ETL with that name could not be found

register

public void register(AbstractETL<?,?> addedEtl)

Registers an AbstractETL, adding it to the list of ETLs that can be controlled via REST. If the ETL name contains invalid characters, they are removed. If another ETL was registered under the same name as the added ETL, a number is appended to prevent name clashes.

Parameters:

addedEtl - the AbstractETL to be registered

hasOutdatedETLs

public boolean hasOutdatedETLs()

Updates all registered ETLs and checks if they are outdated.

Returns:

true if at least one ETL is outdated

addEventListeners

public void addEventListeners()

Description copied from interface: IEventListener

Adds event listeners.

Specified by:

addEventListeners in interface IEventListener

Overrides:

addEventListeners in class AbstractRestObject<ETLManager,ETLManagerJson>

removeEventListeners

public void removeEventListeners()

Description copied from interface: IEventListener

Removes all event listeners of this class.

Specified by:

removeEventListeners in interface IEventListener

Overrides:

removeEventListeners in class AbstractRestObject<ETLManager,ETLManagerJson>

harvest

public void harvest()
             throws IllegalStateException

Attempts to start a harvest, signaling all registered ETLs to start

Throws:

IllegalStateException - thrown if another ongoing harvest is blocking this process

getMaxNumberOfDocuments

public int getMaxNumberOfDocuments()

Sums up the expected number of harvestable documents of all registered ETLs.

Returns:

the expected total number of harvestable documents, or -1 if the number cannot be calculated

abortHarvest

public void abortHarvest()

Attempts to abort an ongoing harvest.

Throws:

IllegalStateException - if no harvest is in progress

getHarvestedCount

public int getHarvestedCount()

Retrieves the number of documents that have been loaded.

Returns:

the number of documents that have been loaded

getHealth

public ETLHealth getHealth()

Retrieves an overall health status.

Returns:

a health status representing the combined health of all registered ETLs

getState

public ETLState getState()

Returns a status representing the entirety of all registered ETL statuses.

Returns:

a status representing the entirety of all registered ETL statuses

estimateRemainingHarvestTime

public long estimateRemainingHarvestTime()

Estimates the remaining harvesting duration in milliseconds.

Returns:

the remaining harvesting duration in milliseconds, or -1 if it cannot be estimated