Class PluginManagementLink
java.lang.Object
hudson.model.ManagementLink
org.jvnet.hudson.plugins.monitoring.PluginManagementLink
- All Implemented Interfaces:
ExtensionPoint
,Action
,ModelObject
ManagementLink
of the plugin to add a link in the "/manage" page.- Author:
- Emeric Vernat
-
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
-
Method Summary
Modifier and TypeMethodDescriptionName of the category for this management link.Returns a short description of what this link does.Gets the string to be displayed.Mostly works likeAction.getIconFileName()
, except that the expected icon size is 48x48, not 24x24.Methods inherited from class hudson.model.ManagementLink
all, getBadge, getCategory, getRequiresConfirmation, getRequiresPOST
-
Constructor Details
-
PluginManagementLink
public PluginManagementLink()
-
-
Method Details
-
getIconFileName
Mostly works likeAction.getIconFileName()
, except that the expected icon size is 48x48, not 24x24. So if you give just a file name, "/images/48x48" will be assumed.- Specified by:
getIconFileName
in interfaceAction
- Specified by:
getIconFileName
in classManagementLink
- 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.
-
getDescription
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 classManagementLink
-
getDisplayName
Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result". -
getRequiredPermission
- Overrides:
getRequiredPermission
in classManagementLink
-
getUrlName
- Specified by:
getUrlName
in interfaceAction
- Specified by:
getUrlName
in classManagementLink
-
getCategoryName
Name of the category for this management link. Exists so that plugins with core dependency pre-dating the version when this was introduced can define a category. TODO when the core version is >2.226 change this to overridegetCategory()
instead- Overrides:
getCategoryName
in classManagementLink
- Returns:
- name of the desired category, one of the enum values of Category, e.g.
STATUS
. - Since:
- 2.226
-