org.jenkinsci.plugins.securityinspector.impl.users

Class UserReportBuilder

java.lang.Object

org.jenkinsci.plugins.securityinspector.model.ReportBuilder

org.jenkinsci.plugins.securityinspector.impl.users.UserReportBuilder

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

PermissionsForComputerReportBuilder, PermissionsForItemReportBuilder

public abstract class UserReportBuilder
extends ReportBuilder

Base class for building reports for particular users.

Author:

Oleg Nenashev

Nested Class Summary

Nested classes/interfaces inherited from class org.jenkinsci.plugins.securityinspector.model.ReportBuilder

ReportBuilder.Type

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
UserReportBuilder()

Method Summary

Modifier and Type	Method and Description
List<com.cloudbees.hudson.plugins.folder.AbstractFolder>	getAllFolders()
Comparator<hudson.model.User>	getComparatorUser()
String	getDisplayName(hudson.model.TopLevelItem item)
String	getDisplayName(hudson.model.User user) Retrieves display name of a user.
Collection<hudson.model.User>	getPossibleUsers()
hudson.model.User	getRequestedUser() Get selected user from context
ReportBuilder.Type	getType()

Methods inherited from class org.jenkinsci.plugins.securityinspector.model.ReportBuilder

all, all, doFilterSubmit, doProcessReportAction, getDescription, getDisplayName, getIcon, getIndex, getReport, processParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

UserReportBuilder

public UserReportBuilder()

Method Detail

getType

public final ReportBuilder.Type getType()

Specified by:

getType in class ReportBuilder

getPossibleUsers

@Nonnull
public Collection<hudson.model.User> getPossibleUsers()

getAllFolders

public List<com.cloudbees.hudson.plugins.folder.AbstractFolder> getAllFolders()

getDisplayName

@Nonnull
public String getDisplayName(@CheckForNull
                                      hudson.model.TopLevelItem item)

getDisplayName

@Nonnull
public String getDisplayName(@CheckForNull
                                      hudson.model.User user)

Retrieves display name of a user.

Parameters:

user - User

Returns:

User full name. Empty string if the user is null.

getComparatorUser

@Nonnull
public Comparator<hudson.model.User> getComparatorUser()

getRequestedUser

@Nonnull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public hudson.model.User getRequestedUser()
                                                                                                                    throws org.kohsuke.stapler.HttpResponses.HttpResponseException

Get selected user from context

Returns:

user if exists. Otherwise an error will be returned

Throws:

org.kohsuke.stapler.HttpResponses.HttpResponseException