storm-client/src/jvm/org/apache/storm/blobstore/ClientBlobStore.java

/**
 * 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.storm.blobstore;

import java.io.IOException;
import java.util.Iterator;
import java.util.Map;
import org.apache.storm.daemon.Shutdownable;
import org.apache.storm.generated.AuthorizationException;
import org.apache.storm.generated.KeyAlreadyExistsException;
import org.apache.storm.generated.KeyNotFoundException;
import org.apache.storm.generated.ReadableBlobMeta;
import org.apache.storm.generated.SettableBlobMeta;
import org.apache.storm.utils.ConfigUtils;
import org.apache.storm.utils.NimbusClient;
import org.apache.storm.utils.Utils;

/**
 * The ClientBlobStore has two concrete implementations 1. NimbusBlobStore 2. HdfsClientBlobStore.
 *
 * <p>Create, update, read and delete are some of the basic operations defined by this interface. Each operation is
 * validated for permissions against an user. We currently have NIMBUS_ADMINS and SUPERVISOR_ADMINS configuration.
 * NIMBUS_ADMINS are given READ, WRITE and ADMIN access whereas the SUPERVISOR_ADMINS are given READ access in order to
 * read and download the blobs form the nimbus.
 *
 * <p>The ACLs for the blob store are validated against whether the subject is a NIMBUS_ADMIN, SUPERVISOR_ADMIN or USER
 * who has read, write or admin privileges in order to perform respective operations on the blob.
 *
 * <p>For more detailed implementation
 *
 * @see org.apache.storm.blobstore.NimbusBlobStore
 */
public abstract class ClientBlobStore implements Shutdownable, AutoCloseable {

    public static void withConfiguredClient(WithBlobstore withBlobstore) throws Exception {
        Map<String, Object> conf = ConfigUtils.readStormConfig();
        try (ClientBlobStore blobStore = Utils.getClientBlobStore(conf)) {
            withBlobstore.run(blobStore);
        }
    }

    /**
     * Sets up the client API by parsing the configs.
     *
     * @param conf The storm conf containing the config details
     */
    public abstract void prepare(Map<String, Object> conf);

    /**
     * Client facing API to create a blob.
     *
     * @param key  blob key name
     * @param meta contains ACL information
     * @return AtomicOutputStream returns an output stream into which data can be written
     */
    protected abstract AtomicOutputStream createBlobToExtend(String key, SettableBlobMeta meta) throws AuthorizationException,
        KeyAlreadyExistsException;

    /**
     * Client facing API to update a blob.
     *
     * @param key blob key name
     * @return AtomicOutputStream returns an output stream into which data can be written
     */
    public abstract AtomicOutputStream updateBlob(String key) throws AuthorizationException, KeyNotFoundException;

    /**
     * Client facing API to read the metadata information.
     *
     * @param key blob key name
     * @return AtomicOutputStream returns an output stream into which data can be written
     */
    public abstract ReadableBlobMeta getBlobMeta(String key) throws AuthorizationException, KeyNotFoundException;

    /**
     * Decide if the blob is deleted from cluster.
     * @param blobKey blob key
     */
    public abstract boolean isRemoteBlobExists(String blobKey) throws AuthorizationException;

    /**
     * Client facing API to set the metadata for a blob.
     *
     * @param key  blob key name
     * @param meta contains ACL information
     */
    protected abstract void setBlobMetaToExtend(String key, SettableBlobMeta meta) throws AuthorizationException, KeyNotFoundException;

    /**
     * Client facing API to delete a blob.
     *
     * @param key blob key name
     */
    public abstract void deleteBlob(String key) throws AuthorizationException, KeyNotFoundException;

    /**
     * Client facing API to read a blob.
     *
     * @param key blob key name
     * @return an InputStream to read the metadata for a blob
     */
    public abstract InputStreamWithMeta getBlob(String key) throws AuthorizationException, KeyNotFoundException;

    /**
     * List keys.
     * @return Iterator for a list of keys currently present in the blob store.
     */
    public abstract Iterator<String> listKeys();

    /**
     * Client facing API to read the replication of a blob.
     *
     * @param key blob key name
     * @return int indicates the replication factor of a blob
     */
    public abstract int getBlobReplication(String key) throws AuthorizationException, KeyNotFoundException;

    /**
     * Client facing API to update the replication of a blob.
     *
     * @param key         blob key name
     * @param replication int indicates the replication factor a blob has to be set
     * @return int indicates the replication factor of a blob
     */
    public abstract int updateBlobReplication(String key, int replication) throws AuthorizationException, KeyNotFoundException;

    /**
     * Client facing API to set a nimbus client.
     *
     * @param conf   storm conf
     * @param client NimbusClient
     * @return indicates where the client connection has been setup.
     */
    public abstract boolean setClient(Map<String, Object> conf, NimbusClient client);

    /**
     * Creates state inside a zookeeper. Required for blobstore to write to zookeeper when Nimbus HA is turned on in
     * order to maintain state consistency.
     */
    public abstract void createStateInZookeeper(String key);

    @Override
    public abstract void close();

    /**
     * Client facing API to create a blob.
     *
     * @param key  blob key name
     * @param meta contains ACL information
     * @return AtomicOutputStream returns an output stream into which data can be written
     */
    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);
    }

    /**
     * Client facing API to set the metadata for a blob.
     *
     * @param key  blob key name
     * @param meta contains ACL information
     */
    public final void setBlobMeta(String key, SettableBlobMeta meta) throws AuthorizationException, KeyNotFoundException {
        if (meta != null && meta.is_set_acl()) {
            BlobStoreAclHandler.validateSettableACLs(key, meta.get_acl());
        }
        setBlobMetaToExtend(key, meta);
    }

    public interface WithBlobstore {
        void run(ClientBlobStore blobStore) throws Exception;
    }

    /**
     * Client facing API to get the last update time of existing blobs in a blobstore.  This is only required for use on
     * supervisors.
     *
     * @return the timestamp of when the blobstore was last updated.  -1L if the blobstore
     *     does not support this.
     */
    public abstract long getRemoteBlobstoreUpdateTime() throws IOException;
}