public class Api extends AbstractModelObject
If the parent object has a _api.jelly
view, it will be included
in the api index page.
Exported
,
SecureRequester
Modifier and Type | Field and Description |
---|---|
Object |
bean
Model object to be exposed as XML/JSON/etc.
|
Modifier and Type | Method and Description |
---|---|
void |
doJson(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Exposes the bean as JSON.
|
void |
doPython(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Exposes the bean as Python literal.
|
void |
doSchema(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Generate schema.
|
void |
doXml(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse 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.StaplerResponse rsp) |
getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError
public final Object bean
public Api(Object bean)
public String getDisplayName()
public String getSearchUrl()
SearchItem
SearchItem
.public void doXml(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, @QueryParameter String xpath, @QueryParameter String wrapper, @QueryParameter String tree, @QueryParameter int depth) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public void doSchema(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public void doJson(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
public void doPython(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class) protected void setHeaders(org.kohsuke.stapler.StaplerResponse rsp)
Copyright © 2004–2021. All rights reserved.