com.bazaarvoice.emodb.blob.api.AuthBlobStore Maven / Gradle / Ivy
package com.bazaarvoice.emodb.blob.api;
import com.bazaarvoice.emodb.auth.proxy.Credential;
import com.bazaarvoice.emodb.sor.api.Audit;
import com.bazaarvoice.emodb.sor.api.TableExistsException;
import com.bazaarvoice.emodb.sor.api.TableOptions;
import com.bazaarvoice.emodb.sor.api.UnknownTableException;
import com.google.common.io.InputSupplier;
import org.joda.time.Duration;
import javax.annotation.Nullable;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
/**
* Authenticating interface to {@link BlobStore}. This method should exactly mirror BlobStore except with added
* credentials in each call.
* @see BlobStore
*/
public interface AuthBlobStore {
/**
* Retrieves metadata about up to {@code limit} tables. The records will be returned in a deterministic
* order but not sorted alphabetically by key. If {@code fromTableExclusive} is not null, the list will
* start with the first table that follows the specified key in the returned sort order.
*
* Note: clients are strongly encouraged to use the version of this method wrapped by the
* {@code com.bazaarvoice.emodb.sor.client.DataStoreStreaming} class which will restart the iterator in the
* event that the connection to the EmoDB server is lost while streaming results.
*/
Iterator
listTables(@Credential String apiKey, @Nullable String fromTableExclusive, long limit);
/**
* Creates a logical table in the data store.
*
* @throws TableExistsException if the table exists already with different options or a different attributes.
*/
void createTable(@Credential String apiKey, String table, TableOptions options, Map attributes, Audit audit)
throws TableExistsException;
/** Drops the specified table and all data associated with it. */
void dropTable(@Credential String apiKey, String table, Audit audit)
throws UnknownTableException;
/**
* Makes a best effort to permanently delete all data from the specified table.
*
* Useful for debugging/testing, but not intended for use in production because it performs an unbounded amount of work.
*/
void purgeTableUnsafe(@Credential String apiKey, String table, Audit audit)
throws UnknownTableException;
/** Returns true if the specified table exists. */
boolean getTableExists(@Credential String apiKey, String table);
/** Returns true if the specified table is available to the current data center. */
boolean isTableAvailable(@Credential String apiKey, String table);
/** Returns the table metadata. */
Table getTableMetadata(@Credential String apiKey, String table);
/** Returns the attributes associated with a table. */
Map getTableAttributes(@Credential String apiKey, String table)
throws UnknownTableException;
/** Replaces the attributes for an existing table. */
void setTableAttributes(@Credential String apiKey, String table, Map attributes, Audit audit)
throws UnknownTableException;
/** Returns the storage options associated with a table. */
TableOptions getTableOptions(@Credential String apiKey, String table)
throws UnknownTableException;
/**
* Returns an estimate of the number of blobs stored in the specified table. This will not include deleted blobs.
*
* Useful for debugging/testing, but not intended for use in production because it performs an unbounded amount of work.
* Please do not use this method to monitor your data in production!
*/
long getTableApproximateSize(@Credential String apiKey, String table)
throws UnknownTableException;
BlobMetadata getMetadata(@Credential String apiKey, String table, String blobId) throws BlobNotFoundException;
/**
* Retrieves metadata for up to {@code limit} objects from the specified table. The records will be returned in a
* deterministic order but not sorted alphabetically by key. If {@code fromKeyExclusive} is not null, the scan
* will start with the first record that follows the specified key in the returned sort order.
*
* Note: clients are strongly encouraged to use the version of this method wrapped by the
* {@code com.bazaarvoice.emodb.blob.client.BlobStoreStreaming} class which will restart the iterator in the
* event that the connection to the EmoDB server is lost while streaming results.
*/
Iterator scanMetadata(@Credential String apiKey, String table, @Nullable String fromBlobIdExclusive, long limit);
Blob get(@Credential String apiKey, String table, String blobId) throws BlobNotFoundException;
Blob get(@Credential String apiKey, String table, String blobId, @Nullable RangeSpecification rangeSpec)
throws BlobNotFoundException, RangeNotSatisfiableException;
void put(@Credential String apiKey, String table, String blobId, InputSupplier in, Map attributes, @Nullable Duration ttl)
throws IOException;
void delete(@Credential String apiKey, String table, String blobId);
/**
* Returns list of valid table placements
*/
Collection getTablePlacements(@Credential String apiKey);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy