Package jenkins.model

Class DefaultUserCanonicalIdResolver

java.lang.Object

hudson.model.AbstractDescribableImpl<User.CanonicalIdResolver>

hudson.model.User.CanonicalIdResolver

jenkins.model.DefaultUserCanonicalIdResolver

All Implemented Interfaces:

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

@Extension
public class DefaultUserCanonicalIdResolver
extends User.CanonicalIdResolver

Default User.CanonicalIdResolver to escape unsupported characters and generate user ID. Compared to other implementations, this resolver will always return an ID

Author:

Nicolas De Loof

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static Descriptor<User.CanonicalIdResolver>	DESCRIPTOR

Fields inherited from class hudson.model.User.CanonicalIdResolver

REALM

Constructor Summary

Constructors

Constructor	Description
DefaultUserCanonicalIdResolver()

Method Summary

Modifier and Type	Method	Description
Descriptor<User.CanonicalIdResolver>	getDescriptor()	By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.
int	getPriority()	Gets priority of the resolver.
String	resolveCanonicalId(String idOrFullName, Map<String,?> context)	extract user ID from idOrFullName with help from contextual infos.

Methods inherited from class hudson.model.User.CanonicalIdResolver

all, compareTo, resolve

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

public static final Descriptor<User.CanonicalIdResolver> DESCRIPTOR

Constructor Detail

DefaultUserCanonicalIdResolver

public DefaultUserCanonicalIdResolver()

Method Detail

resolveCanonicalId

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

Description copied from class: User.CanonicalIdResolver

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

Specified by:

resolveCanonicalId in class User.CanonicalIdResolver

getPriority

public int getPriority()

Description copied from class: User.CanonicalIdResolver

Gets priority of the resolver. Higher priority means that it will be checked earlier.

Overriding methods must not use Integer.MIN_VALUE, because it will cause collisions with DefaultUserCanonicalIdResolver.

Overrides:

getPriority in class User.CanonicalIdResolver

Returns:

Priority of the resolver.

getDescriptor

public Descriptor<User.CanonicalIdResolver> getDescriptor()

Description copied from class: AbstractDescribableImpl

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<User.CanonicalIdResolver>

Overrides:

getDescriptor in class AbstractDescribableImpl<User.CanonicalIdResolver>