object store tuning

README.md

@@ -605,6 +605,7 @@ Subscription creation has many checks to make sure that a valid, operable subscr
 | OsGetChunksMismatch                          | OS    | 90206 | Number of chunks does not match meta data.                                                          |
 | OsGetSizeMismatch                            | OS    | 90207 | Total size does not match meta data.                                                                |
 | OsGetLinkToBucket                            | OS    | 90208 | Cannot get object, it is a link to a bucket.                                                        |
+| OsLinkNotAllowOnPut                          | OS    | 90209 | Link not allowed in metadata when putting an object.                                                |
 | JsConsumerCreate290NotAvailable              | CON   | 90301 | Name field not valid when v2.9.0 consumer create api is not available.                              |
 | JsConsumerNameDurableMismatch                | CON   | 90302 | Name must match durable if both are supplied.                                                       |
 

src/main/java/io/nats/client/ObjectStore.java

@@ -97,7 +97,7 @@ public interface ObjectStore {
     ObjectInfo get(String objectName, OutputStream outputStream) throws IOException, JetStreamApiException, InterruptedException, NoSuchAlgorithmException;
 
     /**
-     * Get the info for an object if the object exists or did exist and is now deleted.
+     * Get the info for an object if the object exists / is not deleted.
      * OBJECT STORE IMPLEMENTATION IS EXPERIMENTAL AND SUBJECT TO CHANGE.
      * @param objectName The name of the object
      * @return the ObjectInfo for the object name or throw an exception if it does not exist.
@@ -106,6 +106,17 @@ public interface ObjectStore {
      */
     ObjectInfo getInfo(String objectName) throws IOException, JetStreamApiException;
 
+    /**
+     * Get the info for an object if the object exists, optionally including deleted.
+     * OBJECT STORE IMPLEMENTATION IS EXPERIMENTAL AND SUBJECT TO CHANGE.
+     * @param objectName The name of the object
+     * @param includingDeleted whether to return info for deleted objects
+     * @return the ObjectInfo for the object name or throw an exception if it does not exist.
+     * @throws IOException covers various communication issues with the NATS server such as timeout or interruption
+     * @throws JetStreamApiException the request had an error related to the data
+     */
+    ObjectInfo getInfo(String objectName, boolean includingDeleted) throws IOException, JetStreamApiException;
+
     /**
      * Update the metadata of name, description or headers. All other changes are ignored.
      * OBJECT STORE IMPLEMENTATION IS EXPERIMENTAL AND SUBJECT TO CHANGE.

src/main/java/io/nats/client/impl/NatsObjectStore.java

@@ -106,6 +106,9 @@ public ObjectInfo put(ObjectMeta meta, InputStream inputStream) throws IOExcepti
         Validator.validateNotNull(meta, "ObjectMeta");
         Validator.validateNotNull(meta.getObjectName(), "ObjectMeta name");
         Validator.validateNotNull(inputStream, "InputStream");
+        if (meta.getObjectMetaOptions().getLink() != null) {
+            throw OsLinkNotAllowOnPut.instance();
+        }
 
         String nuid = NUID.nextGlobal();
         String chunkSubject = pubSubChunkSubject(nuid);
@@ -191,8 +194,8 @@ public ObjectInfo put(File file) throws IOException, JetStreamApiException, NoSu
      */
     @Override
     public ObjectInfo get(String objectName, OutputStream out) throws IOException, JetStreamApiException, InterruptedException, NoSuchAlgorithmException {
-        ObjectInfo oi = getInfo(objectName);
-        if (oi == null || oi.isDeleted()) {
+        ObjectInfo oi = getInfo(objectName, false);
+        if (oi == null) {
             throw OsObjectNotFound.instance();
         }
 
@@ -266,8 +269,20 @@ public ObjectInfo get(String objectName, OutputStream out) throws IOException, J
      */
     @Override
     public ObjectInfo getInfo(String objectName) throws IOException, JetStreamApiException {
+        return getInfo(objectName, false);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ObjectInfo getInfo(String objectName, boolean includingDeleted) throws IOException, JetStreamApiException {
         MessageInfo mi = _getLast(rawMetaSubject(objectName));
-        return mi == null ? null : new ObjectInfo(mi);
+        if (mi == null) {
+            return null;
+        }
+        ObjectInfo info = new ObjectInfo(mi);
+        return includingDeleted || !info.isDeleted() ? info : null;
     }
 
     /**
@@ -279,7 +294,7 @@ public ObjectInfo updateMeta(String objectName, ObjectMeta meta) throws IOExcept
         Validator.validateNotNull(meta, "ObjectMeta");
         Validator.validateNotNull(meta.getObjectName(), "ObjectMeta name");
 
-        ObjectInfo currentInfo = getInfo(objectName);
+        ObjectInfo currentInfo = getInfo(objectName, true);
         if (currentInfo == null) {
             throw OsObjectNotFound.instance();
         }
@@ -289,8 +304,7 @@ public ObjectInfo updateMeta(String objectName, ObjectMeta meta) throws IOExcept
 
         boolean nameChange = !objectName.equals(meta.getObjectName());
         if (nameChange) {
-            ObjectInfo infoForNewName = getInfo(meta.getObjectName());
-            if (infoForNewName != null && !infoForNewName.isDeleted()) {
+            if (getInfo(meta.getObjectName(), false) != null) {
                 throw OsObjectAlreadyExists.instance();
             }
         }
@@ -314,7 +328,7 @@ public ObjectInfo updateMeta(String objectName, ObjectMeta meta) throws IOExcept
      */
     @Override
     public ObjectInfo delete(String objectName) throws IOException, JetStreamApiException {
-        ObjectInfo info = getInfo(objectName);
+        ObjectInfo info = getInfo(objectName, true);
         if (info == null) {
             throw OsObjectNotFound.instance();
         }
@@ -351,8 +365,8 @@ public ObjectInfo addLink(String objectName, ObjectInfo toInfo) throws IOExcepti
             throw OsCantLinkToLink.instance();
         }
 
-        ObjectInfo info = getInfo(objectName);
-        if (info != null && !info.isDeleted() && !info.isLink()) {
+        ObjectInfo info = getInfo(objectName, false);
+        if (info != null && !info.isLink()) {
             throw OsObjectAlreadyExists.instance();
         }
 
@@ -370,8 +384,8 @@ public ObjectInfo addBucketLink(String objectName, ObjectStore toStore) throws I
         Validator.validateNotNull(objectName, "object name");
         Validator.validateNotNull(toStore, "Link-To ObjectStore");
 
-        ObjectInfo info = getInfo(objectName);
-        if (info != null && !info.isDeleted() && !info.isLink()) {
+        ObjectInfo info = getInfo(objectName, false);
+        if (info != null && !info.isLink()) {
             throw OsObjectAlreadyExists.instance();
         }
 

src/main/java/io/nats/client/support/NatsJetStreamClientError.java

@@ -60,11 +60,11 @@ public class NatsJetStreamClientError {
     public static final NatsJetStreamClientError OsGetChunksMismatch = new NatsJetStreamClientError(OS, 90206, "Number of chunks does not match meta data.");
     public static final NatsJetStreamClientError OsGetSizeMismatch = new NatsJetStreamClientError(OS, 90207, "Total size does not match meta data.");
     public static final NatsJetStreamClientError OsGetLinkToBucket = new NatsJetStreamClientError(OS, 90208, "Cannot get object, it is a link to a bucket.");
+    public static final NatsJetStreamClientError OsLinkNotAllowOnPut = new NatsJetStreamClientError(OS, 90209, "Link not allowed in metadata when putting an object.");
 
     public static final NatsJetStreamClientError JsConsumerCreate290NotAvailable = new NatsJetStreamClientError(CON, 90301, "Name field not valid when v2.9.0 consumer create api is not available.");
     public static final NatsJetStreamClientError JsConsumerNameDurableMismatch = new NatsJetStreamClientError(CON, 90302, "Name must match durable if both are supplied.");
 
-
     @Deprecated // Fixed spelling error
     public static final NatsJetStreamClientError JsSubFcHbHbNotValidQueue = new NatsJetStreamClientError(SUB, 90006, "Flow Control and/or heartbeat is not valid in queue mode.");
 

src/test/java/io/nats/client/impl/ObjectStoreTests.java

@@ -350,8 +350,10 @@ public void testObjectLinks() throws Exception {
             ObjectInfo targetWillBeDeleted = os2.addLink("targetWillBeDeleted", info21);
             validateLink(targetWillBeDeleted, "targetWillBeDeleted", info21, null);
             os2.delete(info21.getObjectName());
-            ObjectInfo oiDeleted = os2.getInfo(info21.getObjectName());
-            assertTrue(oiDeleted.isDeleted()); // object is deleted
+            ObjectInfo oiDeleted = os2.getInfo(info21.getObjectName(), true);
+            assertTrue(oiDeleted.isDeleted()); // object is deleted but includingDeleted = true
+            assertNull(os2.getInfo(info21.getObjectName())); // does includingDeleted = false
+            assertNull(os2.getInfo(info21.getObjectName(), false)); // explicit includingDeleted = false
             assertClientError(OsObjectIsDeleted, () -> os2.addLink("willException", oiDeleted));
             ObjectInfo oiLink = os2.getInfo("targetWillBeDeleted");
             assertNotNull(oiLink); // link is still there but link target is deleted
@@ -364,6 +366,9 @@ public void testObjectLinks() throws Exception {
             assertEquals(info12, crossInfo12);
             assertEquals(2, baos.size());
             assertEquals("12", baos.toString());
+
+            ObjectMeta linkInPut = ObjectMeta.builder("linkInPut").link(ObjectLink.object("na", "na")).build();
+            assertClientError(OsLinkNotAllowOnPut, () -> os2.put(linkInPut, new ByteArrayInputStream("na".getBytes())));
         });
     }
 
@@ -389,7 +394,7 @@ private void validateLink(ObjectInfo oiLink, String linkName, ObjectInfo targetI
     }
 
     @Test
-    public void testObjectList() throws Exception {
+    public void testList() throws Exception {
         runInJsServer(nc -> {
             ObjectStoreManagement osm = nc.objectStoreManagement();
             osm.create(ObjectStoreConfiguration.builder(BUCKET).storageType(StorageType.Memory).build());