Package 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>
Resolves User IDs by ID, full names or other strings.

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).

Since:
1.479
See Also:

  • Field Details

    • REALM

      public static final String REALM
      context key for realm (domain) where idOrFullName has been retrieved from. Can be used (for example) to distinguish ambiguous committer ID using the SCM URL. Associated Value is a String
      See Also:

  • Constructor Details

    • CanonicalIdResolver

      public CanonicalIdResolver()

  • Method Details

    • compareTo

      public int compareTo(@NonNull 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()
      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.

      Returns:
      Priority of the resolver.

    • all

      public static List<User.CanonicalIdResolver> all()
      Gets all extension points, sorted by priority.
      Returns:
      Sorted list of extension point implementations.
      Since:
      2.93

    • resolve

      @CheckForNull public static String resolve(@NonNull String idOrFullName, @NonNull Map<String,?> context)
      Resolves users using all available User.CanonicalIdResolvers.
      Parameters:
      idOrFullName - ID or full name of the user
      context - Context
      Returns:
      Resolved User ID or null if the user ID cannot be resolved.
      Since:
      2.93