HBBaseDataCollector (Alfresco Repository 6.56.75 API)

java.lang.Object
- org.alfresco.heartbeat.HBBaseDataCollector

Direct Known Subclasses:

AuthoritiesDataCollector, ConfigurationDataCollector, InfoDataCollector, ModelUsageDataCollector, SystemUsageDataCollector
```
public abstract class HBBaseDataCollector
extends java.lang.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	Description
`HBBaseDataCollector(java.lang.String collectorId, java.lang.String collectorVersion, java.lang.String cronExpression)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract java.util.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`
`java.lang.String`	`getCollectorId()`
`java.lang.String`	`getCollectorVersion()`
`java.lang.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(java.lang.String collectorId,
                           java.lang.String collectorVersion,
                           java.lang.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 java.lang.String getCollectorId()
```
  - getCollectorVersion
```
public java.lang.String getCollectorVersion()
```
  - getCronExpression
```
public java.lang.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 java.util.List<org.alfresco.heartbeat.datasender.HBData> collectData()
```
    This method returns data to be collected.
    
    Returns:
    
    List of HBData