Package io.jenkins.plugins.oidc_provider

Class Issuer

java.lang.Object

io.jenkins.plugins.oidc_provider.Issuer

Direct Known Subclasses:

FolderIssuer, RootIssuer

public abstract class Issuer
extends Object

Representation of an issuer of tokens.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Issuer.Factory

Constructor Summary

Constructors

Constructor	Description
Issuer()

Method Summary

Modifier and Type	Method	Description
protected abstract void	checkExtendedReadPermission()	Check permision on the context() to enumerate credentials and get their metadata.
protected abstract ModelObject	context()	The associated object in Jenkins.
final Collection<? extends IdTokenCredentials>	credentials()	Load credentials from this issuer.
String	toString()
protected abstract String	uri()	URI suffix after https://jenkins/oidc.
final String	url()	Absolute URL of issuer.

Methods inherited from class java.lang.Object

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

Constructor Details

Issuer

public Issuer()

Method Details

context

@NonNull
protected abstract ModelObject context()

The associated object in Jenkins.

credentials

@NonNull
public final Collection<? extends IdTokenCredentials> credentials()

Load credentials from this issuer. Only credentials defined here will be returned—no inherited credentials, unlike CredentialsProvider.lookupStores(hudson.model.ModelObject) or CredentialsProvider.lookupCredentialsInItemGroup(Class, ItemGroup, Authentication, List).

Returns:

a possibly empty set of credentials

uri

@NonNull
protected abstract String uri()

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

Returns:

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

See Also:

• Marker interface for things with URL

url

public final String url()

Absolute URL of issuer.

Returns:

e.g. https://jenkins/oidc/path/subpath

checkExtendedReadPermission

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

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

Throws:

org.springframework.security.access.AccessDeniedException

toString

public String toString()

Overrides:

toString in class Object