Package io.jenkins.plugins.restlistparam

Class AbstractRestListParameterDescriptor

java.lang.Object

hudson.model.Descriptor<ParameterDefinition>

hudson.model.ParameterDefinition.ParameterDescriptor

io.jenkins.plugins.restlistparam.AbstractRestListParameterDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Direct Known Subclasses:

RestListParameterDefinition.DescriptorImpl, RestMultiListParameterDefinition.DescriptorImpl

public abstract class AbstractRestListParameterDescriptor
extends ParameterDefinition.ParameterDescriptor

Job configuration checks and the Test Configuration action shared by the descriptors of the REST List and REST Multi List parameters. Stapler resolves these web methods on descriptor superclasses, so both parameter types' config.jelly bind to them unchanged.

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
AbstractRestListParameterDescriptor()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckCacheTime(Item context, Integer cacheTime)
FormValidation	doCheckCredentialId(Item context, String value)
FormValidation	doCheckRestEndpoint(Item context, String value, String credentialId, MimeType mimeType)
FormValidation	doCheckValueExpression(Item context, String value, MimeType mimeType)
ListBoxModel	doFillCredentialIdItems(Item context, String credentialId)
FormValidation	doTestConfiguration(Item context, String restEndpoint, String credentialId, MimeType mimeType, String valueExpression, String displayExpression, String filter, ValueOrder valueOrder, String customHeadersJson, String paginationJson)
Integer	getDefaultCacheTime()
Integer	getFetchTimeout()
ParameterDefinition	newInstance(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)	The pagination block is an inline f:optionalBlock, so the strategy binds straight to the pagination field.

Methods inherited from class hudson.model.ParameterDefinition.ParameterDescriptor

getDisplayName, getValuePage

Methods inherited from class hudson.model.Descriptor

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

AbstractRestListParameterDescriptor

public AbstractRestListParameterDescriptor()

Method Details

getDefaultCacheTime

public Integer getDefaultCacheTime()

getFetchTimeout

public Integer getFetchTimeout()

Returns:

The global fetch timeout in seconds, which the build form uses to give up on a load without a response

newInstance

public ParameterDefinition newInstance(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject formData)
                                throws Descriptor.FormException

The pagination block is an inline f:optionalBlock, so the strategy binds straight to the pagination field. Inline blocks submit their fields even while unchecked, so an unchecked block is turned into "no pagination" here.

Overrides:

newInstance in class Descriptor<ParameterDefinition>

Throws:

Descriptor.FormException

doCheckRestEndpoint

@POST
public FormValidation doCheckRestEndpoint(@AncestorInPath
 Item context,
 @QueryParameter
 String value,
 @QueryParameter
 String credentialId,
 @QueryParameter
 MimeType mimeType)

doCheckValueExpression

@POST
public FormValidation doCheckValueExpression(@AncestorInPath
 Item context,
 @QueryParameter
 String value,
 @QueryParameter
 MimeType mimeType)

doFillCredentialIdItems

@POST
public ListBoxModel doFillCredentialIdItems(@AncestorInPath
 Item context,
 @QueryParameter
 String credentialId)

doCheckCredentialId

@POST
public FormValidation doCheckCredentialId(@AncestorInPath
 Item context,
 @QueryParameter
 String value)

doCheckCacheTime

@POST
public FormValidation doCheckCacheTime(@AncestorInPath
 Item context,
 @QueryParameter
 Integer cacheTime)

doTestConfiguration

@POST
public FormValidation doTestConfiguration(@AncestorInPath
 Item context,
 @QueryParameter
 String restEndpoint,
 @QueryParameter
 String credentialId,
 @QueryParameter
 MimeType mimeType,
 @QueryParameter
 String valueExpression,
 @QueryParameter
 String displayExpression,
 @QueryParameter
 String filter,
 @QueryParameter
 ValueOrder valueOrder,
 @QueryParameter
 String customHeadersJson,
 @QueryParameter
 String paginationJson)