Deprecate unused CacheService

ome · Sep 11, 2019 · 7a2546c · 7a2546c
1 parent 9220153
commit 7a2546c
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/src/main/java/omero/gateway/Gateway.java b/src/main/java/omero/gateway/Gateway.java
@@ -199,7 +199,11 @@ public Gateway(Logger log) {
      *            A {@link Logger}
      * @param cacheService
      *            A {@link CacheService}, can be <code>null</code>
+     *
+     * @deprecated This constructor will be removed in future. Please
+     *             use {@link #Gateway(Logger) instead}
      */
+    @Deprecated
     public Gateway(Logger log, CacheService cacheService) {
         this(log, cacheService, null, true);
     }
@@ -220,7 +224,11 @@ public Gateway(Logger log, CacheService cacheService) {
      *            disconnect (only taken into account if an
      *            {@link ExecutorService} was provided; the default cached
      *            thread pool will be shut down by default)
+     *
+     * @deprecated This constructor will be removed in future. Please
+     *             use {@link #Gateway(Logger, ExecutorService, boolean) instead}
      */
+    @Deprecated
     public Gateway(Logger log, CacheService cacheService,
             ExecutorService executorService,
             boolean executorShutdownOnDisconnect) {
@@ -232,6 +240,30 @@ public Gateway(Logger log, CacheService cacheService,
                 : executorShutdownOnDisconnect;
     }
 
+    /**
+     * Creates a new Gateway instance
+     *
+     * @param log
+     *            A {@link Logger}
+     * @param executorService
+     *            A {@link ExecutorService} for handling asynchronous tasks, can
+     *            be <code>null</code> (in which case the Java built-in cached
+     *            thread pool will be used)
+     * @param executorShutdownOnDisconnect
+     *            Flag to indicate that executor threads should be shutdown on
+     *            disconnect (only taken into account if an
+     *            {@link ExecutorService} was provided; the default cached
+     *            thread pool will be shut down by default)
+     */
+    public Gateway(Logger log, ExecutorService executorService,
+                   boolean executorShutdownOnDisconnect) {
+        this.log = log;
+        this.executorService = executorService == null ? Executors
+                .newCachedThreadPool() : executorService;
+        this.executorShutdownOnDisconnect = executorService == null ? true
+                : executorShutdownOnDisconnect;
+    }
+
     /**
      * Submits an async task
      * 
@@ -573,7 +605,10 @@ public Logger getLogger() {
      * Provides access to the {@link CacheService}
      * 
      * @return See above
+     *
+     * @deprecated This method will be removed in future.
      */
+    @Deprecated
     public CacheService getCacheService() {
         return cacheService;
     }

diff --git a/src/main/java/omero/gateway/cache/CacheService.java b/src/main/java/omero/gateway/cache/CacheService.java
@@ -29,7 +29,10 @@
  * @author Donald MacDonald &nbsp;&nbsp;&nbsp;&nbsp;
  * <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
  * @version 3.0
+ *
+ * @deprecated This interface is not used and will be removed in future.
  */
+@Deprecated
 public interface CacheService
 {