Package jenkins.security.apitoken

Class LegacyApiTokenAdministrativeMonitor

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.AdministrativeMonitor

jenkins.security.apitoken.LegacyApiTokenAdministrativeMonitor

All Implemented Interfaces:

ExtensionPoint, ModelObject, SearchableModelObject, SearchItem, org.kohsuke.stapler.StaplerProxy

@Extension
@Symbol("legacyApiTokenUsage")
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class LegacyApiTokenAdministrativeMonitor
extends AdministrativeMonitor

Monitor the list of users that still have legacy token

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LegacyApiTokenAdministrativeMonitor.RevokeAllSelectedModel
static final class	LegacyApiTokenAdministrativeMonitor.RevokeAllSelectedUserAndUuid

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.AdministrativeMonitor

id

Constructor Summary

Constructors

Constructor	Description
LegacyApiTokenAdministrativeMonitor()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doIndex()
org.kohsuke.stapler.HttpResponse	doRevokeAllSelected(LegacyApiTokenAdministrativeMonitor.RevokeAllSelectedModel content)
String	getDisplayName()
List<User>	getImpactedUserList()
ApiTokenProperty.TokenInfoAndStats	getLegacyStatsOf(User user, ApiTokenStore.HashedToken legacyToken)
ApiTokenStore.HashedToken	getLegacyTokenOf(User user)
boolean	hasFreshToken(User user, ApiTokenProperty.TokenInfoAndStats legacyStats)	Determine if the user has at least one "new" token that was created after the last use of the legacy token
boolean	hasMoreRecentlyUsedToken(User user, ApiTokenProperty.TokenInfoAndStats legacyStats)	Determine if the user has at least one "new" token that was used after the last use of the legacy token
boolean	isActivated()	Returns true if this monitor is activated and wants to produce a warning message.
boolean	isSecurity()	Returns true if this monitor is security related.

Methods inherited from class hudson.model.AdministrativeMonitor

all, checkRequiredPermission, disable, doDisable, getRequiredPermission, getSearchUrl, getTarget, getUrl, hasPermissionToDisplay, hasRequiredPermission, isEnabled

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.search.SearchItem

getSearchIcon

Constructor Details

LegacyApiTokenAdministrativeMonitor

public LegacyApiTokenAdministrativeMonitor()

Method Details

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class AdministrativeMonitor

isActivated

public boolean isActivated()

Description copied from class: AdministrativeMonitor

Returns true if this monitor is activated and wants to produce a warning message.

This method is called from the HTML rendering thread, so it should run efficiently.

Specified by:

isActivated in class AdministrativeMonitor

isSecurity

public boolean isSecurity()

Description copied from class: AdministrativeMonitor

Returns true if this monitor is security related. This will be used to determine which icon will be used in the navigation bar.

Overrides:

isSecurity in class AdministrativeMonitor

doIndex

public org.kohsuke.stapler.HttpResponse doIndex()
                                         throws IOException

Throws:

IOException

getImpactedUserList

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public List<User> getImpactedUserList()

getLegacyTokenOf

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nullable
public ApiTokenStore.HashedToken getLegacyTokenOf(@NonNull
 User user)

getLegacyStatsOf

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Nullable
public ApiTokenProperty.TokenInfoAndStats getLegacyStatsOf(@NonNull
 User user,
 ApiTokenStore.HashedToken legacyToken)

hasFreshToken

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean hasFreshToken(@NonNull
 User user,
 ApiTokenProperty.TokenInfoAndStats legacyStats)

Determine if the user has at least one "new" token that was created after the last use of the legacy token

hasMoreRecentlyUsedToken

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean hasMoreRecentlyUsedToken(@NonNull
 User user,
 ApiTokenProperty.TokenInfoAndStats legacyStats)

Determine if the user has at least one "new" token that was used after the last use of the legacy token

doRevokeAllSelected

public org.kohsuke.stapler.HttpResponse doRevokeAllSelected(@JsonBody
 LegacyApiTokenAdministrativeMonitor.RevokeAllSelectedModel content)
                                                     throws IOException

Throws:

IOException