hudson.security

Class WhoAmI

java.lang.Object

hudson.security.WhoAmI

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction, UnprotectedRootAction

@Extension
 @Symbol(value="whoAmI")
 @ExportedBean
public class WhoAmI
extends Object
implements UnprotectedRootAction

Expose the data needed for /whoAmI, so it can be exposed by Api.

Author:

Ryan Campbell

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
WhoAmI()

Method Summary

Modifier and Type	Method and Description
Api	getApi()
String[]	getAuthorities()
String	getDetails()
String	getDisplayName() Gets the string to be displayed.
String	getIconFileName() Gets the file name of the icon.
String	getName()
String	getToString()
String	getUrlName() Gets the URL path name.
boolean	isAnonymous()
boolean	isAuthenticated()
boolean	isHeaderDangerous(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

WhoAmI

public WhoAmI()

Method Detail

getApi

public Api getApi()

getName

@Exported
public String getName()

isAuthenticated

@Exported
public boolean isAuthenticated()

isAnonymous

@Exported
public boolean isAnonymous()

getDetails

public String getDetails()

getToString

public String getToString()

getAuthorities

@Exported
public String[] getAuthorities()

isHeaderDangerous

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isHeaderDangerous(@NonNull
                                                                                                        String name)

getIconFileName

public String getIconFileName()

Description copied from interface: Action

Gets the file name of the icon.

Specified by:

getIconFileName in interface Action

Returns:

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.

See Also:

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".

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Returns:

Can be null in case the action is hidden.

getUrlName

public String getUrlName()

Description copied from interface: Action

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.

Specified by:

getUrlName in interface Action

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)