Package io.jenkins.plugins.oidc_provider

Class RootIssuer

java.lang.Object

io.jenkins.plugins.oidc_provider.Issuer

io.jenkins.plugins.oidc_provider.RootIssuer

All Implemented Interfaces:

ExtensionPoint, Issuer.Factory

@Extension
public final class RootIssuer
extends Issuer
implements Issuer.Factory

Issuer scoped to Jenkins root with global credentials.

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.oidc_provider.Issuer

Issuer.Factory

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
RootIssuer()

Method Summary

Modifier and Type	Method	Description
protected void	checkExtendedReadPermission()	Check permision on the Issuer.context() to enumerate credentials and get their metadata.
protected ModelObject	context()	The associated object in Jenkins.
Issuer	forConfig(org.kohsuke.stapler.StaplerRequest req)	Find an issuer potentially being configured from a certain screen.
Collection<? extends Issuer>	forContext(Run<?,?> context)	Find issuers which might be applicable to a given build.
Issuer	forUri(String prefix)	Find an issuer by URI suffix.
protected String	uri()	URI suffix after https://jenkins/oidc.

Methods inherited from class io.jenkins.plugins.oidc_provider.Issuer

credentials, toString, url

Methods inherited from class java.lang.Object

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

Constructor Detail

RootIssuer

public RootIssuer()

Method Detail

forUri

public Issuer forUri(String prefix)

Description copied from interface: Issuer.Factory

Find an issuer by URI suffix.

Specified by:

forUri in interface Issuer.Factory

Parameters:

prefix - a possible value of Issuer.uri()

Returns:

a corresponding issuer, if recognized

context

protected ModelObject context()

Description copied from class: Issuer

The associated object in Jenkins.

Specified by:

context in class Issuer

uri

protected String uri()

Description copied from class: Issuer

URI suffix after https://jenkins/oidc. Should match Item.getUrl() or similar methods when applied to Issuer.context(), except with an initial rather than a trailing slash (/).

Specified by:

uri in class Issuer

Returns:

the empty string, or e.g. /path/subpath

See Also:

Marker interface for things with URL

checkExtendedReadPermission

protected void checkExtendedReadPermission()
                                    throws org.springframework.security.access.AccessDeniedException

Description copied from class: Issuer

Check permision on the Issuer.context() to enumerate credentials and get their metadata.

Specified by:

checkExtendedReadPermission in class Issuer

Throws:

org.springframework.security.access.AccessDeniedException

forContext

public Collection<? extends Issuer> forContext(Run<?,?> context)

Description copied from interface: Issuer.Factory

Find issuers which might be applicable to a given build.

Specified by:

forContext in interface Issuer.Factory

Parameters:

context - a build context

Returns:

issuers handled by this factory which might apply to this build, most specific first (possibly empty)

forConfig

public Issuer forConfig(org.kohsuke.stapler.StaplerRequest req)

Description copied from interface: Issuer.Factory

Find an issuer potentially being configured from a certain screen.

Specified by:

forConfig in interface Issuer.Factory

Parameters:

req - form validation request in a credentials configuration screen

Returns:

a potential issuer for that location, if valid

See Also:

StaplerRequest.findAncestorObject(java.lang.Class<T>)