reswqa commented on code in PR #28402:
URL: https://github.com/apache/flink/pull/28402#discussion_r3401700731


##########
flink-runtime-web/src/main/java/org/apache/flink/runtime/webmonitor/history/ArchiveStorage.java:
##########
@@ -0,0 +1,94 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.flink.runtime.webmonitor.history;
+
+import javax.annotation.Nullable;
+
+import java.io.Closeable;
+import java.io.IOException;
+import java.util.List;
+
+/**
+ * Abstraction for the storage backend used by the {@link HistoryServer} to 
access archived job
+ * data.
+ *
+ * <p>Implementations can be backed by the local file system, RocksDB, or any 
other storage medium.
+ *
+ * @param <T> Type of the storage entries.
+ */
+public interface ArchiveStorage<T> extends Closeable {
+
+    /**
+     * Returns whether the entry identified by {@code key} exists in this 
storage.
+     *
+     * @param key storage key (typically the request path, e.g. {@code 
/jobs/xxx/config.json})
+     * @return {@code true} if the entry exists
+     */
+    boolean exists(String key) throws IOException;
+
+    /**
+     * Returns the entry identified by {@code key} from this storage.
+     *
+     * @param key storage key
+     * @return the entry, or null if the entry does not exist
+     * @throws IOException if the entry cannot be read
+     */
+    @Nullable
+    T get(String key) throws IOException;

Review Comment:
   This is not a well-defined protocol as "put" and "get" method is not 
symmetrical.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to