Package io.jenkins.plugins.remote.result.trigger

Class RemoteBuildResultTrigger.RemoteBuildResultTriggerDescriptor

java.lang.Object

hudson.model.Descriptor<Trigger<?>>

hudson.triggers.TriggerDescriptor

org.jenkinsci.plugins.xtriggerapi.XTriggerDescriptor

io.jenkins.plugins.remote.result.trigger.RemoteBuildResultTrigger.RemoteBuildResultTriggerDescriptor

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

RemoteBuildResultTrigger

@Extension
public static class RemoteBuildResultTrigger.RemoteBuildResultTriggerDescriptor
extends org.jenkinsci.plugins.xtriggerapi.XTriggerDescriptor

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
RemoteBuildResultTriggerDescriptor()	In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)	Invoked when the global configuration page is submitted.
String	getDisplayName()	Human readable name of this kind of configurable object.
String	getHelpFile()	Returns the resource path to the help screen HTML, if any.
RemoteJenkinsServer[]	getRemoteJenkinsServers()

Methods inherited from class org.jenkinsci.plugins.xtriggerapi.XTriggerDescriptor

getExecutor, isApplicable

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, 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

RemoteBuildResultTriggerDescriptor

public RemoteBuildResultTriggerDescriptor()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.

Overrides:

getDisplayName in class Descriptor<Trigger<?>>

getHelpFile

public String getHelpFile()

Returns the resource path to the help screen HTML, if any.

Starting 1.282, this method uses "convention over configuration" — you should just put the "help.html" (and its localized versions, if any) in the same directory you put your Jelly view files, and this method will automatically does the right thing.

This value is relative to the context root of Hudson, so normally the values are something like "/plugin/emma/help.html" to refer to static resource files in a plugin, or "/publisher/EmmaPublisher/abc" to refer to Jelly script abc.jelly or a method EmmaPublisher.doAbc().

Overrides:

getHelpFile in class Descriptor<Trigger<?>>

Returns:

null to indicate that there's no help.

configure

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

Invoked when the global configuration page is submitted.

Can be overridden to store descriptor-specific information.

Overrides:

configure in class Descriptor<Trigger<?>>

Parameters:

req - StaplerRequest2

json - The JSON object that captures the configuration data for this Descriptor. See the developer documentation.

Returns:

false to keep the client in the same config page.

Throws:

Descriptor.FormException

getRemoteJenkinsServers

public RemoteJenkinsServer[] getRemoteJenkinsServers()