com.google.jenkins.plugins.health.lib

Class DerivedPageAction

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HealthCheckAction

@ExportedBean
public abstract class DerivedPageAction
extends Object
implements hudson.model.RootAction, org.kohsuke.stapler.StaplerProxy

Expose DerivedPageComponents' assembled pages through the Jenkins UI and through the Jenkins remote access API.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DerivedPageAction()

Method Summary

Methods

Modifier and Type	Method and Description
hudson.model.Api	getApi() A default implementation of the remote access API.
protected abstract DerivedPageManager	getDerivedPageManager()
String	getIconFileName()
protected abstract hudson.security.Permission	getReadPermission() Get the permission level needed to view this Action.
Object	getTarget()
DerivedPageZone	getZone(String zoneName)
List<? extends DerivedPageZone>	getZones()

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getDisplayName, getUrlName

Constructor Detail

DerivedPageAction

public DerivedPageAction()

Method Detail

getZone

@Nullable
public DerivedPageZone getZone(String zoneName)

Parameters:

zoneName - the name of the DerivedPageZone to look up.

Returns:

the DerivedPageZone for the given name, null if none.

getZones

public List<? extends DerivedPageZone> getZones()

Returns:

the DerivedPageZones.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getTarget

public Object getTarget()

Specified by:

getTarget in interface org.kohsuke.stapler.StaplerProxy

getApi

public hudson.model.Api getApi()

A default implementation of the remote access API.

getDerivedPageManager

protected abstract DerivedPageManager getDerivedPageManager()

Returns:

the DerivedPageManager paired with this instance.

getReadPermission

protected abstract 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.

Returns:

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