Package org.opensearch.common.blobstore.url

Class URLBlobContainer

java.lang.Object

org.opensearch.common.blobstore.support.AbstractBlobContainer

org.opensearch.common.blobstore.url.URLBlobContainer

All Implemented Interfaces:

BlobContainer

public class URLBlobContainer
extends AbstractBlobContainer

URL blob implementation of BlobContainer

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.blobstore.BlobContainer

BlobContainer.BlobNameSortOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected final URLBlobStore	blobStore
protected final URL	path

Constructor Summary

Constructors

Constructor	Description
URLBlobContainer(URLBlobStore blobStore, BlobPath blobPath, URL path)	Constructs new URLBlobContainer

Method Summary

Modifier and Type	Method	Description
boolean	blobExists(String blobName)	Tests whether a blob with the given blob name exists in the container.
Map<String,BlobContainer>	children()
DeleteResult	delete()
void	deleteBlobsIgnoringIfNotExists(List<String> blobNames)	This operation is not supported by URLBlobContainer
Map<String,BlobMetadata>	listBlobs()	This operation is not supported by URLBlobContainer
Map<String,BlobMetadata>	listBlobsByPrefix(String blobNamePrefix)	This operation is not supported by URLBlobContainer
InputStream	readBlob(String name)
InputStream	readBlob(String blobName, long position, long length)
URL	url()	Returns URL for this container
void	writeBlob(String blobName, InputStream inputStream, long blobSize, boolean failIfAlreadyExists)
void	writeBlobAtomic(String blobName, InputStream inputStream, long blobSize, boolean failIfAlreadyExists)

Methods inherited from class org.opensearch.common.blobstore.support.AbstractBlobContainer

path

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.common.blobstore.BlobContainer

listBlobsByPrefixInSortedOrder, listBlobsByPrefixInSortedOrder, readBlobPreferredLength, readBlobWithMetadata, writeBlobAtomicWithMetadata, writeBlobWithMetadata

Field Details

blobStore

protected final URLBlobStore blobStore

path

protected final URL path

Constructor Details

URLBlobContainer

public URLBlobContainer(URLBlobStore blobStore,
 BlobPath blobPath,
 URL path)

Constructs new URLBlobContainer

Parameters:

blobStore - blob store

blobPath - blob path for this container

path - URL for this container

Method Details

url

public URL url()

Returns URL for this container

Returns:

URL for this container

blobExists

public boolean blobExists(String blobName)
                   throws IOException

Tests whether a blob with the given blob name exists in the container.

Parameters:

blobName - The name of the blob whose existence is to be determined.

Returns:

true if a blob exists in the BlobContainer with the given name, and false otherwise.

Throws:

IOException

listBlobs

public Map<String,BlobMetadata> listBlobs()
                                   throws IOException

This operation is not supported by URLBlobContainer

Throws:

IOException

children

public Map<String,BlobContainer> children()
                                   throws IOException

Throws:

IOException

listBlobsByPrefix

public Map<String,BlobMetadata> listBlobsByPrefix(String blobNamePrefix)
                                           throws IOException

This operation is not supported by URLBlobContainer

Throws:

IOException

deleteBlobsIgnoringIfNotExists

public void deleteBlobsIgnoringIfNotExists(List<String> blobNames)

This operation is not supported by URLBlobContainer

delete

public DeleteResult delete()

readBlob

public InputStream readBlob(String name)
                     throws IOException

Throws:

IOException

readBlob

public InputStream readBlob(String blobName,
 long position,
 long length)
                     throws IOException

Throws:

IOException

writeBlob

public void writeBlob(String blobName,
 InputStream inputStream,
 long blobSize,
 boolean failIfAlreadyExists)
               throws IOException

Throws:

IOException

writeBlobAtomic

public void writeBlobAtomic(String blobName,
 InputStream inputStream,
 long blobSize,
 boolean failIfAlreadyExists)
                     throws IOException

Throws:

IOException