More work on caching.

Enable coverage.

.gitignore

@@ -2,3 +2,4 @@
 /build
 /derby.log
 /dist
+/coverage

nbproject/coverage.properties

@@ -0,0 +1,6 @@
+#coverage viewer module properties for project
+#Tue Jan 06 09:54:06 GMT 2009
+coverage.activity=ON
+project.type=java
+coverage.templateFile=coverage/template.emma
+coverage.coverageFile=coverage/coverage.emma

nbproject/private/private.properties

@@ -5,3 +5,4 @@ javac.debug=true
 javadoc.preview=true
 jaxws.endorsed.dir=/usr/local/netbeans-6.5/java2/modules/ext/jaxws21/api:/usr/local/netbeans-6.5/ide10/modules/ext/jaxb/api
 user.properties.file=/home/chris/.netbeans/6.5/build.properties
+file.reference.emma.jar=/home/chris/.netbeans/6.5/modules/ext/emma.jar

nbproject/project.properties

@@ -70,7 +70,7 @@ run.classpath=\
 run.jvmargs=
 run.test.classpath=\
     ${javac.test.classpath}:\
-    ${build.test.classes.dir}
+    ${build.test.classes.dir}:${file.reference.emma.jar}
 source.encoding=UTF-8
 src.dir=src
 test.src.dir=test

src/uk/co/md87/evetool/api/io/ApiCache.java

