Class HdfsBlobStore
- java.lang.Object
-
- org.apache.storm.blobstore.BlobStore
-
- org.apache.storm.hdfs.blobstore.HdfsBlobStore
-
- All Implemented Interfaces:
AutoCloseable,Shutdownable
public class HdfsBlobStore extends BlobStore
Provides a HDFS file system backed blob store implementation. Note that this provides an api for having HDFS be the backing store for the blobstore, it is not a service/daemon.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.
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.
For hdfs blob store 1. The USER interacts with nimbus to upload and access blobs through NimbusBlobStore Client API. Here, unlike local blob store which stores the blobs locally, the nimbus talks to HDFS to upload the blobs. 2. The USER sets the ACLs, and the blob access is validated against these ACLs. 3. The SUPERVISOR interacts with nimbus through HdfsClientBlobStore to download the blobs. Here, unlike local blob store the supervisor interacts with HDFS directly to download the blobs. The call to HdfsBlobStore is made as a "null" subject. The blobstore gets the hadoop user and validates permissions for the supervisor.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.storm.blobstore.BlobStore
BlobStore.BlobStoreFileInputStream, BlobStore.BlobStoreFileOutputStream, BlobStore.KeyTranslationIterator
-
-
Field Summary
-
Fields inherited from class org.apache.storm.blobstore.BlobStore
BASE_BLOBS_DIR_NAME
-
-
Constructor Summary
Constructors Constructor Description HdfsBlobStore()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanblobExists(String key, Subject who)Checks if a blob exists.AtomicOutputStreamcreateBlob(String key, SettableBlobMeta meta, Subject who)Creates the blob.voiddeleteBlob(String key, Subject who)Deletes the blob data and metadata.voidfullCleanup(long age)InputStreamWithMetagetBlob(String key, Subject who)Gets the InputStream to read the blob details.ReadableBlobMetagetBlobMeta(String key, Subject who)Gets the current version of metadata for a blob to be viewed by the user or downloaded by the supervisor.intgetBlobReplication(String key, Subject who)Gets the replication factor of the blob.longgetLastBlobUpdateTime()Iterator<String>listKeys()Returns an iterator with all the list of keys currently available on the blob store.voidprepare(Map<String,Object> conf, String overrideBase, NimbusInfo nimbusInfo, ILeaderElector leaderElector)Allows us to initialize the blob store.protected voidprepareInternal(Map<String,Object> conf, String overrideBase, org.apache.hadoop.conf.Configuration hadoopConf)Allow a Hadoop Configuration to be passed for testing.voidsetBlobMeta(String key, SettableBlobMeta meta, Subject who)Sets the metadata with renewed acls for the blob.voidsetLeaderElector(ILeaderElector leaderElector)Sets leader elector (only used by LocalFsBlobStore to help sync blobs between Nimbi.voidshutdown()AtomicOutputStreamupdateBlob(String key, Subject who)Updates the blob data.intupdateBlobReplication(String key, int replication, Subject who)Modifies the replication factor of the blob.voidupdateLastBlobUpdateTime()Updates the last update time of existing blobs in the blobstore to the current time.voidvalidateBlobUpdateTime()Validates that the blob update time of the blobstore is up to date with the current existing blobs.voidwriteMetadata(String key, SettableBlobMeta meta)-
Methods inherited from class org.apache.storm.blobstore.BlobStore
close, createBlob, createBlob, filterAndListKeys, readBlob, readBlobTo, startSyncBlobs, storedTopoIds, updateBlob, validateKey
-
-
-
-
Method Detail
-
prepare
public void prepare(Map<String,Object> conf, String overrideBase, NimbusInfo nimbusInfo, ILeaderElector leaderElector)
Description copied from class:BlobStoreAllows us to initialize the blob store.
-
prepareInternal
protected void prepareInternal(Map<String,Object> conf, String overrideBase, org.apache.hadoop.conf.Configuration hadoopConf)
Allow a Hadoop Configuration to be passed for testing. If it's null then the hadoop configs must be in your classpath.
-
createBlob
public AtomicOutputStream createBlob(String key, SettableBlobMeta meta, Subject who) throws AuthorizationException, KeyAlreadyExistsException
Description copied from class:BlobStoreCreates the blob.- Specified by:
createBlobin classBlobStore- Parameters:
key- Key for the blobmeta- Metadata which contains the acls informationwho- Is the subject creating the blob- Returns:
- AtomicOutputStream returns a stream into which the data can be written
- Throws:
AuthorizationExceptionKeyAlreadyExistsException
-
updateBlob
public AtomicOutputStream updateBlob(String key, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreUpdates the blob data.- Specified by:
updateBlobin classBlobStore- Parameters:
key- Key for the blobwho- Is the subject having the write privilege for the blob- Returns:
- AtomicOutputStream returns a stream into which the data can be written
- Throws:
AuthorizationExceptionKeyNotFoundException
-
getBlobMeta
public ReadableBlobMeta getBlobMeta(String key, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreGets the current version of metadata for a blob to be viewed by the user or downloaded by the supervisor.- Specified by:
getBlobMetain classBlobStore- Parameters:
key- Key for the blobwho- Is the subject having the read privilege for the blob- Returns:
- AtomicOutputStream returns a stream into which the data can be written
- Throws:
AuthorizationExceptionKeyNotFoundException
-
setLeaderElector
public void setLeaderElector(ILeaderElector leaderElector)
Sets leader elector (only used by LocalFsBlobStore to help sync blobs between Nimbi.- Specified by:
setLeaderElectorin classBlobStore- Parameters:
leaderElector- the leader elector
-
setBlobMeta
public void setBlobMeta(String key, SettableBlobMeta meta, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreSets the metadata with renewed acls for the blob.- Specified by:
setBlobMetain classBlobStore- Parameters:
key- Key for the blobmeta- Metadata which contains the updated acls informationwho- Is the subject having the write privilege for the blob- Throws:
AuthorizationExceptionKeyNotFoundException
-
deleteBlob
public void deleteBlob(String key, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreDeletes the blob data and metadata.- Specified by:
deleteBlobin classBlobStore- Parameters:
key- Key for the blobwho- Is the subject having write privilege for the blob- Throws:
AuthorizationExceptionKeyNotFoundException
-
getBlob
public InputStreamWithMeta getBlob(String key, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreGets the InputStream to read the blob details.- Specified by:
getBlobin classBlobStore- Parameters:
key- Key for the blobwho- Is the subject having the read privilege for the blob- Returns:
- InputStreamWithMeta has the additional file length and version information
- Throws:
AuthorizationExceptionKeyNotFoundException
-
blobExists
public boolean blobExists(String key, Subject who) throws AuthorizationException
Checks if a blob exists.- Parameters:
key- blobstore keywho- subject- Throws:
AuthorizationException- if authorization is failed
-
listKeys
public Iterator<String> listKeys()
Description copied from class:BlobStoreReturns an iterator with all the list of keys currently available on the blob store.
-
shutdown
public void shutdown()
-
getBlobReplication
public int getBlobReplication(String key, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreGets the replication factor of the blob.- Specified by:
getBlobReplicationin classBlobStore- Parameters:
key- Key for the blobwho- Is the subject having the read privilege for the blob- Returns:
- BlobReplication object containing the replication factor for the blob
- Throws:
AuthorizationExceptionKeyNotFoundException
-
updateBlobReplication
public int updateBlobReplication(String key, int replication, Subject who) throws AuthorizationException, KeyNotFoundException
Description copied from class:BlobStoreModifies the replication factor of the blob.- Specified by:
updateBlobReplicationin classBlobStore- Parameters:
key- Key for the blobreplication- The replication factor the blob has to be setwho- Is the subject having the update privilege for the blob- Returns:
- BlobReplication object containing the updated replication factor for the blob
- Throws:
AuthorizationExceptionKeyNotFoundException
-
writeMetadata
public void writeMetadata(String key, SettableBlobMeta meta) throws AuthorizationException, KeyNotFoundException
-
fullCleanup
public void fullCleanup(long age) throws IOException- Throws:
IOException
-
getLastBlobUpdateTime
public long getLastBlobUpdateTime() throws IOException- Throws:
IOException
-
updateLastBlobUpdateTime
public void updateLastBlobUpdateTime() throws IOExceptionDescription copied from class:BlobStoreUpdates the last update time of existing blobs in the blobstore to the current time.- Overrides:
updateLastBlobUpdateTimein classBlobStore- Throws:
IOException- on any error
-
validateBlobUpdateTime
public void validateBlobUpdateTime() throws IOExceptionDescription copied from class:BlobStoreValidates that the blob update time of the blobstore is up to date with the current existing blobs.- Overrides:
validateBlobUpdateTimein classBlobStore- Throws:
IOException- on any error
-
-