Class JwtBearerTokenFilterConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.jwt.auth.filter.JwtBearerTokenFilterConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
@Symbol("jwtBearer")
public class JwtBearerTokenFilterConfiguration
extends GlobalConfiguration

Global configuration for JWT Bearer Token authentication plugin.

Nested Class Summary

Nested classes/interfaces inherited from class Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class Descriptor

clazz

Fields inherited from interface Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
JwtBearerTokenFilterConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	anyMatch(String requestURI)	Return if the request URI match any of the protected path patterns from any issuer
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)
FormValidation	doTestPath(String protectedPaths, String testPath)
GlobalConfigurationCategory	getCategory()
String	getDisplayName()
static JwtBearerTokenFilterConfiguration	getInstance()
List<Issuer>	getIssuers()
Issuer	getMatchingIssuer(String requestURI)	Returns the first issuer that matches the request URI path patterns.
void	setIssuers(List<Issuer> issuers)

Methods inherited from class GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class Object

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

Constructor Details

JwtBearerTokenFilterConfiguration

@DataBoundConstructor
public JwtBearerTokenFilterConfiguration()

Method Details

getInstance

public static JwtBearerTokenFilterConfiguration getInstance()

getDisplayName

@NonNull
public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<GlobalConfiguration>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException

getIssuers

public List<Issuer> getIssuers()

setIssuers

@DataBoundSetter
public void setIssuers(List<Issuer> issuers)

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

getMatchingIssuer

public Issuer getMatchingIssuer(String requestURI)

Returns the first issuer that matches the request URI path patterns.

Parameters:

requestURI - The request URI

Returns:

The matching issuer, or null if none matches

anyMatch

public boolean anyMatch(String requestURI)

Return if the request URI match any of the protected path patterns from any issuer

Parameters:

requestURI - The request URI

Returns:

True if the URI matches any protected path pattern, false otherwise

doTestPath

@POST
public FormValidation doTestPath(@QueryParameter
 String protectedPaths,
 @QueryParameter
 String testPath)