public abstract class ManagementLink extends Object implements ExtensionPoint, Action
This is a place for exposing features that are only meant for system admins
(whereas features that are meant for Hudson users at large should probably
be added to Jenkins.getActions()
.)
To register a new instance, put Extension
on your implementation class.
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
static List<ManagementLink> |
LIST
|
Constructor and Description |
---|
ManagementLink() |
Modifier and Type | Method and Description |
---|---|
static ExtensionList<ManagementLink> |
all()
All regsitered instances.
|
String |
getDescription()
Returns a short description of what this link does.
|
abstract String |
getIconFileName()
Mostly works like
Action.getIconFileName() , except that
the expected icon size is 48x48, not 24x24. |
Permission |
getRequiredPermission() |
boolean |
getRequiresConfirmation()
Allows implementations to request that this link show a confirmation dialog, and use POST if confirmed.
|
abstract String |
getUrlName()
Gets the URL path name.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDisplayName
public static final List<ManagementLink> LIST
public abstract String getIconFileName()
Action.getIconFileName()
, except that
the expected icon size is 48x48, not 24x24. So if you give
just a file name, "/images/48x48" will be assumed.getIconFileName
in interface Action
ManagementLink
that only shows up under
certain circumstances.Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getDescription()
public abstract String getUrlName()
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 Action
s.
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.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
public boolean getRequiresConfirmation()
RequirePOST
public static ExtensionList<ManagementLink> all()
public Permission getRequiredPermission()
Jenkins.ADMINISTER
Copyright © 2016. All rights reserved.