hudson.model

Class User.CanonicalIdResolver

java.lang.Object

hudson.model.AbstractDescribableImpl<User.CanonicalIdResolver>

hudson.model.User.CanonicalIdResolver

All Implemented Interfaces:

ExtensionPoint, Describable<User.CanonicalIdResolver>, Comparable<User.CanonicalIdResolver>

Direct Known Subclasses:

DefaultUserCanonicalIdResolver, User.FullNameIdResolver, User.UserIDCanonicalIdResolver

Enclosing class:

User

public abstract static class User.CanonicalIdResolver
extends AbstractDescribableImpl<User.CanonicalIdResolver>
implements ExtensionPoint, Comparable<User.CanonicalIdResolver>

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	REALM context key for realm (domain) where idOrFullName has been retreived from.

Constructor Summary

Constructors

Constructor and Description
CanonicalIdResolver()

Method Summary

Modifier and Type	Method and Description
int	compareTo(User.CanonicalIdResolver o)
int	getPriority()
abstract String	resolveCanonicalId(String idOrFullName, Map<String,?> context) extract user ID from idOrFullName with help from contextual infos.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

REALM

public static final String REALM

context key for realm (domain) where idOrFullName has been retreived from. Can be used (for example) to distinguish ambiguous committer ID using the SCM URL. Associated Value is a String

See Also:

Constant Field Values

Constructor Detail

CanonicalIdResolver

public CanonicalIdResolver()

Method Detail

compareTo

public int compareTo(User.CanonicalIdResolver o)

Specified by:

compareTo in interface Comparable<User.CanonicalIdResolver>

resolveCanonicalId

@CheckForNull
public abstract String resolveCanonicalId(String idOrFullName,
                                                        Map<String,?> context)

extract user ID from idOrFullName with help from contextual infos. can return null if no user ID matched the input

getPriority

public int getPriority()