Package jenkins.security

Class UpdateSiteWarningsMonitor

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.AdministrativeMonitor

jenkins.security.UpdateSiteWarningsMonitor

All Implemented Interfaces:

ExtensionPoint, ModelObject, SearchableModelObject, SearchItem, org.kohsuke.stapler.StaplerProxy

@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class UpdateSiteWarningsMonitor
extends AdministrativeMonitor

Administrative monitor showing plugin/core warnings published by the configured update site to the user.

Terminology overview:

• Applicable warnings are those relevant to currently installed components
• Active warnings are those actually shown to users.
• Hidden warnings are those _not_ shown to users due to them being configured to be hidden.
• Inapplicable warnings are those that are not applicable.

The following sets may be non-empty:

• Intersection of applicable and active
• Intersection of applicable and hidden
• Intersection of hidden and inapplicable (although not really relevant)
• Intersection of inapplicable and neither hidden nor active

The following sets must necessarily be empty:

• Intersection of applicable and inapplicable
• Intersection of active and hidden
• Intersection of active and inapplicable

Since:

2.40

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.AdministrativeMonitor

id

Constructor Summary

Constructors

Constructor	Description
UpdateSiteWarningsMonitor()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doForward(String fix, String configure)	Redirects the user to the plugin manager or security configuration
List<UpdateSite.Warning>	getActiveCoreWarnings()
Map<PluginWrapper,List<UpdateSite.Warning>>	getActivePluginWarningsByPlugin()
String	getDisplayName()
Permission	getRequiredPermission()	Required permission to view this admin monitor.
boolean	hasApplicableHiddenWarnings()	Returns true iff there are applicable but ignored (i.e.
boolean	isActivated()	Returns true if this monitor is activated and wants to produce a warning message.
boolean	isSecurity()	Returns true if this monitor is security related.

Methods inherited from class hudson.model.AdministrativeMonitor

all, checkRequiredPermission, disable, doDisable, getSearchUrl, getTarget, getUrl, hasPermissionToDisplay, hasRequiredPermission, isEnabled

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateSiteWarningsMonitor

public UpdateSiteWarningsMonitor()

Method Details

isActivated

public boolean isActivated()

Description copied from class: AdministrativeMonitor

Returns true if this monitor is activated and wants to produce a warning message.

This method is called from the HTML rendering thread, so it should run efficiently.

Specified by:

isActivated in class AdministrativeMonitor

isSecurity

public boolean isSecurity()

Description copied from class: AdministrativeMonitor

Returns true if this monitor is security related. This will be used to determine which icon will be used in the navigation bar.

Overrides:

isSecurity in class AdministrativeMonitor

getActiveCoreWarnings

public List<UpdateSite.Warning> getActiveCoreWarnings()

getActivePluginWarningsByPlugin

public Map<PluginWrapper,List<UpdateSite.Warning>> getActivePluginWarningsByPlugin()

doForward

public org.kohsuke.stapler.HttpResponse doForward(@QueryParameter
 String fix,
 @QueryParameter
 String configure)

Redirects the user to the plugin manager or security configuration

hasApplicableHiddenWarnings

public boolean hasApplicableHiddenWarnings()

Returns true iff there are applicable but ignored (i.e. hidden) warnings.

Returns:

true iff there are applicable but ignored (i.e. hidden) warnings.

getRequiredPermission

public Permission getRequiredPermission()

Description copied from class: AdministrativeMonitor

Required permission to view this admin monitor. By default Jenkins.ADMINISTER, but Jenkins.SYSTEM_READ or Jenkins.MANAGE are also supported.

Changing this permission check to return Jenkins.SYSTEM_READ will make the active administrative monitor appear on manage.jelly and on the globally visible AdministrativeMonitorsDecorator to users without Administer permission. AdministrativeMonitor.doDisable(StaplerRequest2, StaplerResponse2) will still always require Administer permission.

This method only allows for a single permission to be returned. If more complex permission checks are required, override AdministrativeMonitor.checkRequiredPermission() and AdministrativeMonitor.hasRequiredPermission() instead.

Implementers need to ensure that doAct and other web methods perform necessary permission checks: Users with System Read permissions are expected to be limited to read-only access. Form UI elements that change system state, e.g. toggling a feature on or off, need to be hidden from users lacking Administer permission.

Overrides:

getRequiredPermission in class AdministrativeMonitor

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class AdministrativeMonitor