.:] Java.Revver.XmlRpc.SSL [:.

August 8th, 2007 – 13:35:30

I have started a new project on SourceForge called RevverJ, however, it is pending approval still (just created today), so in the meantime, I thought I would share how I finally (after about a week of fighting) was able to communicate with the Revver API from Java.

NOTE: This Example requires a valid developer account and the Apache XMLRPC Library

1. Since Revver uses https, getting https to play nice with XMLRPC is a bit of a pain in the yoo-hoo, so here is the quick and easy method of getting it to work:

   HostnameVerifier hv = new HostnameVerifier() {
      public boolean verify(String arg0, SSLSession arg1) {
         return true;
      }
   };

   TrustManager[] trustAllCerts = new TrustManager[]{
         new X509TrustManager() {
            public void checkClientTrusted(java.security.cert.X509Certificate[] x509Certificates, String string)
               throws CertificateException { }

            public void checkServerTrusted(java.security.cert.X509Certificate[] x509Certificates, String string)
               throws CertificateException { }

            public java.security.cert.X509Certificate[] getAcceptedIssuers() {
               return null;
            }

            public void checkClientTrusted(X509Certificate[] certs, String authType) {
               // Trust always
            }

            public void checkServerTrusted(X509Certificate[] certs, String authType) {
               // Trust always
            }
         }
   };

** This is not the -right- way, just the easiest for this example – Read up on using XmlRpc over SSL

2. Now that you have your SSL setup, you need to implement the API itself. I will just jump right into the code here.

public class RevverVideoSearchContext  {
   private static final String LOGIN = "user";
   private static final String PASSWORD = URLEncoder.encode("secret");
   private static final String API_URL = "https://api.staging.revver.com/xml/1.0?login=" + LOGIN + "&passwd=" + PASSWORD;

   /**
    * Performs the search
    *
    * @param tags - The phrase or tags to search for
    */
   public void doSearch(String tags) {
      try {
         SSLContext sc = SSLContext.getInstance("SSL");
         sc.init(null, trustAllCerts, new java.security.SecureRandom());
         HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
         HttpsURLConnection.setDefaultHostnameVerifier(hv);

         XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();
         config.setServerURL(new URL(API_URL));
         XmlRpcClient client = new XmlRpcClient( );
         client.setConfig(config);

         Object result = client.execute("video.find", new Object [] { search, 2 } );
         transform(result);
      } catch (Throwable e) {
         e.printStackTrace();
      }
   }

   private void transform(Object result) {
      /* Do whatever you need to here */
   }

Now, contrary to the API Documentation for the video.find method, I have been unable to pass anything other than an int as the second parameter, however, passing a value of 2 seems to return all the returnFields so that I why I have used it.

The other key thing to notice, you must encode your authentication information if there are any non-alpha/numeric characters in it, otherwise you will not authenticate correctly. I am obviously using the deprecated no charset version of URLEncoder.encode, however, for this example it really doesn`t matter.

3. Use it, or in this case, test it!

public class RevverVideoSearchContextTest extends TestCase
{
   RevverVideoSearchContext revverVideoSearchContext;

   public void testDoSearch() throws Exception
   {
      revverVideoSearchContext = new RevverVideoSearchContext();
      revverVideoSearchContext.doSearch( "monkey" );
   }
}

And there you have it, a functional java implementation of the Revver API.

My goal with RevverJ is to create a wrapper API to eliminate the need to code the low level xmlrpc stuff and stick to running the actual RPC.

I would love to have someone from revver on this project.

Another very helpful thing from the good people of revver would be a WSDL and the ability to use SOAP to communicate with the API.

Anyhow, hope this helps you guys out!

References and Links:
Revver API Docs – http://developer.revver.com/?page_id=4
Apache ws-xmlrpc – http://ws.apache.org/xmlrpc/

Posted by: beef | Comments: (64)