Package dev.getelements.elements.sdk.service.largeobject

Interface LargeObjectService

All Known Implementing Classes:

AnonLargeObjectService, SuperUserLargeObjectService, UserLargeObjectService

public interface LargeObjectService

Method Summary

Modifier and Type	Method	Description
LargeObject	createLargeObject(CreateLargeObjectRequest createLargeObjectRequest)	Creates a new instance of LargeObject from the supplied CreateLargeObjectRequest.
default LargeObject	createLargeObject(CreateLargeObjectRequest createLargeObjectRequest, InputStream inputStream)	Creates a new instance of LargeObject from the supplied CreateLargeObjectRequest and file contents read from the InputStream
LargeObject	createLargeObjectFromUrl(CreateLargeObjectFromUrlRequest createRequest)	Creates a new instance of LargeObject from the supplied CreateLargeObjectFromUrlRequest.
void	deleteLargeObject(String objectId)	Deletes the instance of LargeObject, throw an instance of LargeObjectNotFoundException if the large object does not exist or the currently logged-in user does not have permission to access.
Optional<LargeObject>	findLargeObject(String objectId)	Finds an instance of LargeObject.
default LargeObject	getLargeObject(String objectId)	Gets an instnce of LargeObject.
InputStream	readLargeObjectContent(String objectId)	Opens the LargeObject for reading.
LargeObject	saveOrUpdateLargeObject(LargeObject largeObject)
LargeObject	updateLargeObject(String objectId, UpdateLargeObjectRequest objectRequest)	Updates the large object's metadata only.
default LargeObject	updateLargeObject(String objectId, UpdateLargeObjectRequest updateLargeObjectRequest, InputStream inputStream)	Updates the LargeObject with the supplied object id, metadata, and file contents.
default LargeObject	updateLargeObject(String objectId, InputStream inputStream)	Updates the LargeObject with the supplied object id and file contents.
OutputStream	writeLargeObjectContent(String objectId)	Opens the LargeObject for writing.

Method Details

findLargeObject

Optional<LargeObject> findLargeObject(String objectId)

Finds an instance of LargeObject. If the currently logged-in user may not access the supplied object or it if it is not found, then this will return a result equivalent to Optional.empty().

Parameters:

objectId - the object id

Returns:

the Optional<LargeObject>, never null

getLargeObject

default LargeObject getLargeObject(String objectId)

Gets an instnce of LargeObject.

Parameters:

objectId - the object ID

Returns:

the LargeObject, never null

Throws:

NotFoundException - if no object exists with that supplied id

updateLargeObject

LargeObject updateLargeObject(String objectId,
 UpdateLargeObjectRequest objectRequest)

Updates the large object's metadata only.

Parameters:

objectId - the object id

objectRequest - the UpdateLargeObjectRequest

Returns:

the large object

updateLargeObject

default LargeObject updateLargeObject(String objectId,
 InputStream inputStream)
                               throws IOException

Updates the LargeObject with the supplied object id and file contents.

Parameters:

objectId - the large object's id

inputStream - the input stream to read for the object's contents

Returns:

the large object

Throws:

IOException - if there was an error writing the large object

updateLargeObject

default LargeObject updateLargeObject(String objectId,
 UpdateLargeObjectRequest updateLargeObjectRequest,
 InputStream inputStream)
                               throws IOException

Updates the LargeObject with the supplied object id, metadata, and file contents.

Parameters:

objectId - the large object's id

inputStream - the input stream to read for the object's contents

Returns:

the large object

Throws:

IOException - if there was an error writing the large object

createLargeObject

LargeObject createLargeObject(CreateLargeObjectRequest createLargeObjectRequest)

Creates a new instance of LargeObject from the supplied CreateLargeObjectRequest.

Parameters:

createLargeObjectRequest - the large object request

Returns:

the LargeObject as it was created

createLargeObjectFromUrl

LargeObject createLargeObjectFromUrl(CreateLargeObjectFromUrlRequest createRequest)
                              throws IOException

Creates a new instance of LargeObject from the supplied CreateLargeObjectFromUrlRequest.

Parameters:

createRequest - the large object request

Returns:

the LargeObject as it was created

Throws:

IOException - if there was an error writing the large object

createLargeObject

default LargeObject createLargeObject(CreateLargeObjectRequest createLargeObjectRequest,
 InputStream inputStream)
                               throws IOException

Creates a new instance of LargeObject from the supplied CreateLargeObjectRequest and file contents read from the InputStream

Parameters:

createLargeObjectRequest - the large object request

Returns:

the LargeObject as it was created

Throws:

IOException - if there was an error writing the large object

deleteLargeObject

void deleteLargeObject(String objectId)
                throws IOException

Deletes the instance of LargeObject, throw an instance of LargeObjectNotFoundException if the large object does not exist or the currently logged-in user does not have permission to access.

Parameters:

objectId - the object id

Throws:

IOException

readLargeObjectContent

InputStream readLargeObjectContent(String objectId)
                            throws IOException

Opens the LargeObject for reading.

Parameters:

objectId - the object id

Returns:

an InputStream used to read the object's contents

Throws:

IOException

writeLargeObjectContent

OutputStream writeLargeObjectContent(String objectId)
                              throws IOException

Opens the LargeObject for writing.

Parameters:

objectId - the object id

Returns:

an OutputStream used to write the object's contents.

Throws:

IOException

saveOrUpdateLargeObject

LargeObject saveOrUpdateLargeObject(LargeObject largeObject)