Package se.diabol.jenkins.pipeline

Class PipelineApi

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Api

se.diabol.jenkins.pipeline.PipelineApi

All Implemented Interfaces:

ModelObject, SearchableModelObject, SearchItem

public class PipelineApi
extends Api

The view's api/json, which the page polls. The JSON is exported once per cached model and viewer and served with an ETag made of the model's version and the viewer; a poll that sends it back and finds the model unchanged is answered with 304 Not Modified and no body. Only the server time is written afresh into every response. Requests with Stapler's own parameters (tree, depth, pretty, ...) are exported on the spot as any api/json is. Responses must never be served from an HTTP cache.

Field Summary

Fields inherited from class hudson.model.Api

bean

Constructor Summary

Constructors

Constructor	Description
PipelineApi(DeliveryPipelineView view)

Method Summary

Modifier and Type	Method	Description
void	doJson(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	A read of the view's model, hence GET and no POST protection; the view's read permission is checked.

Methods inherited from class hudson.model.Api

doJson, doPython, doPython, doSchema, doXml, getDisplayName, getSearchUrl, setHeaders

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.search.SearchItem

getSearchGroup, getSearchIcon

Constructor Details

PipelineApi

public PipelineApi(DeliveryPipelineView view)

Method Details

doJson

public void doJson(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
            throws IOException,
jakarta.servlet.ServletException

A read of the view's model, hence GET and no POST protection; the view's read permission is checked.

Overrides:

doJson in class Api

Throws:

IOException

jakarta.servlet.ServletException