Package com.google.jenkins.plugins.credentials.oauth

Class OAuth2CapabilityScopeResolver

java.lang.Object

com.google.jenkins.plugins.credentials.oauth.OAuth2CapabilityScopeResolver

All Implemented Interfaces:

ExtensionPoint

public abstract class OAuth2CapabilityScopeResolver
extends Object
implements ExtensionPoint

Resolves a set of OAuth2ScopeCapability into a concrete, provider-specific OAuth2ScopeRequirement populated with that provider's scope strings.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
OAuth2CapabilityScopeResolver()

Method Summary

Modifier and Type	Method	Description
abstract boolean	isApplicable(Class<? extends OAuth2Credentials<?>> credentialsType)	Whether this resolver knows how to handle the given credentials type.
static OAuth2ScopeRequirement	resolve(Class<? extends OAuth2Credentials<?>> credentialsType, Collection<OAuth2ScopeCapability> capabilities)	Finds the applicable resolver for a credentials type and resolves it.
abstract OAuth2ScopeRequirement	resolveRequirement(Collection<OAuth2ScopeCapability> capabilities)	Resolves the given capabilities into a requirement object for this provider.

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2CapabilityScopeResolver

public OAuth2CapabilityScopeResolver()

Method Details

isApplicable

public abstract boolean isApplicable(@NonNull
 Class<? extends OAuth2Credentials<?>> credentialsType)

Whether this resolver knows how to handle the given credentials type.

resolveRequirement

@CheckForNull
public abstract OAuth2ScopeRequirement resolveRequirement(@NonNull
 Collection<OAuth2ScopeCapability> capabilities)

Resolves the given capabilities into a requirement object for this provider.

Returns:

the populated requirement, or null if this provider does not implement one or more of the requested capabilities

resolve

@CheckForNull
public static OAuth2ScopeRequirement resolve(@NonNull
 Class<? extends OAuth2Credentials<?>> credentialsType,
 @NonNull
 Collection<OAuth2ScopeCapability> capabilities)

Finds the applicable resolver for a credentials type and resolves it.

Returns:

the requirement, or null if no resolver is registered for the credentials type, or the applicable resolver couldn't satisfy the capabilities