com.cloudbees.plugins.registration

Class DataPointContributor

java.lang.Object

com.cloudbees.plugins.registration.DataPointContributor

All Implemented Interfaces:

hudson.ExtensionPoint

public abstract class DataPointContributor
extends Object
implements hudson.ExtensionPoint

Contributes additional DataPoints into CloudBeesWidget.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DataPointContributor()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.ExtensionList<DataPointContributor>	all()
abstract void	collect(com.cloudbees.plugins.credentials.cloudbees.CloudBeesUser user, String accountName, List<DataPoint> result) Collects additional data points and adds them into the given collection.
abstract void	collectSync(com.cloudbees.plugins.credentials.cloudbees.CloudBeesUser user, String accountName, List<DataPoint> result) This version is called synchronously from the HTTP request handling thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataPointContributor

public DataPointContributor()

Method Detail

collect

public abstract void collect(com.cloudbees.plugins.credentials.cloudbees.CloudBeesUser user,
           String accountName,
           List<DataPoint> result)

Collects additional data points and adds them into the given collection.

Data point collection happens periodically and somewhat infrequently (2 mins currently), but it is done in a background without blocking the HTTP request handling thread. This design allows this method to perform slow I/O if needed.

Parameters:

user - User account registered with Jenkins. Never null.

accountName - Status is reported per account. This is the current account for which data points are gathered. Never null.

result - Any data points obtained should be added into this collection.

collectSync

public abstract void collectSync(com.cloudbees.plugins.credentials.cloudbees.CloudBeesUser user,
               String accountName,
               List<DataPoint> result)

This version is called synchronously from the HTTP request handling thread.

This is suitable when your data point can be computed without incurring I/O, and you need to be able to update values more frequently than the 2 mins cycles of collect(CloudBeesUser, String, List)

all

public static hudson.ExtensionList<DataPointContributor> all()