Package com.cloudbees.plugins.credentials

Class CredentialsSelectHelper.ContextResolver

java.lang.Object

com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

CredentialsSelectHelper.ItemContextResolver, CredentialsSelectHelper.SystemContextResolver, CredentialsSelectHelper.UserContextResolver

Enclosing class:

CredentialsSelectHelper

public abstract static class CredentialsSelectHelper.ContextResolver
extends Object
implements ExtensionPoint

An extension point to allow plugging in additional resolution of ModelObject instances.

Since:

2.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final CredentialsSelectHelper.ContextResolver	NONE	A CredentialsSelectHelper.ContextResolver that can be used as a marker.

Constructor Summary

Constructors

Constructor	Description
ContextResolver()

Method Summary

Modifier and Type	Method	Description
static String	displayName(CredentialsSelectHelper.ContextResolver resolver)	Returns a human readable description of the type of context objects that the specified resolver resolves.
abstract ModelObject	getContext(String token)	Maps a token from getToken(ModelObject) back to its original ModelObject.
abstract String	getDisplayName()	Returns a human readable description of the type of context objects that this resolver resolves.
abstract 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 java.lang.Object

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

Field Details

NONE

public static final CredentialsSelectHelper.ContextResolver NONE

A CredentialsSelectHelper.ContextResolver that can be used as a marker.

Since:

2.1.1

Constructor Details

ContextResolver

public ContextResolver()

Method Details

getToken

@CheckForNull
public abstract String getToken(ModelObject context)

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

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

@CheckForNull
public abstract ModelObject getContext(String token)

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

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 abstract String getDisplayName()

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

Returns:

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

Throws:

AbstractMethodError - if somebody compiled against pre-2.1.1 implementations. Use displayName(CredentialsSelectHelper.ContextResolver) if you would prefer not to have to catch them.

Since:

2.1.1

displayName

public static String displayName(CredentialsSelectHelper.ContextResolver resolver)

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

Parameters:

resolver - the context resolver to get the display name of.

Returns:

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

Since:

2.1.1