Package hudson.model

Class Api

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.Api

All Implemented Interfaces:

ModelObject, SearchableModelObject, SearchItem

Direct Known Subclasses:

CrumbIssuer.RestrictedApi

public class Api
extends AbstractModelObject

Used to expose remote access API for ".../api/"

If the parent object has a _api.jelly view, it will be included in the api index page.

Author:

Kohsuke Kawaguchi

See Also:

• Exported
• SecureRequester

Field Summary

Fields

Modifier and Type	Field	Description
final Object	bean	Model object to be exposed as XML/JSON/etc.

Constructor Summary

Constructors

Constructor	Description
Api(Object bean)

Method Summary

Modifier and Type	Method	Description
void	doJson(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Exposes the bean as JSON.
void	doJson(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use doJson(StaplerRequest2, StaplerResponse2)
void	doPython(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Exposes the bean as Python literal.
void	doPython(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp)	Deprecated. use doPython(StaplerRequest2, StaplerResponse2)
void	doSchema(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)	Generate schema.
void	doXml(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String xpath, String wrapper, String tree, int depth)	Exposes the bean as XML.
String	getDisplayName()
String	getSearchUrl()	Returns the URL of this item relative to the parent SearchItem.
protected void	setHeaders(org.kohsuke.stapler.StaplerResponse2 rsp)

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

Field Details

bean

public final Object bean

Model object to be exposed as XML/JSON/etc.

Constructor Details

Api

public Api(Object bean)

Method Details

getDisplayName

public String getDisplayName()

getSearchUrl

public String getSearchUrl()

Description copied from interface: SearchItem

Returns the URL of this item relative to the parent SearchItem.

Returns:

URL like "foo" or "foo/bar". The path can end with '/'. The path that starts with '/' will be interpreted as the absolute path (within the context path of Jenkins.)

doXml

public void doXml(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 String xpath,
 @QueryParameter
 String wrapper,
 @QueryParameter
 String tree,
 @QueryParameter
 int depth)
           throws IOException,
jakarta.servlet.ServletException

Exposes the bean as XML.

Throws:

IOException

jakarta.servlet.ServletException

doSchema

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

Generate schema.

Throws:

IOException

jakarta.servlet.ServletException

doJson

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

Exposes the bean as JSON.

Throws:

IOException

jakarta.servlet.ServletException

doJson

@Deprecated
@StaplerNotDispatchable
public void doJson(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
            throws IOException,
javax.servlet.ServletException

Deprecated.

use doJson(StaplerRequest2, StaplerResponse2)

Throws:

IOException

javax.servlet.ServletException

doPython

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

Exposes the bean as Python literal.

Throws:

IOException

jakarta.servlet.ServletException

doPython

@Deprecated
@StaplerNotDispatchable
public void doPython(org.kohsuke.stapler.StaplerRequest req,
 org.kohsuke.stapler.StaplerResponse rsp)
              throws IOException,
javax.servlet.ServletException

Deprecated.

use doPython(StaplerRequest2, StaplerResponse2)

Throws:

IOException

javax.servlet.ServletException

setHeaders

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
protected void setHeaders(org.kohsuke.stapler.StaplerResponse2 rsp)