public abstract static class User.CanonicalIdResolver extends AbstractDescribableImpl<User.CanonicalIdResolver> implements ExtensionPoint, Comparable<User.CanonicalIdResolver>
This extension point may be useful to map SCM user names to Jenkins User
IDs.
Currently the extension point is used in User.get(String, boolean, Map)
.
DefaultUserCanonicalIdResolver
,
User.FullNameIdResolver
ExtensionPoint.LegacyInstancesAreScopedToHudson
Modifier and Type | Field and Description |
---|---|
static String |
REALM
context key for realm (domain) where idOrFullName has been retrieved from.
|
Constructor and Description |
---|
CanonicalIdResolver() |
Modifier and Type | Method and Description |
---|---|
static List<User.CanonicalIdResolver> |
all()
Gets all extension points, sorted by priority.
|
int |
compareTo(User.CanonicalIdResolver o) |
int |
getPriority()
Gets priority of the resolver.
|
static String |
resolve(String idOrFullName,
Map<String,?> context)
Resolves users using all available
User.CanonicalIdResolver s. |
abstract String |
resolveCanonicalId(String idOrFullName,
Map<String,?> context)
extract user ID from idOrFullName with help from contextual infos.
|
getDescriptor
public static final String REALM
String
public int compareTo(@NonNull User.CanonicalIdResolver o)
compareTo
in interface Comparable<User.CanonicalIdResolver>
@CheckForNull public abstract String resolveCanonicalId(String idOrFullName, Map<String,?> context)
null
if no user ID matched the inputpublic int getPriority()
Overriding methods must not use Integer.MIN_VALUE
, because it will cause collisions
with DefaultUserCanonicalIdResolver
.
public static List<User.CanonicalIdResolver> all()
@CheckForNull public static String resolve(@NonNull String idOrFullName, @NonNull Map<String,?> context)
User.CanonicalIdResolver
s.idOrFullName
- ID or full name of the usercontext
- Contextnull
if the user ID cannot be resolved.Copyright © 2004–2021. All rights reserved.