1 files changed, 47 insertions, 0 deletions
diff --git a/lib/public/Files/ObjectStore/IObjectStoreMetaData.php b/lib/public/Files/ObjectStore/IObjectStoreMetaData.php
new file mode 100644
index 00000000000..9683873be36
--- /dev/null
+++ b/lib/public/Files/ObjectStore/IObjectStoreMetaData.php
@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP\Files\ObjectStore;
+
+/**
+ * Interface IObjectStoreMetaData
+ *
+ * @psalm-type ObjectMetaData = array{mtime?: \DateTime, etag?: string, size?: int, mimetype?: string, filename?: string, original-path?: string, original-storage?: string}
+ *
+ * @since 32.0.0
+ */
+interface IObjectStoreMetaData {
+	/**
+	 * Get metadata for an object.
+	 *
+	 * @param string $urn
+	 * @return ObjectMetaData
+	 *
+	 * @since 32.0.0
+	 */
+	public function getObjectMetaData(string $urn): array;
+
+	/**
+	 * List all objects in the object store.
+	 *
+	 * If the object store implementation can do it efficiently, the metadata for each object is also included.
+	 *
+	 * @param string $prefix
+	 * @return \Iterator<array{urn: string, metadata: ?ObjectMetaData}>
+	 *
+	 * @since 32.0.0
+	 */
+	public function listObjects(string $prefix = ''): \Iterator;
+
+	/**
+	 * @param string $urn the unified resource name used to identify the object
+	 * @param resource $stream stream with the data to write
+	 * @param ObjectMetaData $metaData the metadata to set for the object
+	 * @throws \Exception when something goes wrong, message will be logged
+	 * @since 32.0.0
+	 */
+	public function writeObjectWithMetaData(string $urn, $stream, array $metaData): void;
+}