Merge branch 'release/1.44.0'

HCL-TECH-SOFTWARE · Oct 30, 2024 · 49abd16 · 49abd16
2 parents 21fd211 + 194c70c
commit 49abd16
Show file tree

Hide file tree

Showing 29 changed files with 207 additions and 21 deletions.
diff --git a/domino-jnx-api/pom.xml b/domino-jnx-api/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
   </parent>
   <artifactId>domino-jnx-api</artifactId>
   <name>HCL Domino API</name>

diff --git a/domino-jnx-api/src/main/java/com/hcl/domino/admin/ServerAdmin.java b/domino-jnx-api/src/main/java/com/hcl/domino/admin/ServerAdmin.java
@@ -469,4 +469,22 @@ void registerCrossCertificate(String certFilePath, String certPW, String certLog
    */
   String sendConsoleCommand(String server, String command);
 
+
+  /**
+   * Retrieves the current addin's default status line.
+   * 
+   * @return a {@link ServerStatusLine} for the current addin's default
+   * @since 1.44.0
+   */
+  ServerStatusLine getDefaultServerStatusLine();
+
+  /**
+   * Sets the provided status line as the default for the current addin.
+   * 
+   * @param statusLine a {@link ServerStatusLine} to make the default,
+   *        must be non-null
+   * @since 1.44.0
+   */
+  void setDefaultServerStatusLine(ServerStatusLine statusLine);
+
 }
diff --git a/domino-jnx-api/src/main/java/com/hcl/domino/constants/Nif.java b/domino-jnx-api/src/main/java/com/hcl/domino/constants/Nif.java
@@ -0,0 +1,27 @@
+/*
+ * ==========================================================================
+ * Copyright (C) 2019-2024 HCL America, Inc. ( http://www.hcl.com/ )
+ *                            All rights reserved.
+ * ==========================================================================
+ * Licensed under the  Apache License, Version 2.0  (the "License").  You may
+ * not use this file except in compliance with the License.  You may obtain a
+ * copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>.
+ *
+ * Unless  required  by applicable  law or  agreed  to  in writing,  software
+ * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the  specific language  governing permissions  and limitations
+ * under the License.
+ * ==========================================================================
+ */
+package com.hcl.domino.constants;
+
+/**
+ * Represents constants originally from the {@code editods.h} header file.
+ * 
+ * @author Jesse Gallagher
+ * @since 1.44.0
+ */
+public interface Nif {
+  int PERCENTILE_COUNT = 11;
+}
diff --git a/domino-jnx-api/src/main/java/com/hcl/domino/data/DominoCollection.java b/domino-jnx-api/src/main/java/com/hcl/domino/data/DominoCollection.java
@@ -21,7 +21,7 @@
 import java.util.List;
 import java.util.Set;
 import java.util.function.BiConsumer;
-
+import com.hcl.domino.data.structures.CollectionData;
 import com.hcl.domino.misc.DominoClientDescendant;
 import com.hcl.domino.misc.Loop;
 