@@ -14,18 +14,43 @@ import java.util.Map;
  */
 public interface ApiCache {
 
-    public static enum ApiCacheStatus {
+    public static enum CacheStatus {
         MISS,
         EXPIRED,
-        CACHED;
+        HIT;
+    }
+
+    public static class CacheResult {
+
+        private final String data;
+        private final long cachedAt;
+        private final long cachedUntil;
+
+        public CacheResult(String data, long cachedAt, long cachedUntil) {
+            this.data = data;
+            this.cachedAt = cachedAt;
+            this.cachedUntil = cachedUntil;
+        }
+
+        public long getCachedAt() {
+            return cachedAt;
+        }
+
+        public long getCachedUntil() {
+            return cachedUntil;
+        }
+
+        public String getData() {
+            return data;
+        }
+        
     }
 
     void setCache(final String method, final Map<String, String> args,
             final String data, final long cacheUntil);
 
-    ApiCacheStatus getCacheStatus(final String method, final Map<String, String> args);
+    CacheStatus getCacheStatus(final String method, final Map<String, String> args);
 
-    // TODO: This should return meta-data too
-    String getCache(final String method, final Map<String, String> args);
+    CacheResult getCache(final String method, final Map<String, String> args);
 
 }

src/uk/co/md87/evetool/api/io/ApiDownloader.java

@@ -11,7 +11,8 @@ import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
-import uk.co.md87.evetool.api.io.ApiCache.ApiCacheStatus;
+import uk.co.md87.evetool.api.io.ApiCache.CacheStatus;
+import uk.co.md87.evetool.api.parser.ApiResult;
 
 /**
  *
@@ -46,25 +47,29 @@ public class ApiDownloader {
         this.charID = charID;
     }
 
-    public String getPage(final String method, final Map<String, String> args) {
-        final Map<String, String> ourArgs = new HashMap<String, String>(args);
-
-        // TODO: Abstract
+    protected void addArgs(final Map<String, String> args) {
         if (userID != null) {
-            ourArgs.put("userID", userID);
+            args.put("userID", userID);
         }
 
         if (apiKey != null) {
-            ourArgs.put("apiKey", apiKey);
+            args.put("apiKey", apiKey);
         }
 
         if (charID != null) {
-            ourArgs.put("characterID", charID);
+            args.put("characterID", charID);
         }
+    }
 
-        final ApiCacheStatus cacheStatus = cache.getCacheStatus(method, args);
+    public ApiCache.CacheResult getPage(final String method, final Map<String, String> args) {
+        final Map<String, String> ourArgs = new HashMap<String, String>(args);
+        addArgs(ourArgs);
 
-        if (cacheStatus == ApiCacheStatus.CACHED) {
+        // TODO: Refactor to avoid duplicate gets
+
+        final CacheStatus cacheStatus = cache.getCacheStatus(method, args);
+
+        if (cacheStatus == CacheStatus.HIT) {
             return cache.getCache(method, args);
         }
 
@@ -76,10 +81,10 @@ public class ApiDownloader {
 
             cache.setCache(method, args, builder.toString(),
                     System.currentTimeMillis() + 20000); // TODO: Proper time
-            return builder.toString();
+            return cache.getCache(method, args);
         } catch (IOException ex) {
             LOGGER.log(Level.WARNING, "API request failed", ex);
-            if (cacheStatus == ApiCacheStatus.EXPIRED) {
+            if (cacheStatus == CacheStatus.EXPIRED) {
                 return cache.getCache(method, args);
             } else {
                 return null;

src/uk/co/md87/evetool/api/io/DBCache.java

@@ -58,7 +58,7 @@ public class DBCache implements ApiCache {
     public void setCache(final String method, final Map<String, String> args,
             final String data, final long cacheUntil) {
         try {
-            if (getCacheStatus(method, args) == ApiCacheStatus.MISS) {
+            if (getCacheStatus(method, args) == CacheStatus.MISS) {
                 // The page has never been requested before.
                 
                 prepInsert.setString(1, method);
@@ -84,7 +84,7 @@ public class DBCache implements ApiCache {
 
     /** {@inheritDoc} */
     @Override
-    public ApiCacheStatus getCacheStatus(final String method, final Map<String, String> args) {
+    public CacheStatus getCacheStatus(final String method, final Map<String, String> args) {
         try {
             prepCheck.setString(1, method);
             prepCheck.setString(2, Downloader.encodeArguments(args));
@@ -94,19 +94,19 @@ public class DBCache implements ApiCache {
             if (rs.next()) {
                 return rs.getTimestamp("PC_CACHEDUNTIL")
                         .before(new Date(System.currentTimeMillis()))
-                        ? ApiCacheStatus.EXPIRED : ApiCacheStatus.CACHED;
+                        ? CacheStatus.EXPIRED : CacheStatus.HIT;
             } else {
-                return ApiCacheStatus.MISS;
+                return CacheStatus.MISS;
             }
         } catch (SQLException ex) {
             LOGGER.log(Level.SEVERE, "Error checking cache status", ex);
-            return ApiCacheStatus.MISS;
+            return CacheStatus.MISS;
         }
     }
 
     /** {@inheritDoc} */
     @Override
-    public String getCache(final String method, final Map<String, String> args) {
+    public CacheResult getCache(final String method, final Map<String, String> args) {
         try {
             prepRetrieve.setString(1, method);
             prepRetrieve.setString(2, Downloader.encodeArguments(args));
@@ -115,7 +115,9 @@ public class DBCache implements ApiCache {
 
             if (rs.next()) {
                 final Clob clob = rs.getClob("PC_DATA");
-                return clob.getSubString(1, (int) clob.length());
+                final long at = rs.getTimestamp("PC_CACHEDAT").getTime();
+                final long until = rs.getTimestamp("PC_CACHEDUNTIL").getTime();
+                return new CacheResult(clob.getSubString(1, (int) clob.length()), at, until);
             } else {
                 LOGGER.log(Level.WARNING, "No cache result for " + method);
                 return null;

test/uk/co/md87/evetool/api/io/DBCacheTest.java

@@ -28,19 +28,19 @@ public class DBCacheTest {
     public void testBasicInsert() throws SQLException {
         final Map<String, String> args = new HashMap<String, String>();
         final Connection conn = DriverManager.getConnection(dbURL);
-        final EveApi api = new EveApi(conn); // To create tables
+        new EveApi(conn); // To create tables
         final DBCache cache = new DBCache(conn);
 
         args.put("foo", "bar");
         args.put("rand", String.valueOf(System.currentTimeMillis()));
 
-        assertEquals(ApiCache.ApiCacheStatus.MISS, cache.getCacheStatus("/unittest", args));
+        assertEquals(ApiCache.CacheStatus.MISS, cache.getCacheStatus("/unittest", args));
         cache.setCache("/unittest", args, "testing 123", System.currentTimeMillis() - 100000);
-        assertEquals(ApiCache.ApiCacheStatus.EXPIRED, cache.getCacheStatus("/unittest", args));
-        assertEquals("testing 123", cache.getCache("/unittest", args));
+        assertEquals(ApiCache.CacheStatus.EXPIRED, cache.getCacheStatus("/unittest", args));
+        assertEquals("testing 123", cache.getCache("/unittest", args).getData());
         cache.setCache("/unittest", args, "testing 456", System.currentTimeMillis() + 100000);
-        assertEquals(ApiCache.ApiCacheStatus.CACHED, cache.getCacheStatus("/unittest", args));
-        assertEquals("testing 456", cache.getCache("/unittest", args));
+        assertEquals(ApiCache.CacheStatus.HIT, cache.getCacheStatus("/unittest", args));
+        assertEquals("testing 456", cache.getCache("/unittest", args).getData());
         conn.close();
     }