com.google.jenkins.plugins.health.lib

Class DerivedPageZone<Component extends DerivedPageComponent<Report>,Report extends DerivedPageComponentReport>

java.lang.Object

com.google.jenkins.plugins.health.lib.DerivedPageZone<Component,Report>

Type Parameters:

Component - The type of DerivedPageComponent be that Component this Zone stores.

Report - The specific subtype of DerivedPageComponentReport that Component should output.

All Implemented Interfaces:

hudson.model.ModelObject

Direct Known Subclasses:

HealthZone

@ExportedBean
public abstract class DerivedPageZone<Component extends DerivedPageComponent<Report>,Report extends DerivedPageComponentReport>
extends Object
implements hudson.model.ModelObject

A DerivedPageZone is a named container for DerivedPageComponents. Separating pages into different grouping gives flexibility to allow for different severity levels, different listeners, projects or users, etc. For example, in a Jenkins health-testing implementation, critical health metrics may require immediate actions, while low severity ones may need a reaction only once a day. Each DerivedPageZone has a unique URL path "/${DerivedPageAction.getUrlName}/zone/${zoneName}".

Constructor Summary

Constructors

Constructor and Description
DerivedPageZone(String name, List<Component> components)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Report	derivePageComponent(Component component) Return the component's Report indicating the success of the derivation and any result obtained from it.
List<Component>	getComponents()
String	getName()
Map<String,Report>	getReports()
protected abstract String	namePageComponent(Component component) Provide the key by which a Component's derived result will be indexed and displayed to the user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Detail

DerivedPageZone

public DerivedPageZone(String name,
               List<Component> components)

Parameters:

name - the name of this DerivedPageZone.

components - a list of DerivedPageComponents to contain.

Method Detail

getName

public String getName()

Returns:

the name of this zone.

getComponents

public List<Component> getComponents()

Returns:

the list of DerivedPageComponent in this DerivedPageZone.

namePageComponent

protected abstract String namePageComponent(Component component)

Provide the key by which a Component's derived result will be indexed and displayed to the user. For examples, a name passed to the component's constructor on page configuration, or the name of the component class when there will be no reuse within a page.

derivePageComponent

protected abstract Report derivePageComponent(Component component)

Return the component's Report indicating the success of the derivation and any result obtained from it.

getReports

@Exported
public Map<String,Report> getReports()

Returns:

results of DerivedPageComponents.