Package com.cloudbees.plugins.credentials

Class CredentialsSelectHelper.UserContextResolver

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver

com.cloudbees.plugins.credentials.CredentialsSelectHelper.UserContextResolver

All Implemented Interfaces:

ExtensionPoint

Enclosing class:

CredentialsSelectHelper

@Extension
public static class CredentialsSelectHelper.UserContextResolver
extends CredentialsSelectHelper.ContextResolver

A CredentialsSelectHelper.ContextResolver for User instances.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver

NONE

Constructor Summary

Constructors

Constructor	Description
UserContextResolver()

Method Summary

Modifier and Type	Method	Description
ModelObject	getContext(String token)	Maps a token from CredentialsSelectHelper.ContextResolver.getToken(ModelObject) back to its original ModelObject.
String	getDisplayName()	Returns a human readable description of the type of context objects that this resolver resolves.
String	getToken(ModelObject context)	Maps a context object (a ModelObject) into a token that can be used to recover the context.

Methods inherited from class com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver

displayName

Methods inherited from class java.lang.Object

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

Constructor Details

UserContextResolver

public UserContextResolver()

Method Details

getToken

public String getToken(ModelObject context)

Maps a context object (a ModelObject) into a token that can be used to recover the context.

Specified by:

getToken in class CredentialsSelectHelper.ContextResolver

Parameters:

context - the ModelObject.

Returns:

a token if this CredentialsSelectHelper.ContextResolver can recover the object or null if the ModelObject type is not supported by this CredentialsSelectHelper.ContextResolver.

getContext

public ModelObject getContext(String token)

Maps a token from CredentialsSelectHelper.ContextResolver.getToken(ModelObject) back to its original ModelObject.

Specified by:

getContext in class CredentialsSelectHelper.ContextResolver

Parameters:

token - the token.

Returns:

the corresponding ModelObject or null if the object no longer exists or if the user does not have permission to access that object.

getDisplayName

@NonNull
public String getDisplayName()

Returns a human readable description of the type of context objects that this resolver resolves.

Specified by:

getDisplayName in class CredentialsSelectHelper.ContextResolver

Returns:

a human readable description of the type of context objects that this resolver resolves.