Package jenkins.security

Class ResourceDomainRecommendation

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.AdministrativeMonitor

jenkins.security.ResourceDomainRecommendation

All Implemented Interfaces:

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

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

Recommend use of ResourceDomainConfiguration to users with the system property hudson.model.DirectoryBrowserSupport.CSP set to override DirectoryBrowserSupport.DEFAULT_CSP_VALUE.

Since:

2.200

See Also:

• ResourceDomainConfiguration

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
ResourceDomainRecommendation()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doAct(String redirect, String dismiss)
String	getDisplayName()
Permission	getRequiredPermission()	Required permission to view this admin monitor.
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

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceDomainRecommendation

public ResourceDomainRecommendation()

Method Details

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class AdministrativeMonitor

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

doAct

public org.kohsuke.stapler.HttpResponse doAct(@QueryParameter
 String redirect,
 @QueryParameter
 String dismiss)
                                       throws IOException

Throws:

IOException

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(StaplerRequest, StaplerResponse) 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

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