Package com.cloudbees.jenkins.support.impl

Class AboutUser

java.lang.Object

com.cloudbees.jenkins.support.api.Component

com.cloudbees.jenkins.support.impl.AboutUser

All Implemented Interfaces:

ExtensionPoint

@Extension
public class AboutUser
extends Component

Basic information about the user's authentication.

Author:

Stephen Connolly

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.jenkins.support.api.Component

Component.ComponentCategory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AboutUser()

Method Summary

Modifier and Type	Method	Description
void	addContents(Container result)	Add contents to a container
Component.ComponentCategory	getCategory()	Specify in which Component.ComponentCategory the current component is related.
String	getDisplayName()
Set<Permission>	getRequiredPermissions()	Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

Methods inherited from class com.cloudbees.jenkins.support.api.Component

getDisplayPermissions, getId, isApplicable, isEnabled, isSelectedByDefault, start

Methods inherited from class java.lang.Object

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

Constructor Detail

AboutUser

public AboutUser()

Method Detail

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in class Component

getRequiredPermissions

public Set<Permission> getRequiredPermissions()

Description copied from class: Component

Returns the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle. An empty list indicates that any user can include this bundle.

Specified by:

getRequiredPermissions in class Component

Returns:

the (possibly empty, never null) list of permissions that are required for the user to include this in a bundle.

addContents

public void addContents(@NonNull
                        Container result)

Description copied from class: Component

Add contents to a container

Specified by:

addContents in class Component

Parameters:

result - a Container

getCategory

@NonNull
public Component.ComponentCategory getCategory()

Description copied from class: Component

Specify in which Component.ComponentCategory the current component is related.

Overrides:

getCategory in class Component

Returns:

An enum value of Component.ComponentCategory.