Add schema methods to Java API

Author: Chris Mihaly

src/SchemaExample.java

@@ -0,0 +1,54 @@
+import java.net.URL;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Properties;
+
+import com.shotgunsoftware.*;
+
+class SchemaExample {
+    private static final String SHOTGUN_SERVER;
+    private static final String SCRIPT_KEY;
+    private static final String SCRIPT_NAME;
+
+    private static final String DEFAULT_SHOTGUN_SERVER = "http://shotgun-dev.fas.fa.disney.com/api3";
+    private static final String DEFAULT_SHOTGUN_KEY = "4b5a0063ed0bba6fea045b7eff7b77a9375353d5";
+    private static final String DEFAULT_SCRIPT_NAME = "testScript";
+
+    static {
+    	SHOTGUN_SERVER = (System.getProperty("SHOTGUN_SERVER") != null) ? (String) System.getProperty("SHOTGUN_SERVER") : DEFAULT_SHOTGUN_SERVER;
+    	SCRIPT_KEY = (System.getProperty("SCRIPT_KEY") != null) ? (String) System.getProperty("SCRIPT_KEY") : DEFAULT_SHOTGUN_KEY;
+    	SCRIPT_NAME = (System.getProperty("SCRIPT_NAME") != null) ? (String) System.getProperty("SCRIPT_NAME") : DEFAULT_SCRIPT_NAME;
+    }
+
+
+    public static void main(String[] args) {
+        try {
+            URL u = new URL(SHOTGUN_SERVER);
+            Shotgun s = new Shotgun(u, SCRIPT_NAME, SCRIPT_KEY);
+            
+            Map schema = s.schema_read();
+            System.out.println(schema);
+            Map fields = s.schema_field_read("Shot", null);
+            int i = 4;
+            
+            for (Iterator it = fields.keySet().iterator(); it.hasNext(); ) {
+            	String key = (String) it.next();
+            	System.out.println("Key: " + key + " Value: " + fields.get(key));
+            }
+            String field_name = s.schema_field_create("Shot", "number", "schema_create_test", null);
+            System.out.println(field_name);
+            Map props = new HashMap();
+            props.put("name", "Test Number Field Renamed");
+            props.put("description","this is only a test");
+            boolean success = s.schema_field_update("Shot", field_name, props);
+        	System.out.println(Boolean.toString(success));        
+            success = s.schema_field_delete("Shot", field_name);
+            System.out.println(Boolean.toString(success));
+//            Map schema = s.schema_read();            
+        } catch ( Exception e ) {
+            System.out.println(e.getMessage());
+        }
+    }
+}
+

src/com/shotgunsoftware/Shotgun.java

@@ -15,6 +15,8 @@
 import org.apache.ws.commons.util.NamespaceContextImpl;
 import org.apache.xmlrpc.XmlRpcException;
 
+import sun.reflect.generics.reflectiveObjects.NotImplementedException;
+
 /**
  * Shotgun XML-RPC API Wrapper
  * 
@@ -194,7 +196,97 @@ public boolean delete(DeleteRequest dr) throws XmlRpcException {
 
         return (didDelete.equals(Boolean.TRUE));
     }
-    
+
+    /**
+     * Return the shotgun schema
+     * 
+     * Well, it would but can't figure out how to pass no arguments through java xmlrpc
+     * @return  
+     * @throws  XmlRpcException if the request failed
+     */
+    public Map schema_read() throws XmlRpcException {
+    	throw new NotImplementedException();
+    	/**
+    	Object[] params = new Object[] { this.auth, new HashMap()};
+        Map response = (Map)this.client.execute("schema_read", params);
+        Map results = (Map)response.get("results");        
+        return results;
+        **/
+    }
+
+    public Map schema_field_read(String entity_type, String field_name) throws XmlRpcException {
+        HashMap req = new HashMap();
+        req.put("type", entity_type);
+        if (field_name != null)
+            req.put("field_name", field_name);
+        Object[] params = new Object[] { this.auth, req };
+        Map response = (Map)this.client.execute("schema_field_read", params);
+        Map results = (Map)response.get("results");        
+        return results;
+    }
+
+    public String schema_field_create(String entity_type, String data_type, String display_name, 
+    		Map properties) throws XmlRpcException {
+        if (properties == null)
+        	properties = new HashMap();
+        List fields = new ArrayList();
+        
+        HashMap rf = new HashMap();
+        rf.put("property_name", "name");
+        rf.put("value", display_name);
+        fields.add(rf);            
+        for ( Iterator iter = properties.entrySet().iterator(); iter.hasNext(); ) {
+            Entry e = (Entry)iter.next();
+            rf = new HashMap();
+            String key = (String)e.getKey();
+            rf.put("property_name", key);
+            rf.put("value", e.getValue());
+            fields.add(rf);            
+        }
+        HashMap req = new HashMap();
+        req.put("type", entity_type);
+        req.put("data_type", data_type);
+        req.put("properties", fields);
+        Object[] params = new Object[] { this.auth, req };
+        Map response = (Map)this.client.execute("schema_field_create", params);
+        String field_name = (String)response.get("results");        
+        return field_name;
+    }
+
+    public boolean schema_field_update(String entity_type, String field_name, Map properties) throws XmlRpcException {
+        if (properties == null)
+        	properties = new HashMap();
+        List fields = new ArrayList();
+        
+        HashMap rf = new HashMap();
+        for ( Iterator iter = properties.entrySet().iterator(); iter.hasNext(); ) {
+            Entry e = (Entry)iter.next();
+            rf = new HashMap();
+            String key = (String)e.getKey();
+            rf.put("property_name", key);
+            rf.put("value", e.getValue());
+            fields.add(rf);            
+        }
+        HashMap req = new HashMap();
+        req.put("type", entity_type);
+        req.put("field_name", field_name);
+        req.put("properties", fields);
+        Object[] params = new Object[] { this.auth, req };
+        Map response = (Map)this.client.execute("schema_field_update", params);
+        Boolean didDelete = (Boolean)response.get("results");        
+        return (didDelete.equals(Boolean.TRUE));
+    }
+
+    public boolean schema_field_delete(String entity_type, String field_name) throws XmlRpcException {
+        HashMap req = new HashMap();
+        req.put("type", entity_type);
+        req.put("field_name", field_name);
+        Object[] params = new Object[] { this.auth, req };
+        Map response = (Map)this.client.execute("schema_field_delete", params);
+        Boolean didDelete = (Boolean)response.get("results");        
+        return (didDelete.equals(Boolean.TRUE));
+    }
+
     class MyTypeFactory extends TypeFactoryImpl {
         public MyTypeFactory(XmlRpcController pController) {
             super(pController);
@@ -210,4 +302,5 @@ public TypeParser getParser(XmlRpcStreamConfig pConfig,
             }
         }
     }
+
 }