org.jenkinsci.plugins.authorizeproject.strategy

Class SpecificUsersAuthorizationStrategy.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<AuthorizeProjectStrategy>

org.jenkinsci.plugins.authorizeproject.AuthorizeProjectStrategyDescriptor

org.jenkinsci.plugins.authorizeproject.strategy.SpecificUsersAuthorizationStrategy.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

SpecificUsersAuthorizationStrategy

@Extension
public static class SpecificUsersAuthorizationStrategy.DescriptorImpl
extends AuthorizeProjectStrategyDescriptor

Our descriptor.

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
SpecificUsersAuthorizationStrategy.DescriptorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	calcCheckPasswordRequestedUrl() Helper method for computing the check password URL.
hudson.util.FormValidation	doCheckDontRestrictJobConfiguration(boolean dontRestrictJobConfiguration) Display warnings for dontRestrictJobConfiguration "Don't restrict job configuration" can cause security issues when used with inappropriate access controls, and display for a waning message for that.
hudson.util.FormValidation	doCheckPassword(org.kohsuke.stapler.StaplerRequest req, String userid, String password, String apitoken, boolean useApitoken) Checks the supplied password.
String	doCheckPasswordRequested(org.kohsuke.stapler.StaplerRequest req, String userid) Checks password field is required in configuration page.
hudson.util.FormValidation	doCheckUserid(String userid) Checks the userid against the blacklist of invalid users.
String	getDisplayName()
boolean	isEnabledByDefault() SpecificUsersAuthorizationStrategy should be disabled by default for JENKINS-28298
boolean	isUseApitoken() Checks if the current SecurityRealm supports username/password authentication.

Methods inherited from class org.jenkinsci.plugins.authorizeproject.AuthorizeProjectStrategyDescriptor

configureFromGlobalSecurity, getConfigFile, getDescriptorsForGlobalSecurityConfigPage, getGlobalSecurityConfigPage, isApplicableToGlobal

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, 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

SpecificUsersAuthorizationStrategy.DescriptorImpl

public SpecificUsersAuthorizationStrategy.DescriptorImpl()

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<AuthorizeProjectStrategy>

calcCheckPasswordRequestedUrl

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String calcCheckPasswordRequestedUrl()

Helper method for computing the check password URL.

Returns:

the URL to check password field is required.

doCheckPasswordRequested

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String doCheckPasswordRequested(org.kohsuke.stapler.StaplerRequest req,
                                                                                            @QueryParameter
                                                                                            String userid)

Checks password field is required in configuration page. This is called asynchronously.

Parameters:

req - the request.

userid - the userid.

Returns:

"true" if password fiels is required. this should be evaluated as JavaScript.

doCheckUserid

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public hudson.util.FormValidation doCheckUserid(@QueryParameter
                                                                                                     String userid)

Checks the userid against the blacklist of invalid users.

Parameters:

userid - the userid

Returns:

the validation results.

doCheckPassword

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public hudson.util.FormValidation doCheckPassword(org.kohsuke.stapler.StaplerRequest req,
                                                                                                       @QueryParameter
                                                                                                       String userid,
                                                                                                       @QueryParameter
                                                                                                       String password,
                                                                                                       @QueryParameter
                                                                                                       String apitoken,
                                                                                                       @QueryParameter
                                                                                                       boolean useApitoken)

Checks the supplied password.

Parameters:

req - the request.

userid - the user id.

password - the password.

Returns:

the validationr results,

doCheckDontRestrictJobConfiguration

public hudson.util.FormValidation doCheckDontRestrictJobConfiguration(@QueryParameter
                                                             boolean dontRestrictJobConfiguration)

Display warnings for dontRestrictJobConfiguration "Don't restrict job configuration" can cause security issues when used with inappropriate access controls, and display for a waning message for that.

Parameters:

dontRestrictJobConfiguration - whether not to restrict job configuration

Returns:

a warning message for dontRestrictJobConfiguration if it is true

See Also:

SpecificUsersAuthorizationStrategy.setDontRestrictJobConfiguration(boolean)

isUseApitoken

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public boolean isUseApitoken()

Checks if the current SecurityRealm supports username/password authentication.

Returns:

true if and only if the current realm supports username/password authentication.

isEnabledByDefault

public boolean isEnabledByDefault()

SpecificUsersAuthorizationStrategy should be disabled by default for JENKINS-28298

Overrides:

isEnabledByDefault in class AuthorizeProjectStrategyDescriptor

Returns:

false

See Also:

AuthorizeProjectStrategyDescriptor.isEnabledByDefault()