com.google.jenkins.plugins.health

Class HealthCheckAction

java.lang.Object

com.google.jenkins.plugins.health.lib.DerivedPageAction

com.google.jenkins.plugins.health.HealthCheckAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, org.kohsuke.stapler.StaplerProxy

@ExportedBean
@Extension
public class HealthCheckAction
extends DerivedPageAction

Expose HealthCheck results through the Jenkins UI, and also through the Jenkins remote access API. TODO(nghia): - consider a HealthCheckListener extension point? TODO(nghia): - consider a HealthCheckTrigger trigger?

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.security.Permission	CHECK Introduce the Health/Check permission.
static hudson.security.PermissionGroup	PERMISSIONS Introduce a new type of Permission group for Health Check.

Constructor Summary

Constructors

Constructor and Description
HealthCheckAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected HealthCheckManager	getDerivedPageManager()
String	getDisplayName()
protected hudson.security.Permission	getReadPermission() Get the permission level needed to view this Action.
String	getUrlName()

Methods inherited from class com.google.jenkins.plugins.health.lib.DerivedPageAction

getApi, getIconFileName, getTarget, getZone, getZones

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSIONS

public static final hudson.security.PermissionGroup PERMISSIONS

Introduce a new type of Permission group for Health Check.

CHECK

public static final hudson.security.Permission CHECK

Introduce the Health/Check permission.

Constructor Detail

HealthCheckAction

public HealthCheckAction()

Method Detail

getDisplayName

public String getDisplayName()

getUrlName

public String getUrlName()

getDerivedPageManager

protected HealthCheckManager getDerivedPageManager()

Specified by:

getDerivedPageManager in class DerivedPageAction

Returns:

the HealthCheckManager.

getReadPermission

protected hudson.security.Permission getReadPermission()

Get the permission level needed to view this Action. Hook for subclasses to provide a permission required for viewing the managed pages this class provides, or null to not test any permission.

Specified by:

getReadPermission in class DerivedPageAction

Returns:

A permission needed to view, for example Jenkins.READ.