org.apache.jackrabbit.oak.upgrade.cli.blob

Class LoopbackBlobStore

java.lang.Object

org.apache.jackrabbit.oak.upgrade.cli.blob.LoopbackBlobStore

All Implemented Interfaces:

AutoCloseable, BlobStore

public class LoopbackBlobStore
extends Object
implements BlobStore

Utility BlobStore implementation to be used in tooling that can work with a FileStore without the need of the DataStore being present locally. Additionally instead of failing it tries to mimic and return blob reference passed in by caller by passing it back as a binary. Example: requesting blobId = e7c22b994c59d9 it will return the e7c22b994c59d9 text as a UTF-8 encoded binary file.

Constructor Summary

Constructors

Constructor and Description
LoopbackBlobStore()

Method Summary

Modifier and Type	Method and Description
void	close()
String	getBlobId(@NotNull String reference) Returns the blobId that referred by the given binary reference.
long	getBlobLength(String blobId) Get the length of the blob.
InputStream	getInputStream(String blobId) Returns a new stream for given blobId.
String	getReference(@NotNull String blobId) Returns a secure reference to blob referred by blobid, or null if no such reference is available.
int	readBlob(String blobId, long pos, byte[] buff, int off, int length) Read a number of bytes from a blob.
String	writeBlob(InputStream in) Write a blob from an input stream.
String	writeBlob(InputStream in, BlobOptions options) Write a blob from an input stream with specified options.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoopbackBlobStore

public LoopbackBlobStore()

Method Detail

writeBlob

public String writeBlob(InputStream in)

Description copied from interface: BlobStore

Write a blob from an input stream. This method closes the input stream.

Specified by:

writeBlob in interface BlobStore

Parameters:

in - the input stream

Returns:

the blob id

writeBlob

public String writeBlob(InputStream in,
                        BlobOptions options)
                 throws IOException

Description copied from interface: BlobStore

Write a blob from an input stream with specified options. This method closes the input stream.

Specified by:

writeBlob in interface BlobStore

Parameters:

in - the input stream to write

options - the options to use

Returns:

Throws:

IOException

readBlob

public int readBlob(String blobId,
                    long pos,
                    byte[] buff,
                    int off,
                    int length)

Description copied from interface: BlobStore

Read a number of bytes from a blob.

Specified by:

readBlob in interface BlobStore

Parameters:

blobId - the blob id

pos - the position within the blob

buff - the target byte array

off - the offset within the target array

length - the number of bytes to read

Returns:

the number of bytes read

getBlobLength

public long getBlobLength(String blobId)
                   throws IOException

Description copied from interface: BlobStore

Get the length of the blob.

Specified by:

getBlobLength in interface BlobStore

Parameters:

blobId - the blob id

Returns:

the length

Throws:

IOException

getInputStream

public InputStream getInputStream(String blobId)
                           throws IOException

Description copied from interface: BlobStore

Returns a new stream for given blobId. The streams returned from multiple calls to this method are byte wise equals. That is, subsequent calls to read return the same sequence of bytes as long as neither call throws an exception.

Specified by:

getInputStream in interface BlobStore

Parameters:

blobId - the blob id

Returns:

a new stream for given blobId

Throws:

IOException

getBlobId

public String getBlobId(@NotNull
                        @NotNull String reference)

Description copied from interface: BlobStore

Returns the blobId that referred by the given binary reference. Returns null if the reference is invalid, for example if it points to a blob that does not exist.

Specified by:

getBlobId in interface BlobStore

Parameters:

reference - binary reference

Returns:

matching blobId, or null

getReference

public String getReference(@NotNull
                           @NotNull String blobId)

Description copied from interface: BlobStore

Returns a secure reference to blob referred by blobid, or null if no such reference is available.

Specified by:

getReference in interface BlobStore

Parameters:

blobId - blobId referring the blob for which reference is required

Returns:

binary reference, or null

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception