com.google.jenkins.plugins.health.lib

Class DerivedPageManager<Zone extends DerivedPageZone>

java.lang.Object

hudson.model.ManagementLink

com.google.jenkins.plugins.health.lib.DerivedPageManager<Zone>

Type Parameters:

Zone - Subtype of DerivedPageZone which stores the configuration of an individual named page instance.

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.Saveable

Direct Known Subclasses:

HealthCheckManager

public abstract class DerivedPageManager<Zone extends DerivedPageZone>
extends hudson.model.ManagementLink
implements hudson.model.Saveable

Manages DerivedPageComponent configurations. TODO(nghia): Because DerivedPageZones have URLs based on their names, we need to make sure that names are different from one another otherwise some Zones will share URLs leading to undefined/undesirable behaviors. We need to add more UI validation code here.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DerivedPageManager(Class<Zone> type) Load an instance of DerivedPageManager from Jenkins configuration from disk if the configuration file (by getConfigFile()) exists.

Method Summary

Methods

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doConfigSubmit(org.kohsuke.stapler.StaplerRequest req) Handles form submission.
protected abstract String	getConfigFileName() Return the filename in which to store the configuration serializing a (singleton) subclass instance.
List<Zone>	getDerivedPages()
String	getIconFileName()
Zone	getZone(String zoneName)
void	save()
protected void	setDerivedPages(List<Zone> zones)

Methods inherited from class hudson.model.ManagementLink

all, getDescription, getRequiredPermission, getRequiresConfirmation, getRequiresPOST, getUrlName

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

Constructor Detail

DerivedPageManager

public DerivedPageManager(Class<Zone> type)
                   throws IOException

Load an instance of DerivedPageManager from Jenkins configuration from disk if the configuration file (by getConfigFile()) exists. Otherwise create a new instance.

Throws:

IOException

Method Detail

save

public void save()
          throws IOException

Specified by:

save in interface hudson.model.Saveable

Throws:

IOException

getConfigFileName

protected abstract String getConfigFileName()

Return the filename in which to store the configuration serializing a (singleton) subclass instance.

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

Specified by:

getIconFileName in class hudson.model.ManagementLink

getDerivedPages

public List<Zone> getDerivedPages()

Returns:

the list of DerivedPageComponent configured.

getZone

@Nullable
public Zone getZone(String zoneName)

Parameters:

zoneName - the name of the Zone to look up.

Returns:

the Zone for the given name, null if none.

setDerivedPages

protected void setDerivedPages(List<Zone> zones)

doConfigSubmit

public org.kohsuke.stapler.HttpResponse doConfigSubmit(org.kohsuke.stapler.StaplerRequest req)
                                                throws javax.servlet.ServletException,
                                                       IOException

Handles form submission.

Parameters:

req - the request.

Returns:

the response.

Throws:

javax.servlet.ServletException - if something goes wrong.

IOException - if something goes wrong.