Package io.jenkins.plugins.ompass

Class OmpassGlobalConfig

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.ompass.OmpassGlobalConfig

All Implemented Interfaces:

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

@Extension
@Symbol("ompass-2fa")
public class OmpassGlobalConfig
extends GlobalConfiguration

Global configuration for the OMPASS 2FA plugin. Stores the OMPASS server URL, client credentials, and 2FA enabled state. Shown on the Manage Jenkins > Security page.

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
OmpassGlobalConfig()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)
FormValidation	doCheckClientId(String value)
FormValidation	doCheckOmpassServerUrl(String value)
FormValidation	doCheckSecretKey(String value)
ListBoxModel	doFillLanguageItems()
FormValidation	doTestConnection(String ompassServerUrl, String clientId, String secretKey)
static OmpassGlobalConfig	get()	Returns the singleton instance of this configuration.
GlobalConfigurationCategory	getCategory()
String	getClientId()
String	getLanguage()
String	getOmpassServerUrl()
Secret	getSecretKey()
boolean	isEnableOmpass2fa()
void	setClientId(String clientId)
void	setEnableOmpass2fa(boolean enableOmpass2fa)
void	setLanguage(String language)
void	setOmpassServerUrl(String ompassServerUrl)
void	setSecretKey(Secret secretKey)

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, 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 java.lang.Object

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

Constructor Details

OmpassGlobalConfig

@DataBoundConstructor
public OmpassGlobalConfig()

Method Details

get

public static OmpassGlobalConfig get()

Returns the singleton instance of this configuration.

Returns:

the global OMPASS configuration object, or null if not available

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory 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

getOmpassServerUrl

public String getOmpassServerUrl()

getClientId

public String getClientId()

getSecretKey

public Secret getSecretKey()

isEnableOmpass2fa

public boolean isEnableOmpass2fa()

getLanguage

public String getLanguage()

setOmpassServerUrl

@DataBoundSetter
public void setOmpassServerUrl(String ompassServerUrl)

setClientId

@DataBoundSetter
public void setClientId(String clientId)

setSecretKey

@DataBoundSetter
public void setSecretKey(Secret secretKey)

setEnableOmpass2fa

@DataBoundSetter
public void setEnableOmpass2fa(boolean enableOmpass2fa)

setLanguage

@DataBoundSetter
public void setLanguage(String language)

doFillLanguageItems

public ListBoxModel doFillLanguageItems()

doCheckOmpassServerUrl

@POST
public FormValidation doCheckOmpassServerUrl(@QueryParameter
 String value)

doCheckClientId

@POST
public FormValidation doCheckClientId(@QueryParameter
 String value)

doCheckSecretKey

@POST
public FormValidation doCheckSecretKey(@QueryParameter
 String value)

doTestConnection

@POST
public FormValidation doTestConnection(@QueryParameter
 String ompassServerUrl,
 @QueryParameter
 String clientId,
 @QueryParameter
 String secretKey)