hudson.model

Class DownloadService

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

hudson.model.DownloadService

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, Saveable

@Extension
public class DownloadService
extends PageDecorator

Service for plugins to periodically retrieve update data files (like the one in the update center) through browsers.

Because the retrieval of the file goes through XmlHttpRequest, we cannot reliably pass around binary.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadService.Downloadable Represents a periodically updated JSON data file obtained from a remote URL.
static class	DownloadService.DownloadableListener This installs itself as a listener to changes to the Downloadable extension list and will download the metadata for any newly added Downloadables.

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

Modifier and Type	Field and Description
static boolean	neverUpdate
static boolean	signatureCheck May be used to temporarily disable signature checking on DownloadService and UpdateCenter.

Fields inherited from class hudson.model.PageDecorator

ALL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DownloadService()

Method Summary

Modifier and Type	Method and Description
String	generateFragment() Builds up an HTML fragment that starts all the download jobs.
DownloadService.Downloadable	getById(String id) Gets DownloadService.Downloadable by its ID.
static String	loadJSON(URL src) Loads JSON from a JSONP URL.
static String	loadJSONHTML(URL src) Loads JSON from a JSON-with-postMessage URL.

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

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

Field Detail

neverUpdate

public static boolean neverUpdate

signatureCheck

public static boolean signatureCheck

May be used to temporarily disable signature checking on DownloadService and UpdateCenter. Useful when upstream signatures are broken, such as due to expired certificates. Should only be used when DownloadSettings.isUseBrowser(); disabling signature checks for in-browser downloads is very dangerous as unprivileged users could submit spoofed metadata!

Constructor Detail

DownloadService

public DownloadService()

Method Detail

generateFragment

public String generateFragment()

Builds up an HTML fragment that starts all the download jobs.

getById

public DownloadService.Downloadable getById(String id)

Gets DownloadService.Downloadable by its ID. Used to bind them to URL.

loadJSON

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String loadJSON(URL src)
                                                                                              throws IOException

Loads JSON from a JSONP URL. Metadata for downloadables and update centers is offered in two formats, both designed for download from the browser (predating DownloadSettings): HTML using postMessage for newer browsers, and JSONP as a fallback. Confusingly, the JSONP files are given the *.json file extension, when they are really JavaScript and should be *.js. This method extracts the JSON from a JSONP URL, since that is what we actually want when we download from the server. (Currently the true JSON is not published separately, and extracting from the *.json.html is more work.)

Parameters:

src - a URL to a JSONP file (typically including id and version query parameters)

Returns:

the embedded JSON text

Throws:

IOException - if either downloading or processing failed

loadJSONHTML

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String loadJSONHTML(URL src)
                                                                                                  throws IOException

Loads JSON from a JSON-with-postMessage URL.

Parameters:

src - a URL to a JSON HTML file (typically including id and version query parameters)

Returns:

the embedded JSON text

Throws:

IOException - if either downloading or processing failed