mirror of
https://github.com/jenkinsci/jenkins.git
synced 2026-11-21 15:55:40 +00:00
added the first cut of the remote API support via XML and JSON.
git-svn-id: https://hudson.dev.java.net/svn/hudson/trunk/hudson/main@2717 71c3de6d-444a-0410-be80-ed276b4c234a
This commit is contained in:
1 parent
d1f906189d
commit
0fdb52aeb9
4 files changed
+245
-14
No files matched your search
@@ -0,0 +1,166 @@
|
||||
package hudson.model;
|
||||
|
||||
import com.thoughtworks.xstream.XStream;
|
||||
import com.thoughtworks.xstream.mapper.MapperWrapper;
|
||||
|
||||
import java.beans.Introspector;
|
||||
import java.io.IOException;
|
||||
import java.io.PrintWriter;
|
||||
import java.util.Set;
|
||||
import java.util.HashSet;
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.Map;
|
||||
import java.net.URL;
|
||||
import java.lang.reflect.Field;
|
||||
|
||||
import org.kohsuke.stapler.StaplerResponse;
|
||||
import org.kohsuke.stapler.StaplerRequest;
|
||||
import hudson.util.XStream2;
|
||||
import net.sf.json.util.JSONBuilder;
|
||||
import net.sf.json.JSONObject;
|
||||
|
||||
/**
|
||||
* Used to expose remote access API for ".../api/"
|
||||
*
|
||||
* @author Kohsuke Kawaguchi
|
||||
*/
|
||||
public class Api extends AbstractModelObject {
|
||||
/**
|
||||
* Value bean to be exposed as XML/JSON/etc.
|
||||
*/
|
||||
private final Object bean;
|
||||
|
||||
public Api(Object bean) {
|
||||
this.bean = bean;
|
||||
}
|
||||
|
||||
public String getDisplayName() {
|
||||
return "API";
|
||||
}
|
||||
|
||||
/**
|
||||
* Exposes the bean as XML.
|
||||
*/
|
||||
public void doXml(StaplerRequest req, StaplerResponse rsp) throws IOException {
|
||||
rsp.setContentType("application/xml;charset=UTF-8");
|
||||
RestXStream.INSTANCE.toXML(bean, rsp.getWriter());
|
||||
}
|
||||
|
||||
/**
|
||||
* Exposes the bean as JSON.
|
||||
*/
|
||||
public void doJson(StaplerRequest req, StaplerResponse rsp) throws IOException {
|
||||
rsp.setContentType("text/javascript;charset=UTF-8");
|
||||
|
||||
String pad = req.getParameter("jsonp");
|
||||
PrintWriter w = rsp.getWriter();
|
||||
if(pad!=null) w.print(pad+'(');
|
||||
JSONSerializer.write(bean,new JSONBuilder(w));
|
||||
if(pad!=null) w.print(')');
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link XStream} customized for writing XML for the REST API.
|
||||
*
|
||||
* @author Kohsuke Kawaguchi
|
||||
*/
|
||||
private static class RestXStream extends XStream2 {
|
||||
private RestXStream() {
|
||||
setMode(NO_REFERENCES);
|
||||
registerConverter(Result.conv);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected MapperWrapper wrapMapper(MapperWrapper next) {
|
||||
return new MapperWrapper(next) {
|
||||
// always use the short name
|
||||
public String serializedClass(Class type) {
|
||||
return Introspector.decapitalize(type.getSimpleName());
|
||||
}
|
||||
|
||||
// don't serialize the outer class
|
||||
public boolean shouldSerializeMember(Class definedIn, String fieldName) {
|
||||
return !fieldName.startsWith("this$") && !fieldName.startsWith("val$")
|
||||
&& super.shouldSerializeMember(definedIn, fieldName);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
static final RestXStream INSTANCE = new RestXStream();
|
||||
}
|
||||
|
||||
/**
|
||||
* Works like {@link JSONObject#fromBean(Object)} except
|
||||
* this uses fields instead of properties.
|
||||
*
|
||||
* @author Kohsuke Kawaguchi
|
||||
*/
|
||||
private static class JSONSerializer {
|
||||
|
||||
private static final Set<Class> LEAF_TYPES = new HashSet<Class>(Arrays.asList(
|
||||
String.class,
|
||||
URL.class,
|
||||
Boolean.class,
|
||||
Integer.class
|
||||
));
|
||||
|
||||
public static void write(Object bean, JSONBuilder builder) {
|
||||
if(bean==null) {
|
||||
builder.value(null);
|
||||
return;
|
||||
}
|
||||
|
||||
Class c = bean.getClass();
|
||||
|
||||
if(LEAF_TYPES.contains(c)) {
|
||||
builder.value(bean);
|
||||
return;
|
||||
}
|
||||
if(c.getComponentType()!=null) { // array
|
||||
builder.array();
|
||||
for (Object item : (Object[])bean)
|
||||
write(item,builder);
|
||||
builder.endArray();
|
||||
return;
|
||||
}
|
||||
if(Collection.class.isAssignableFrom(c)) {
|
||||
builder.array();
|
||||
for (Object item : (Collection) bean)
|
||||
write(item,builder);
|
||||
builder.endArray();
|
||||
return;
|
||||
}
|
||||
if(Map.class.isAssignableFrom(c)) {
|
||||
builder.object();
|
||||
for (Map.Entry e : ((Map<?,?>) bean).entrySet()) {
|
||||
builder.key(e.getKey().toString());
|
||||
write(e.getValue(),builder);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// otherwise handle it as a bean
|
||||
writeBean(builder, bean);
|
||||
}
|
||||
|
||||
private static void writeBean(JSONBuilder builder, Object bean) {
|
||||
builder.object();
|
||||
|
||||
for( Field f : bean.getClass().getFields() ) {
|
||||
try {
|
||||
Object value = f.get(bean);
|
||||
if(value!=null) {
|
||||
builder.key(f.getName());
|
||||
write(value,builder);
|
||||
}
|
||||
} catch (IllegalAccessException e) {
|
||||
// impossible given that this is a public field
|
||||
throw new Error(e);
|
||||
}
|
||||
}
|
||||
|
||||
builder.endObject();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,16 +3,16 @@ package hudson.model;
|
||||
import com.thoughtworks.xstream.XStream;
|
||||
import groovy.lang.GroovyShell;
|
||||
import hudson.FeedAdapter;
|
||||
import hudson.FilePath;
|
||||
import hudson.Launcher;
|
||||
import hudson.Launcher.LocalLauncher;
|
||||
import hudson.Plugin;
|
||||
import hudson.PluginManager;
|
||||
import hudson.PluginWrapper;
|
||||
import hudson.Util;
|
||||
import hudson.XmlFile;
|
||||
import hudson.FilePath;
|
||||
import hudson.TcpSlaveAgentListener;
|
||||
import hudson.Util;
|
||||
import static hudson.Util.fixEmpty;
|
||||
import hudson.XmlFile;
|
||||
import hudson.model.Descriptor.FormException;
|
||||
import hudson.model.listeners.ItemListener;
|
||||
import hudson.model.listeners.JobListener;
|
||||
@@ -21,11 +21,11 @@ import hudson.model.listeners.SCMListener;
|
||||
import hudson.remoting.LocalChannel;
|
||||
import hudson.remoting.VirtualChannel;
|
||||
import hudson.scm.CVSSCM;
|
||||
import hudson.scm.SCM;
|
||||
import hudson.scm.SCMS;
|
||||
import hudson.scm.SCMDescriptor;
|
||||
import hudson.scm.RepositoryBrowser;
|
||||
import hudson.scm.RepositoryBrowsers;
|
||||
import hudson.scm.SCM;
|
||||
import hudson.scm.SCMDescriptor;
|
||||
import hudson.scm.SCMS;
|
||||
import hudson.tasks.BuildStep;
|
||||
import hudson.tasks.BuildWrapper;
|
||||
import hudson.tasks.BuildWrappers;
|
||||
@@ -33,8 +33,8 @@ import hudson.tasks.Builder;
|
||||
import hudson.tasks.Mailer;
|
||||
import hudson.tasks.Publisher;
|
||||
import hudson.triggers.Trigger;
|
||||
import hudson.triggers.Triggers;
|
||||
import hudson.triggers.TriggerDescriptor;
|
||||
import hudson.triggers.Triggers;
|
||||
import hudson.util.CopyOnWriteList;
|
||||
import hudson.util.CopyOnWriteMap;
|
||||
import hudson.util.FormFieldValidator;
|
||||
@@ -68,15 +68,14 @@ import java.util.Comparator;
|
||||
import java.util.GregorianCalendar;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Set;
|
||||
import java.util.Stack;
|
||||
import java.util.StringTokenizer;
|
||||
import java.util.TreeSet;
|
||||
import java.util.Vector;
|
||||
import java.util.StringTokenizer;
|
||||
import java.util.Stack;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.LogRecord;
|
||||
|
||||
@@ -387,10 +386,8 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node
|
||||
}
|
||||
|
||||
/*package*/ void removeComputer(Computer computer) {
|
||||
Iterator<Entry<Node,Computer>> itr=computers.entrySet().iterator();
|
||||
while(itr.hasNext()) {
|
||||
Entry<Node, Computer> e = itr.next();
|
||||
if(e.getValue()==computer) {
|
||||
for (Entry<Node, Computer> e : computers.entrySet()) {
|
||||
if (e.getValue() == computer) {
|
||||
computers.remove(e.getKey());
|
||||
return;
|
||||
}
|
||||
@@ -1374,6 +1371,36 @@ public final class Hudson extends View implements ItemGroup<TopLevelItem>, Node
|
||||
}.process();
|
||||
}
|
||||
|
||||
public Api getApi(final StaplerRequest req) {
|
||||
class hudson {
|
||||
List<job> jobs = new ArrayList<job>();
|
||||
|
||||
class job {
|
||||
String name;
|
||||
String url;
|
||||
BallColor color;
|
||||
Integer lastBuild;
|
||||
|
||||
public job(TopLevelItem item) {
|
||||
this.name = item.getName();
|
||||
this.url = req.getRootPath()+'/'+item.getUrl();
|
||||
if (item instanceof Job) {
|
||||
Job job = (Job) item;
|
||||
color = job.getIconColor();
|
||||
lastBuild =job.getLastBuild()!=null ? job.getLastBuild().getNumber() : null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
hudson() {
|
||||
for (TopLevelItem item : getItems())
|
||||
jobs.add(new job(item));
|
||||
}
|
||||
}
|
||||
|
||||
return new Api(new hudson());
|
||||
}
|
||||
|
||||
|
||||
public static boolean isWindows() {
|
||||
return File.pathSeparatorChar==';';
|
||||
|
||||
Reference in new issue
Block a user