org.alfresco.heartbeat

Class HBBaseDataCollector

java.lang.Object

org.alfresco.heartbeat.HBBaseDataCollector

Direct Known Subclasses:

AuthoritiesDataCollector, ConfigurationDataCollector, InfoDataCollector, ModelUsageDataCollector, SystemUsageDataCollector

public abstract class HBBaseDataCollector
extends Object

This class is to be extended by HeartBeat data collectors. Every new collector needs to provide details of the data it collects. As good examples use one of the existing collectors AuthoritiesDataCollector, ConfigurationDataCollector, InfoDataCollector, ModelUsageDataCollector, SystemUsageDataCollector. They are all following this layout:

• Collector ID: a.collector.id
• Data:
  • dataP1: data type - description
  • dataP2: data type - description
  ...

Author:

eknizat

Constructor Summary

Constructors

Constructor and Description
HBBaseDataCollector(String collectorId, String collectorVersion, String cronExpression)

Method Summary

Modifier and Type	Method and Description
abstract List<org.alfresco.heartbeat.datasender.HBData>	collectData() This method returns data to be collected.
void	deregister() This method is called by Spring at initialisation and will deregister this collector with the provided HBDataCollectorService
String	getCollectorId()
String	getCollectorVersion()
String	getCronExpression()
void	register() This method is called by Spring at initialisation and will register this collector with the provided HBDataCollectorService
void	setHbDataCollectorService(HBDataCollectorService hbDataCollectorService)

Methods inherited from class java.lang.Object

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

Constructor Detail

HBBaseDataCollector

public HBBaseDataCollector(String collectorId,
                           String collectorVersion,
                           String cronExpression)

Parameters:

collectorId - Unique name of the collector e.g.: acs.repository.info

collectorVersion - Version of the collector e.g.: 1.0

cronExpression - Cron expression for frequently time scheduling e.g.: "0 0 0 ? * SUN" (Weekly)

Method Detail

getCollectorId

public String getCollectorId()

getCollectorVersion

public String getCollectorVersion()

getCronExpression

public String getCronExpression()

setHbDataCollectorService

public void setHbDataCollectorService(HBDataCollectorService hbDataCollectorService)

register

public void register()

This method is called by Spring at initialisation and will register this collector with the provided HBDataCollectorService

deregister

public void deregister()

This method is called by Spring at initialisation and will deregister this collector with the provided HBDataCollectorService

collectData

public abstract List<org.alfresco.heartbeat.datasender.HBData> collectData()

This method returns data to be collected.

Returns:

List of HBData