Refactor REST API to reference primitive types in URIs. (#760)

core/src/main/java/io/atomix/core/Atomix.java

@@ -664,9 +664,9 @@ public <E> WorkQueue<E> getWorkQueue(String name) {
   }
 
   @Override
-  public <P extends SyncPrimitive> CompletableFuture<P> getPrimitiveAsync(String name) {
+  public PrimitiveType getPrimitiveType(String typeName) {
     checkRunning();
-    return primitives.getPrimitiveAsync(name);
+    return primitives.getPrimitiveType(typeName);
   }
 
   @Override

core/src/main/java/io/atomix/core/PrimitivesService.java

@@ -103,18 +103,9 @@
 import io.atomix.core.workqueue.WorkQueue;
 import io.atomix.core.workqueue.WorkQueueBuilder;
 import io.atomix.core.workqueue.WorkQueueType;
-import io.atomix.primitive.PrimitiveBuilder;
-import io.atomix.primitive.PrimitiveInfo;
+import io.atomix.primitive.PrimitiveFactory;
 import io.atomix.primitive.PrimitiveType;
 import io.atomix.primitive.SyncPrimitive;
-import io.atomix.primitive.config.PrimitiveConfig;
-import io.atomix.utils.AtomixRuntimeException;
-
-import java.util.Collection;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutionException;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.TimeoutException;
 
 /**
  * Manages the creation of distributed primitive instances.
@@ -145,7 +136,7 @@
  *   }
  * </pre>
  */
-public interface PrimitivesService {
+public interface PrimitivesService extends PrimitiveFactory {
 
   /**
    * Creates a new named {@link DistributedMap} builder.
@@ -1508,193 +1499,4 @@ default TransactionBuilder transactionBuilder() {
    */
   <E> WorkQueue<E> getWorkQueue(String name);
 
-  /**
-   * Gets or creates a primitive.
-   * <p>
-   * A new primitive will be created if no primitive instance with the given {@code name} exists on this node, otherwise
-   * the existing instance will be returned. The name is used to reference a distinct instance of the primitive within
-   * the cluster. The returned primitive will share the same state with primitives of the same name on other nodes.
-   * <p>
-   * The constructed primitive will be based on any pre-existing primitive configuration for the given {@code name}.
-   * <p>
-   * To get an asynchronous instance of the primitive, use the {@link SyncPrimitive#async()} method:
-   * <pre>
-   *   {@code
-   *   AsyncPrimitive async = atomix.getPrimitive("my-primitive").async();
-   *   }
-   * </pre>
-   *
-   * @param name the primitive name
-   * @param <P> the primitive type
-   * @return the primitive instance
-   */
-  default <P extends SyncPrimitive> P getPrimitive(String name) {
-    try {
-      return this.<P>getPrimitiveAsync(name).get(30, TimeUnit.SECONDS);
-    } catch (InterruptedException | ExecutionException | TimeoutException e) {
-      throw new AtomixRuntimeException(e);
-    }
-  }
-
-  /**
-   * Gets or creates a distributed primitive.
-   * <p>
-   * A new primitive of the given {@code primitiveType} will be created if no primitive instance with the given
-   * {@code name} exists on this node, otherwise the existing instance will be returned. The name is used to reference
-   * a distinct instance of the primitive within the cluster. The returned primitive will share the same state with
-   * primitives of the same name on other nodes.
-   * <p>
-   * When the instance is initially constructed, it will be configured with any pre-existing primitive configuration
-   * defined in {@code atomix.conf}.
-   * <p>
-   * To get an asynchronous instance of the primitive, use the {@link SyncPrimitive#async()} method:
-   * <pre>
-   *   {@code
-   *   AsyncPrimitive async = atomix.getPrimitive("my-primitive").async();
-   *   }
-   * </pre>
-   *
-   * @param name the primitive name
-   * @param primitiveType the primitive type
-   * @param <P> the primitive type
-   * @return the primitive instance
-   */
-  default <P extends SyncPrimitive> P getPrimitive(String name, PrimitiveType<?, ?, P> primitiveType) {
-    try {
-      return getPrimitiveAsync(name, primitiveType).get(30, TimeUnit.SECONDS);
-    } catch (InterruptedException | ExecutionException | TimeoutException e) {
-      throw new AtomixRuntimeException(e);
-    }
-  }
-
-  /**
-   * Gets or creates a distributed primitive.
-   * <p>
-   * A new primitive of the given {@code primitiveType} will be created if no primitive instance with the given
-   * {@code name} exists on this node, otherwise the existing instance will be returned. The name is used to reference
-   * a distinct instance of the primitive within the cluster. The returned primitive will share the same state with
-   * primitives of the same name on other nodes.
-   * <p>
-   * When the instance is initially constructed, it will be configured with any pre-existing primitive configuration
-   * defined in {@code atomix.conf}.
-   * <p>
-   * To get an asynchronous instance of the primitive, use the {@link SyncPrimitive#async()} method:
-   * <pre>
-   *   {@code
-   *   AsyncPrimitive async = atomix.getPrimitive("my-primitive").async();
-   *   }
-   * </pre>
-   *
-   * @param name the primitive name
-   * @param primitiveType the primitive type
-   * @param primitiveConfig the primitive configuration
-   * @param <C> the primitive configuration type
-   * @param <P> the primitive type
-   * @return the primitive instance
-   */
-  default <C extends PrimitiveConfig<C>, P extends SyncPrimitive> P getPrimitive(
-      String name,
-      PrimitiveType<?, C, P> primitiveType,
-      C primitiveConfig) {
-    try {
-      return getPrimitiveAsync(name, primitiveType, primitiveConfig).get(30, TimeUnit.SECONDS);
-    } catch (InterruptedException | ExecutionException | TimeoutException e) {
-      throw new AtomixRuntimeException(e);
-    }
-  }
-
-  /**
-   * Gets or creates a primitive asynchronously.
-   * <p>
-   * A new primitive will be created if no primitive instance with the given {@code name} exists on this node, otherwise
-   * the existing instance will be returned. The name is used to reference a distinct instance of the primitive within
-   * the cluster. The returned primitive will share the same state with primitives of the same name on other nodes.
-   * <p>
-   * The constructed primitive will be based on any pre-existing primitive configuration for the given {@code name}.
-   *
-   * @param name the primitive name
-   * @param <P> the primitive type
-   * @return the primitive instance
-   */
-  <P extends SyncPrimitive> CompletableFuture<P> getPrimitiveAsync(String name);
-
-  /**
-   * Gets or creates a distributed primitive asynchronously.
-   * <p>
-   * A new primitive of the given {@code primitiveType} will be created if no primitive instance with the given
-   * {@code name} exists on this node, otherwise the existing instance will be returned. The name is used to reference
-   * a distinct instance of the primitive within the cluster. The returned primitive will share the same state with
-   * primitives of the same name on other nodes.
-   * <p>
-   * When the instance is initially constructed, it will be configured with any pre-existing primitive configuration
-   * defined in {@code atomix.conf}.
-   *
-   * @param name the primitive name
-   * @param primitiveType the primitive type
-   * @param <P> the primitive type
-   * @return the primitive instance
-   */
-  <P extends SyncPrimitive> CompletableFuture<P> getPrimitiveAsync(String name, PrimitiveType<?, ?, P> primitiveType);
-
-  /**
-   * Gets or creates a distributed primitive asynchronously.
-   * <p>
-   * A new primitive of the given {@code primitiveType} will be created if no primitive instance with the given
-   * {@code name} exists on this node, otherwise the existing instance will be returned. The name is used to reference
-   * a distinct instance of the primitive within the cluster. The returned primitive will share the same state with
-   * primitives of the same name on other nodes.
-   * <p>
-   * When the instance is initially constructed, it will be configured with any pre-existing primitive configuration
-   * defined in {@code atomix.conf}.
-   *
-   * @param name the primitive name
-   * @param primitiveType the primitive type
-   * @param primitiveConfig the primitive configuration
-   * @param <C> the primitive configuration type
-   * @param <P> the primitive type
-   * @return a future to be completed with the primitive instance
-   */
-  <C extends PrimitiveConfig<C>, P extends SyncPrimitive> CompletableFuture<P> getPrimitiveAsync(
-      String name, PrimitiveType<?, C, P> primitiveType, C primitiveConfig);
-
-  /**
-   * Creates a new named primitive builder of the given {@code primitiveType}.
-   * <p>
-   * The primitive name must be provided when constructing the builder. The name is used to reference a distinct instance of
-   * the primitive within the cluster. Multiple instances of the primitive with the same name will share the same state.
-   * However, the instance of the primitive constructed by the returned builder will be distinct and will not share
-   * local memory (e.g. cache) with any other instance on this node.
-   * <p>
-   * To get an asynchronous instance of the primitive, use the {@link SyncPrimitive#async()} method:
-   * <pre>
-   *   {@code
-   *   AsyncPrimitive async = atomix.primitiveBuilder("my-primitive", MyPrimitiveType.instance()).build().async();
-   *   }
-   * </pre>
-   *
-   * @param name the primitive name
-   * @param primitiveType the primitive type
-   * @param <B> the primitive builder type
-   * @param <P> the primitive type
-   * @return the primitive builder
-   */
-  <B extends PrimitiveBuilder<B, C, P>, C extends PrimitiveConfig<C>, P extends SyncPrimitive> B primitiveBuilder(
-      String name,
-      PrimitiveType<B, C, P> primitiveType);
-
-  /**
-   * Returns a collection of open primitives.
-   *
-   * @return a collection of open primitives
-   */
-  Collection<PrimitiveInfo> getPrimitives();
-
-  /**
-   * Returns a collection of open primitives of the given type.
-   *
-   * @param primitiveType the primitive type
-   * @return a collection of open primitives of the given type
-   */
-  Collection<PrimitiveInfo> getPrimitives(PrimitiveType primitiveType);
-
 }

core/src/main/java/io/atomix/core/collection/impl/DistributedCollectionResource.java

@@ -17,6 +17,8 @@
 
 import com.google.common.collect.Sets;
 import io.atomix.core.collection.AsyncDistributedCollection;
+import io.atomix.core.collection.DistributedCollectionConfig;
+import io.atomix.primitive.PrimitiveType;
 import io.atomix.primitive.resource.PrimitiveResource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -35,26 +37,36 @@
 /**
  * Distributed collection resource.
  */
-public abstract class DistributedCollectionResource implements PrimitiveResource {
+public abstract class DistributedCollectionResource<P extends AsyncDistributedCollection<String>, C extends DistributedCollectionConfig<C>> extends PrimitiveResource<P, C> {
   private final Logger LOGGER = LoggerFactory.getLogger(getClass());
 
-  private final AsyncDistributedCollection<String> collection;
-
-  public DistributedCollectionResource(AsyncDistributedCollection<String> collection) {
-    this.collection = collection;
+  protected DistributedCollectionResource(PrimitiveType type) {
+    super(type);
   }
 
   @GET
+  @Path("/{name}")
   @Produces(MediaType.APPLICATION_JSON)
-  public void get(@Suspended AsyncResponse response) {
-    response.resume(Response.ok(Sets.newHashSet(collection.iterator().sync())));
+  public void get(
+      @PathParam("name") String name,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).whenComplete((collection, error) -> {
+      if (error == null) {
+        response.resume(Response.ok(Sets.newHashSet(collection.iterator().sync())));
+      } else {
+        response.resume(Response.serverError().build());
+      }
+    });
   }
 
   @PUT
-  @Path("/{element}")
+  @Path("/{name}/{element}")
   @Produces(MediaType.APPLICATION_JSON)
-  public void add(@PathParam("element") String element, @Suspended AsyncResponse response) {
-    collection.add(element).whenComplete((result, error) -> {
+  public void add(
+      @PathParam("name") String name,
+      @PathParam("element") String element,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).thenCompose(collection -> collection.add(element)).whenComplete((result, error) -> {
       if (error == null) {
         response.resume(Response.ok(result).build());
       } else {
@@ -65,10 +77,13 @@ public void add(@PathParam("element") String element, @Suspended AsyncResponse r
   }
 
   @GET
-  @Path("/{element}")
+  @Path("/{name}/{element}")
   @Produces(MediaType.APPLICATION_JSON)
-  public void contains(@PathParam("element") String element, @Suspended AsyncResponse response) {
-    collection.contains(element).whenComplete((result, error) -> {
+  public void contains(
+      @PathParam("name") String name,
+      @PathParam("element") String element,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).thenCompose(collection -> collection.contains(element)).whenComplete((result, error) -> {
       if (error == null) {
         response.resume(Response.ok(result).build());
       } else {
@@ -79,10 +94,13 @@ public void contains(@PathParam("element") String element, @Suspended AsyncRespo
   }
 
   @DELETE
-  @Path("/{element}")
+  @Path("/{name}/{element}")
   @Produces(MediaType.APPLICATION_JSON)
-  public void remove(@PathParam("element") String element, @Suspended AsyncResponse response) {
-    collection.remove(element).whenComplete((result, error) -> {
+  public void remove(
+      @PathParam("name") String name,
+      @PathParam("element") String element,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).thenCompose(collection -> collection.remove(element)).whenComplete((result, error) -> {
       if (error == null) {
         response.resume(Response.ok(result).build());
       } else {
@@ -93,10 +111,12 @@ public void remove(@PathParam("element") String element, @Suspended AsyncRespons
   }
 
   @GET
-  @Path("/size")
+  @Path("/{name}/size")
   @Produces(MediaType.APPLICATION_JSON)
-  public void size(@Suspended AsyncResponse response) {
-    collection.size().whenComplete((result, error) -> {
+  public void size(
+      @PathParam("name") String name,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).thenCompose(collection -> collection.size()).whenComplete((result, error) -> {
       if (error == null) {
         response.resume(Response.ok(result).build());
       } else {
@@ -107,8 +127,11 @@ public void size(@Suspended AsyncResponse response) {
   }
 
   @DELETE
-  public void clear(@Suspended AsyncResponse response) {
-    collection.clear().whenComplete((result, error) -> {
+  @Path("/{name}")
+  public void clear(
+      @PathParam("name") String name,
+      @Suspended AsyncResponse response) {
+    getPrimitive(name).thenCompose(collection -> collection.clear()).whenComplete((result, error) -> {
       if (error == null) {
         response.resume(Response.ok().build());
       } else {

core/src/main/java/io/atomix/core/counter/AtomicCounterType.java

@@ -15,12 +15,11 @@
  */
 package io.atomix.core.counter;
 
-import io.atomix.core.counter.impl.DefaultAtomicCounterBuilder;
 import io.atomix.core.counter.impl.AtomicCounterResource;
+import io.atomix.core.counter.impl.DefaultAtomicCounterBuilder;
 import io.atomix.core.counter.impl.DefaultAtomicCounterService;
 import io.atomix.primitive.PrimitiveManagementService;
 import io.atomix.primitive.PrimitiveType;
-import io.atomix.primitive.resource.PrimitiveResource;
 import io.atomix.primitive.service.PrimitiveService;
 import io.atomix.primitive.service.ServiceConfig;
 
@@ -53,8 +52,8 @@ public PrimitiveService newService(ServiceConfig config) {
   }
 
   @Override
-  public PrimitiveResource newResource(AtomicCounter primitive) {
-    return new AtomicCounterResource(primitive.async());
+  public Class<?> getResourceClass() {
+    return AtomicCounterResource.class;
   }
 
   @Override