Package ca.uhn.fhir.jpa.binary.svc

Class NullBinaryStorageSvcImpl

java.lang.Object

ca.uhn.fhir.jpa.binary.svc.NullBinaryStorageSvcImpl

All Implemented Interfaces:

IBinaryStorageSvc

public class NullBinaryStorageSvcImpl
extends Object
implements IBinaryStorageSvc

Constructor Summary

Constructors

Constructor	Description
NullBinaryStorageSvcImpl()

Method Summary

Modifier and Type	Method	Description
void	expungeBlob(org.hl7.fhir.instance.model.api.IIdType theIdElement, String theBlobId)
byte[]	fetchBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobId)	Fetch the contents of the given blob
StoredDetails	fetchBlobDetails(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobId)
byte[]	fetchDataBlobFromBinary(org.hl7.fhir.instance.model.api.IBaseBinary theResource)	Fetch the byte[] contents of a given Binary resource's `data` element.
long	getMaximumBinarySize()	Gets the maximum number of bytes that can be stored in a single binary file by this service.
int	getMinimumBinarySize()	Gets the minimum number of bytes that will be stored.
String	newBlobId()	Generate a new blob ID that will be passed to IBinaryStorageSvc.storeBlob(IIdType, String, String, InputStream) later
void	setMaximumBinarySize(long theMaximumBinarySize)	Sets the maximum number of bytes that can be stored in a single binary file by this service.
void	setMinimumBinarySize(int theMinimumBinarySize)	Sets the minimum number of bytes that will be stored.
boolean	shouldStoreBlob(long theSize, org.hl7.fhir.instance.model.api.IIdType theResourceId, String theContentType)	Give the storage service the ability to veto items from storage
StoredDetails	storeBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobIdOrNull, String theContentType, InputStream theInputStream)	Store a new binary blob
boolean	writeBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobId, OutputStream theOutputStream)

Methods inherited from class java.lang.Object

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

Constructor Details

NullBinaryStorageSvcImpl

public NullBinaryStorageSvcImpl()

Method Details

getMaximumBinarySize

public long getMaximumBinarySize()

Description copied from interface: IBinaryStorageSvc

Gets the maximum number of bytes that can be stored in a single binary file by this service. The default is Long.MAX_VALUE

Specified by:

getMaximumBinarySize in interface IBinaryStorageSvc

setMaximumBinarySize

public void setMaximumBinarySize(long theMaximumBinarySize)

Description copied from interface: IBinaryStorageSvc

Sets the maximum number of bytes that can be stored in a single binary file by this service. The default is Long.MAX_VALUE

Specified by:

setMaximumBinarySize in interface IBinaryStorageSvc

Parameters:

theMaximumBinarySize - The maximum size

getMinimumBinarySize

public int getMinimumBinarySize()

Description copied from interface: IBinaryStorageSvc

Gets the minimum number of bytes that will be stored. Binary content smaller * than this threshold may be inlined even if a binary storage service * is active.

Specified by:

getMinimumBinarySize in interface IBinaryStorageSvc

setMinimumBinarySize

public void setMinimumBinarySize(int theMinimumBinarySize)

Description copied from interface: IBinaryStorageSvc

Sets the minimum number of bytes that will be stored. Binary content smaller than this threshold may be inlined even if a binary storage service is active.

Specified by:

setMinimumBinarySize in interface IBinaryStorageSvc

shouldStoreBlob

public boolean shouldStoreBlob(long theSize,
 org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theContentType)

Description copied from interface: IBinaryStorageSvc

Give the storage service the ability to veto items from storage

Specified by:

shouldStoreBlob in interface IBinaryStorageSvc

Parameters:

theSize - How large is the item

theResourceId - What is the resource ID it will be associated with

theContentType - What is the content type

Returns:

true if the storage service should store the item

newBlobId

public String newBlobId()

Description copied from interface: IBinaryStorageSvc

Generate a new blob ID that will be passed to IBinaryStorageSvc.storeBlob(IIdType, String, String, InputStream) later

Specified by:

newBlobId in interface IBinaryStorageSvc

storeBlob

public StoredDetails storeBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theBlobIdOrNull,
 String theContentType,
 InputStream theInputStream)

Description copied from interface: IBinaryStorageSvc

Store a new binary blob

Specified by:

storeBlob in interface IBinaryStorageSvc

Parameters:

theResourceId - The resource ID that owns this blob. Note that it should not be possible to retrieve a blob without both the resource ID and the blob ID being correct.

theBlobIdOrNull - If set, forces

theContentType - The content type to associate with this blob

theInputStream - An InputStream to read from. This method should close the stream when it has been fully consumed.

Returns:

Returns details about the stored data

fetchBlobDetails

public StoredDetails fetchBlobDetails(org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theBlobId)

Specified by:

fetchBlobDetails in interface IBinaryStorageSvc

writeBlob

public boolean writeBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theBlobId,
 OutputStream theOutputStream)

Specified by:

writeBlob in interface IBinaryStorageSvc

Returns:

Returns true if the blob was found and written, of false if the blob was not found (i.e. it was expunged or the ID was invalid)

expungeBlob

public void expungeBlob(org.hl7.fhir.instance.model.api.IIdType theIdElement,
 String theBlobId)

Specified by:

expungeBlob in interface IBinaryStorageSvc

fetchBlob

public byte[] fetchBlob(org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theBlobId)

Description copied from interface: IBinaryStorageSvc

Fetch the contents of the given blob

Specified by:

fetchBlob in interface IBinaryStorageSvc

Parameters:

theResourceId - The resource ID

theBlobId - The blob ID

Returns:

The payload as a byte array

fetchDataBlobFromBinary

public byte[] fetchDataBlobFromBinary(org.hl7.fhir.instance.model.api.IBaseBinary theResource)
                               throws IOException

Description copied from interface: IBinaryStorageSvc

Fetch the byte[] contents of a given Binary resource's `data` element. If the data is a standard base64encoded string that is embedded, return it. Otherwise, attempt to load the externalized binary blob via the the externalized binary storage service.

Specified by:

fetchDataBlobFromBinary in interface IBinaryStorageSvc

Returns:

The binary data blob as a byte array

Throws:

IOException