@Extension @Symbol(value="whoAmI") @ExportedBean public class WhoAmI extends Object implements UnprotectedRootAction
ExtensionPoint.LegacyInstancesAreScopedToHudson
Constructor and Description |
---|
WhoAmI() |
Modifier and Type | Method and Description |
---|---|
Api |
getApi() |
String[] |
getAuthorities() |
String |
getDetails() |
String |
getDisplayName()
Gets the string to be displayed.
|
String |
getIconFileName()
Gets the name of the icon.
|
String |
getName() |
String |
getToString() |
String |
getUrlName()
Gets the URL path name.
|
boolean |
isAnonymous() |
boolean |
isAuthenticated() |
boolean |
isHeaderDangerous(String name) |
public Api getApi()
@Exported public String getName()
@Exported public boolean isAuthenticated()
@Exported public boolean isAnonymous()
public String getDetails()
public String getToString()
@Exported public String[] getAuthorities()
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isHeaderDangerous(@NonNull String name)
public String getIconFileName()
Action
getIconFileName
in interface Action
If just a file name (like "abc.gif") is returned, it will be
interpreted as a file name inside /images/24x24
.
This is useful for using one of the stock images.
If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.
Finally, return null to hide it from the task list. This is normally not very useful,
but this can be used for actions that only contribute floatBox.jelly
and no task list item. The other case where this is useful is
to avoid showing links that require a privilege when the user is anonymous.
Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getDisplayName()
Action
getDisplayName
in interface Action
getDisplayName
in interface ModelObject
public String getUrlName()
Action
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.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
Copyright © 2004–2022. All rights reserved.