jenkins.management

Class ConfigureLink

java.lang.Object

hudson.model.ManagementLink

jenkins.management.ConfigureLink

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject

@Extension(ordinal=2.147483447E9)
 @Symbol(value="configure")
public class ConfigureLink
extends ManagementLink

Author:

Nicolas De Loof

Nested Class Summary

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

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Constructor Summary

Constructors

Constructor and Description
ConfigureLink()

Method Summary

Modifier and Type	Method and Description
ManagementLink.Category	getCategory() Category for management link, uses String so it can be done with core dependency pre-dating the version this feature was added.
String	getDescription() Returns a short description of what this link does.
String	getDisplayName() Gets the string to be displayed.
String	getIconFileName() Mostly works like Action.getIconFileName(), except that the expected icon format is SVG.
Permission	getRequiredPermission() Returns the permission required for user to see this management link on the "Manage Jenkins" page (ManageJenkinsAction).
String	getUrlName() Gets the URL path name.

Methods inherited from class hudson.model.ManagementLink

all, getCategoryName, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigureLink

public ConfigureLink()

Method Detail

getIconFileName

public String getIconFileName()

Description copied from class: ManagementLink

Mostly works like Action.getIconFileName(), except that the expected icon format is SVG. So if you give just a file name, "/images/svgs" will be assumed.

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

Returns:

As a special case, return null to exclude this object from the management link. This is useful for defining ManagementLink that only shows up under certain circumstances.

See Also:

Jenkins Symbols, Functions.isAnonymous(), Functions.getIconFilePath(Action)

getDisplayName

public String getDisplayName()

Description copied from interface: Action

Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".

Returns:

Can be null in case the action is hidden.

getDescription

public String getDescription()

Description copied from class: ManagementLink

Returns a short description of what this link does. This text is the one that's displayed in grey. This can include HTML, although the use of block tags is highly discouraged. Optional.

Overrides:

getDescription in class ManagementLink

getRequiredPermission

@NonNull
public Permission getRequiredPermission()

Description copied from class: ManagementLink

Returns the permission required for user to see this management link on the "Manage Jenkins" page (ManageJenkinsAction). Historically, this returned null, which amounted to the same behavior, as Jenkins.ADMINISTER was required to access the page.

Overrides:

getRequiredPermission in class ManagementLink

Returns:

the permission required for the link to be shown on "Manage Jenkins".

getUrlName

public String getUrlName()

Description copied from class: ManagementLink

Gets the URL path name.

For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

This method should return a string that's unique among other Actions.

The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

In case of ManagementLink, this value is put straight into the href attribute, so relative paths are interpreted against the root Jenkins object.

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

Returns:

null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().

See Also:

Functions.getActionUrl(String, Action)

getCategory

@NonNull
public ManagementLink.Category getCategory()

Description copied from class: ManagementLink

Category for management link, uses String so it can be done with core dependency pre-dating the version this feature was added.

Overrides:

getCategory in class ManagementLink

Returns:

An enum value of ManagementLink.Category.