org.jenkinsci.plugins

Class KeycloakSecurityRealm.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.security.SecurityRealm>

org.jenkinsci.plugins.KeycloakSecurityRealm.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

KeycloakSecurityRealm

@Extension
public static class KeycloakSecurityRealm.DescriptorImpl
extends hudson.model.Descriptor<hudson.security.SecurityRealm>

Descriptor definition for Jenkins

Author:

dev.lauer@elnarion.de

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl() Constructor

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckKeycloakJson(String value) Validate keycloakJson
String	getDisplayName()
String	getHelpFile()
String	getKeycloakJson() Returns the keycloak configuration
boolean	isKeycloakRespectAccessTokenTimeout() Returns the configuration parameter for the access token check
boolean	isKeycloakValidate() Returns the configuration parameter for the authentication check on each request
hudson.security.SecurityRealm	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
void	setKeycloakJson(String keycloakJson) Sets the keycloak json configuration string
void	setKeycloakRespectAccessTokenTimeout(boolean keycloakRespectAccessTokenTimeout) Sets the configuration parameter for the access token check
void	setKeycloakValidate(boolean keycloakValidate) Sets the configuration parameter for the authentication check

Methods inherited from class hudson.model.Descriptor

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Constructor

Method Detail

getHelpFile

public String getHelpFile()

Overrides:

getHelpFile in class hudson.model.Descriptor<hudson.security.SecurityRealm>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.security.SecurityRealm>

doCheckKeycloakJson

public hudson.util.FormValidation doCheckKeycloakJson(@QueryParameter
                                                      String value)
                                               throws javax.servlet.ServletException

Validate keycloakJson

Parameters:

value - String the form field value to validate

Returns:

FormValidation the validation result

Throws:

javax.servlet.ServletException

configure

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

Overrides:

configure in class hudson.model.Descriptor<hudson.security.SecurityRealm>

Throws:

hudson.model.Descriptor.FormException

getKeycloakJson

public String getKeycloakJson()

Returns the keycloak configuration

Returns:

String the configuration string

setKeycloakJson

public void setKeycloakJson(String keycloakJson)

Sets the keycloak json configuration string

Parameters:

keycloakJson - the configuration

newInstance

public hudson.security.SecurityRealm newInstance(org.kohsuke.stapler.StaplerRequest req,
                                                 net.sf.json.JSONObject formData)
                                          throws hudson.model.Descriptor.FormException

Overrides:

newInstance in class hudson.model.Descriptor<hudson.security.SecurityRealm>

Throws:

hudson.model.Descriptor.FormException

isKeycloakValidate

public boolean isKeycloakValidate()

Returns the configuration parameter for the authentication check on each request

Returns:

Boolean if true, authentication is checked on each request

setKeycloakValidate

public void setKeycloakValidate(boolean keycloakValidate)

Sets the configuration parameter for the authentication check

Parameters:

keycloakValidate - Boolean if true authentication is checked on each request

isKeycloakRespectAccessTokenTimeout

public boolean isKeycloakRespectAccessTokenTimeout()

Returns the configuration parameter for the access token check

Returns:

Boolean whether the expiration of the access token should be checked or not before a token refresh

setKeycloakRespectAccessTokenTimeout

public void setKeycloakRespectAccessTokenTimeout(boolean keycloakRespectAccessTokenTimeout)

Sets the configuration parameter for the access token check

Parameters:

keycloakRespectAccessTokenTimeout - Boolean whether the expiration of the access token should be checked or not before a token refresh