Github user revans2 commented on a diff in the pull request:
https://github.com/apache/storm/pull/845#discussion_r46203383
--- Diff: storm-core/src/jvm/backtype/storm/blobstore/ClientBlobStore.java
---
@@ -0,0 +1,62 @@
+/**
+ * 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 backtype.storm.blobstore;
+
+import backtype.storm.daemon.Shutdownable;
+import backtype.storm.generated.AuthorizationException;
+import backtype.storm.generated.ReadableBlobMeta;
+import backtype.storm.generated.SettableBlobMeta;
+import backtype.storm.generated.KeyAlreadyExistsException;
+import backtype.storm.generated.KeyNotFoundException;
+import backtype.storm.utils.NimbusClient;
+
+import java.util.Iterator;
+import java.util.Map;
+
+public abstract class ClientBlobStore implements Shutdownable {
+ protected Map conf;
+
+ public abstract void prepare(Map conf);
+ protected abstract AtomicOutputStream createBlobToExtend(String key,
SettableBlobMeta meta) throws AuthorizationException, KeyAlreadyExistsException;
+ public abstract AtomicOutputStream updateBlob(String key) throws
AuthorizationException, KeyNotFoundException;
+ public abstract ReadableBlobMeta getBlobMeta(String key) throws
AuthorizationException, KeyNotFoundException;
+ protected abstract void setBlobMetaToExtend(String key,
SettableBlobMeta meta) throws AuthorizationException, KeyNotFoundException;
+ public abstract void deleteBlob(String key) throws
AuthorizationException, KeyNotFoundException;
+ public abstract InputStreamWithMeta getBlob(String key) throws
AuthorizationException, KeyNotFoundException;
+ public abstract Iterator<String> listKeys();
+ public abstract int getBlobReplication(String Key) throws
AuthorizationException, KeyNotFoundException;
+ public abstract int updateBlobReplication(String Key, int replication)
throws AuthorizationException, KeyNotFoundException;
+ public abstract boolean setClient(Map conf, NimbusClient client);
+ public abstract void createStateInZookeeper(String key);
+
+ public final AtomicOutputStream createBlob(String key,
SettableBlobMeta meta) throws AuthorizationException, KeyAlreadyExistsException
{
+ if (meta !=null && meta.is_set_acl()) {
+ BlobStoreAclHandler.validateSettableACLs(key, meta.get_acl());
+ }
+ return createBlobToExtend(key, meta);
+ }
+
+ public final void setBlobMeta(String key, SettableBlobMeta meta)
throws AuthorizationException, KeyNotFoundException {
--- End diff --
The BlobStore.java has great documentation, but ClientBlobStore does not.
Could we update the documentation to describe what each command does, and just
as importantly how it determines who it is that is doing this operation, in
this case it appears to be implementation specific. This becomes important
because the HDFSBlobStoreClient and the NimbusBlobStoreClient seem to do things
differently, and it should be important for the client to know how this works,
perhaps this will require an update to the documentation for those as well.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
