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	expungeBinaryContent(org.hl7.fhir.instance.model.api.IIdType theIdElement, String theBlobId)
byte[]	fetchBinaryContent(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobId)	Fetch the contents of the given blob
StoredDetails	fetchBinaryContentDetails(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobId)
byte[]	fetchDataByteArrayFromBinary(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.
boolean	isValidBinaryContentId(String theNewBlobId)	Given a blob ID, return true if it is valid for the underlying storage mechanism, false otherwise.
String	newBinaryContentId()	Generate a new binaryContent ID that will be passed to IBinaryStorageSvc.storeBinaryContent(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	shouldStoreBinaryContent(long theSize, org.hl7.fhir.instance.model.api.IIdType theResourceId, String theContentType)	Give the storage service the ability to veto items from storage
StoredDetails	storeBinaryContent(org.hl7.fhir.instance.model.api.IIdType theResourceId, String theBlobIdOrNull, String theContentType, InputStream theInputStream, ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Store a new binary blob
boolean	writeBinaryContent(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

Methods inherited from interface ca.uhn.fhir.jpa.binary.api.IBinaryStorageSvc

storeBinaryContent

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

isValidBinaryContentId

public boolean isValidBinaryContentId(String theNewBlobId)

Description copied from interface: IBinaryStorageSvc

Given a blob ID, return true if it is valid for the underlying storage mechanism, false otherwise.

Specified by:

isValidBinaryContentId in interface IBinaryStorageSvc

Parameters:

theNewBlobId - the blob ID to validate

Returns:

true if the blob ID is valid, false otherwise.

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

shouldStoreBinaryContent

public boolean shouldStoreBinaryContent(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:

shouldStoreBinaryContent 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

newBinaryContentId

public String newBinaryContentId()

Description copied from interface: IBinaryStorageSvc

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

Specified by:

newBinaryContentId in interface IBinaryStorageSvc

storeBinaryContent

@Nonnull
public StoredDetails storeBinaryContent(org.hl7.fhir.instance.model.api.IIdType theResourceId,
 String theBlobIdOrNull,
 String theContentType,
 InputStream theInputStream,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Description copied from interface: IBinaryStorageSvc

Store a new binary blob

Specified by:

storeBinaryContent 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.

theRequestDetails - The operation request details.

Returns:

Returns details about the stored data

fetchBinaryContentDetails

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

Specified by:

fetchBinaryContentDetails in interface IBinaryStorageSvc

writeBinaryContent

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

Specified by:

writeBinaryContent 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)

expungeBinaryContent

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

Specified by:

expungeBinaryContent in interface IBinaryStorageSvc

fetchBinaryContent

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

Description copied from interface: IBinaryStorageSvc

Fetch the contents of the given blob

Specified by:

fetchBinaryContent in interface IBinaryStorageSvc

Parameters:

theResourceId - The resource ID

theBlobId - The blob ID

Returns:

The payload as a byte array

fetchDataByteArrayFromBinary

public byte[] fetchDataByteArrayFromBinary(org.hl7.fhir.instance.model.api.IBaseBinary theResource)

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:

fetchDataByteArrayFromBinary in interface IBinaryStorageSvc

Parameters:

theResource - The Binary resource you want to extract data bytes from

Returns:

The binary data blob as a byte array