jenkins.management

Class AdministrativeMonitorsDecorator

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

jenkins.management.AdministrativeMonitorsDecorator

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, Saveable, OnMaster

@Extension
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class AdministrativeMonitorsDecorator
extends PageDecorator

Show a notification and popup for active administrative monitors on all pages.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.PageDecorator

ALL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
AdministrativeMonitorsDecorator()

Method Summary

Modifier and Type	Method and Description
Collection<AdministrativeMonitor>	getActiveAdministrativeMonitors()
int	getActiveAdministrativeMonitorsCount()
String	getDisplayName() Human readable name of this kind of configurable object.
boolean	shouldDisplay() Whether the administrative monitors notifier should be shown.

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministrativeMonitorsDecorator

public AdministrativeMonitorsDecorator()

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: Descriptor

Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.

Overrides:

getDisplayName in class Descriptor<PageDecorator>

getActiveAdministrativeMonitorsCount

public int getActiveAdministrativeMonitorsCount()

getActiveAdministrativeMonitors

public Collection<AdministrativeMonitor> getActiveAdministrativeMonitors()

shouldDisplay

public boolean shouldDisplay()
                      throws IOException,
                             javax.servlet.ServletException

Whether the administrative monitors notifier should be shown.

Returns:

true iff the administrative monitors notifier should be shown.

Throws:

IOException

javax.servlet.ServletException