@@ -95,6 +95,17 @@ public enum Direction {
    * @return sorted set of note ids
    */
   Set<Integer> getAllIdsByKey(Set<Find> findFlags, Object key);
+
+  /**
+   * Retrieve detailed information about the collection itself, such
+   * as the number of documents in the collection and the total size
+   * of the document entries in the collection.
+   * 
+   * @return a {@link CollectionData} instance representing information
+   *         about the collection
+   * @since 1.44.0
+   */
+  CollectionData getCollectionData();
 
   List<CollectionColumn> getColumns();
 

diff --git a/domino-jnx-api/src/main/java/com/hcl/domino/data/structures/CollectionData.java b/domino-jnx-api/src/main/java/com/hcl/domino/data/structures/CollectionData.java
@@ -0,0 +1,53 @@
+/*
+ * ==========================================================================
+ * Copyright (C) 2019-2024 HCL America, Inc. ( http://www.hcl.com/ )
+ *                            All rights reserved.
+ * ==========================================================================
+ * Licensed under the  Apache License, Version 2.0  (the "License").  You may
+ * not use this file except in compliance with the License.  You may obtain a
+ * copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>.
+ *
+ * Unless  required  by applicable  law or  agreed  to  in writing,  software
+ * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the  specific language  governing permissions  and limitations
+ * under the License.
+ * ==========================================================================
+ */
+package com.hcl.domino.data.structures;
+
+import com.hcl.domino.misc.NotesConstants;
+import com.hcl.domino.richtext.annotation.StructureDefinition;
+import com.hcl.domino.richtext.annotation.StructureGetter;
+import com.hcl.domino.richtext.annotation.StructureMember;
+import com.hcl.domino.richtext.structures.MemoryStructure;
+
+/**
+ * Represents aggregate data about a view or folder.
+ * 
+ * @since 1.44.0
+ */
+@StructureDefinition(
+    name = "COLLECTIONDATA",
+    members = {
+      @StructureMember(name = "DocCount", type = int.class, unsigned = true),
+      @StructureMember(name = "DocTotalSize", type = int.class, unsigned = true),
+      @StructureMember(name = "BTreeLeafNodes", type = int.class, unsigned = true),
+      @StructureMember(name = "BTreeDepth", type = short.class, unsigned = true),
+      @StructureMember(name = "Spare", type = short.class),
+      @StructureMember(name = "KeyOffset", type = int[].class, unsigned = true, length = NotesConstants.PERCENTILE_COUNT)
+    }
+  )
+public interface CollectionData extends MemoryStructure {
+  @StructureGetter("DocCount")
+  long getDocCount();
+
+  @StructureGetter("DocTotalSize")
+  long getDocTotalSize();
+
+  @StructureGetter("BTreeLeafNodes")
+  long getLeafNodeCount();
+
+  @StructureGetter("BTreeDepth")
+  int getDepth();
+}
diff --git a/domino-jnx-api/src/main/java/com/hcl/domino/misc/NotesConstants.java b/domino-jnx-api/src/main/java/com/hcl/domino/misc/NotesConstants.java
@@ -18,13 +18,14 @@
 
 import com.hcl.domino.constants.Bsafe;
 import com.hcl.domino.constants.EditOds;
+import com.hcl.domino.constants.Nif;
 import com.hcl.domino.constants.OleOds;
 import com.hcl.domino.constants.QueryOds;
 import com.hcl.domino.constants.Stats;
 import com.hcl.domino.constants.StdNames;
 import com.hcl.domino.constants.VmOds;
 
-public interface NotesConstants extends ViewFormatConstants, StdNames, QueryOds, EditOds, OleOds, VmOds, Bsafe, Stats {
+public interface NotesConstants extends ViewFormatConstants, StdNames, QueryOds, EditOds, OleOds, VmOds, Bsafe, Stats, Nif {
 
   public enum AgentCheck {
     CheckRights(0),

diff --git a/domino-jnx-commons/pom.xml b/domino-jnx-commons/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
   </parent>
   <artifactId>domino-jnx-commons</artifactId>
   <name>HCL Domino API Common Code</name>

diff --git a/domino-jnx-console/pom.xml b/domino-jnx-console/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
   </parent>
   <artifactId>domino-jnx-console</artifactId>
   <name>HCL Domino API Server Controller Connector</name>

diff --git a/domino-jnx-jna/pom.xml b/domino-jnx-jna/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
   </parent>
   <artifactId>domino-jnx-jna</artifactId>
   <name>HCL Domino API, JNA Implementation</name>

diff --git a/domino-jnx-jna/src/main/java/com/hcl/domino/jna/admin/JNAServerAdmin.java b/domino-jnx-jna/src/main/java/com/hcl/domino/jna/admin/JNAServerAdmin.java
@@ -23,6 +23,7 @@
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicInteger;
 
 import com.hcl.domino.DominoClient;
@@ -83,6 +84,7 @@
 import com.sun.jna.Memory;
 import com.sun.jna.Pointer;
 import com.sun.jna.ptr.IntByReference;
+import com.sun.jna.ptr.LongByReference;
 import com.sun.jna.ptr.PointerByReference;
 import com.sun.jna.ptr.ShortByReference;
 
@@ -490,6 +492,29 @@ public ServerStatusLine createServerStatusLine(String taskName) {
 		long hDesc = NotesCAPI.get().AddInCreateStatusLine(NotesStringUtils.toLMBCS(taskName, true));
 		return new JNAServerStatusLine(getParentDominoClient(), hDesc);
 	}
+
+    @Override
+    public ServerStatusLine getDefaultServerStatusLine() {
+      LongByReference rethModule = new LongByReference();
+      LongByReference rethDesc = new LongByReference();
+      NotesCAPI.get().AddInQueryDefaults(rethModule, rethDesc);
+      return new JNAServerStatusLine(getParentDominoClient(), rethDesc.getValue());
+    }
+
+    @Override
+    public void setDefaultServerStatusLine(ServerStatusLine statusLine) {
+      Objects.requireNonNull(statusLine, "statusLine cannot be null");
+      if(!(statusLine instanceof JNAServerStatusLine)) {
+        throw new IllegalArgumentException(MessageFormat.format("Unable to handle ServerStatusLine of type {0}", statusLine.getClass().getName()));
+      }
+      JNAServerStatusLine jnaLine = (JNAServerStatusLine)statusLine;
+
+      LongByReference rethModule = new LongByReference();
+      LongByReference rethDesc = new LongByReference();
+      NotesCAPI.get().AddInQueryDefaults(rethModule, rethDesc);
+      rethDesc.setValue(jnaLine.getAdapter(long.class));
+      NotesCAPI.get().AddInSetDefaults(rethModule.getValue(), rethDesc.getValue());
+    }
 
 	@Override
 	public void openServerConsole(String serverName, ConsoleHandler handler) {

diff --git a/domino-jnx-jna/src/main/java/com/hcl/domino/jna/data/JNADominoCollection.java b/domino-jnx-jna/src/main/java/com/hcl/domino/jna/data/JNADominoCollection.java
@@ -17,6 +17,7 @@
 package com.hcl.domino.jna.data;
 
 import java.lang.ref.ReferenceQueue;
+import java.nio.ByteBuffer;
 import java.text.Collator;
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -46,6 +47,7 @@
 import com.hcl.domino.commons.gc.APIObjectAllocations;
 import com.hcl.domino.commons.gc.IAPIObject;
 import com.hcl.domino.commons.gc.IGCDominoClient;
+import com.hcl.domino.commons.structures.MemoryStructureUtil;
 import com.hcl.domino.commons.util.NotesErrorUtils;
 import com.hcl.domino.commons.util.PlatformUtils;
 import com.hcl.domino.commons.util.StringTokenizerExt;
@@ -59,6 +61,7 @@
 import com.hcl.domino.data.CollectionSearchQuery.CollectionEntryProcessor;
 import com.hcl.domino.data.Database;
 import com.hcl.domino.data.Database.Action;
+import com.hcl.domino.data.structures.CollectionData;
 import com.hcl.domino.data.Document;
 import com.hcl.domino.data.DominoCollection;
 import com.hcl.domino.data.DominoDateTime;
@@ -71,6 +74,7 @@
 import com.hcl.domino.jna.JNADominoClient;
 import com.hcl.domino.jna.data.CollectionDataCache.CacheState;
 import com.hcl.domino.jna.data.JNACollectionEntry.CacheableViewEntryData;
+import com.hcl.domino.jna.internal.Mem;
 import com.hcl.domino.jna.internal.callbacks.NotesCallbacks;
 import com.hcl.domino.jna.internal.callbacks.Win32NotesCallbacks;
 import com.hcl.domino.jna.internal.capi.NotesCAPI;
@@ -1734,6 +1738,33 @@ private short getCollation() {
 		return retCollationNum.getValue();
 	}
 
+    @Override
+    public CollectionData getCollectionData() {
+      checkDisposed();
+
+      final DHANDLE.ByReference rethCollData = DHANDLE.newInstanceByReference();
+
+      LockUtil.lockHandle(getAllocations().getCollectionHandle(), hCollectionByVal ->
+        NotesCAPI.get().NIFGetCollectionData(hCollectionByVal, rethCollData)
+      );
+
+      return LockUtil.lockHandle(rethCollData, hCollData -> {
+        CollectionData result = Mem.OSLockObject(hCollData, ptr -> {
+          int len = MemoryStructureUtil.sizeOf(CollectionData.class);
+          byte[] data = new byte[len];
+          ptr.read(0, data, 0, len);
+
+          ByteBuffer buf = ByteBuffer.wrap(data);
+
+          return MemoryStructureUtil.forStructure(CollectionData.class, () -> buf);
+        });
+
+        Mem.OSMemFree(hCollData);
+
+        return result;
+      });
+    }
+
 	@Override
 	public LinkedHashSet<Integer> getAllIds(boolean withDocuments, boolean withCategories) {
 		if (!withDocuments && !withCategories) {

diff --git a/domino-jnx-jna/src/main/java/com/hcl/domino/jna/internal/capi/INotesCAPI.java b/domino-jnx-jna/src/main/java/com/hcl/domino/jna/internal/capi/INotesCAPI.java
@@ -687,6 +687,14 @@ short NIFOpenCollectionWithUserNameList (HANDLE.ByValue hViewDB, HANDLE.ByValue
 
 	short NIFGetCollation(DHANDLE.ByValue hCollection, ShortByReference retCollationNum);
 	short NIFSetCollation(DHANDLE.ByValue hCollection, short CollationNum);
+	/**
+	 * Retrieve detailed information about the collection itself, such as the number of documents
+	 * in the collection and the total size of the document entries in the collection.
+	 * 
+	 * @since Notes/Domino 4.0
+	 * @since 1.44.0
+	 */
+	short NIFGetCollectionData(DHANDLE.ByValue hCollection, DHANDLE.ByReference rethCollData);
 	short NIFUpdateCollection(DHANDLE.ByValue hCollection);
 
 	@UndocumentedAPI
@@ -2205,6 +2213,8 @@ default boolean AddInMinutesHaveElapsed(int Minutes) {
 	boolean AddInShouldTerminate();
 	long AddInCreateStatusLine(Memory TaskName);
 	void AddInDeleteStatusLine(long hDesc);
+	void AddInQueryDefaults(LongByReference rethModule, LongByReference rethDesc);
+	void AddInSetDefaults(long hNewModule, long hDesc);
 	void AddInSetStatusLine(long hDesc, Memory string);
 	void OSPreemptOccasionally();
 

diff --git a/domino-jnx-jna/src/main/java/com/hcl/domino/jna/server/JNAServerStatusLine.java b/domino-jnx-jna/src/main/java/com/hcl/domino/jna/server/JNAServerStatusLine.java
@@ -55,5 +55,14 @@ public void setLine(String line) {
 		Memory string = NotesStringUtils.toLMBCS(line, true);
 		NotesCAPI.get().AddInSetStatusLine(hDesc, string);
 	}
+
+    @SuppressWarnings("unchecked")
+    @Override
+    protected <T> T getAdapterLocal(Class<T> clazz) {
+      if(long.class.equals(clazz) || Long.class.equals(clazz)) {
+        return (T)Long.valueOf(getAllocations().getLineHandle());
+      }
+      return super.getAdapterLocal(clazz);
+    }
 
 }
diff --git a/example/jnx-example-domino-servlet/pom.xml b/example/jnx-example-domino-servlet/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-domino-servlet</artifactId>

diff --git a/example/jnx-example-domino-webapp-admin/pom.xml b/example/jnx-example-domino-webapp-admin/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-domino-webapp-admin</artifactId>

diff --git a/example/jnx-example-gluon/pom.xml b/example/jnx-example-gluon/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-gluon</artifactId>

diff --git a/example/jnx-example-graalvm-native/pom.xml b/example/jnx-example-graalvm-native/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-graalvm-native</artifactId>

diff --git a/example/jnx-example-runjava/pom.xml b/example/jnx-example-runjava/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-runjava</artifactId>

diff --git a/example/jnx-example-swt/pom.xml b/example/jnx-example-swt/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-swt</artifactId>

diff --git a/example/jnx-example-webapp/pom.xml b/example/jnx-example-webapp/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>com.hcl.domino</groupId>
     <artifactId>domino-jnx</artifactId>
-    <version>1.43.0</version>
+    <version>1.44.0</version>
     <relativePath>../..</relativePath>
   </parent>
   <artifactId>jnx-example-webapp</artifactId>