Package com.cumulocity.sdk.client.inventory

Class BinariesApiImpl

java.lang.Object

com.cumulocity.sdk.client.inventory.BinariesApiImpl

All Implemented Interfaces:

BinariesApi

public class BinariesApiImpl
extends Object
implements BinariesApi

Constructor Summary

Constructors

Constructor	Description
BinariesApiImpl(RestConnector restConnector, InventoryRepresentation inventoryRepresentation)

Method Summary

Modifier and Type	Method	Description
void	deleteFile(GId containerId)	Remove a managed object and its stored file by a given ID.
InputStream	downloadFile(GId id)	Download a stored file (managed object) by a given ID.
ManagedObjectRepresentation	replaceFile(GId containerId, String contentType, InputStream fileStream)	Upload and replace the attached file (binary) of a specific managed object by a given ID.
ManagedObjectRepresentation	uploadFile(ManagedObjectRepresentation container, byte[] bytes)	Upload a file (binary) with content-type of "application/octet-stream" (default).
ManagedObjectRepresentation	uploadFile(ManagedObjectRepresentation container, byte[] bytes, jakarta.ws.rs.core.MediaType mediaType)	Upload a file (binary) with custom content-type.
ManagedObjectRepresentation	uploadFile(ManagedObjectRepresentation container, InputStream inputStream)	Upload a file (binary) with content-type of "application/octet-stream" (default).
ManagedObjectRepresentation	uploadFile(ManagedObjectRepresentation container, InputStream inputStream, jakarta.ws.rs.core.MediaType mediaType)	Upload a file (binary) with custom content-type.

Methods inherited from class java.lang.Object

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

Constructor Details

BinariesApiImpl

public BinariesApiImpl(RestConnector restConnector,
 InventoryRepresentation inventoryRepresentation)

Method Details

uploadFile

public ManagedObjectRepresentation uploadFile(ManagedObjectRepresentation container,
 byte[] bytes)
                                       throws SDKException

Description copied from interface: BinariesApi

Upload a file (binary) with content-type of "application/octet-stream" (default).

Specified by:

uploadFile in interface BinariesApi

Parameters:

container - ManagedObjectRepresentation with binary metadata

bytes - file (binary) to be uploaded

Returns:

ManagedObjectRepresentation with binary metadata

Throws:

SDKException - if upload fails

uploadFile

public ManagedObjectRepresentation uploadFile(ManagedObjectRepresentation container,
 byte[] bytes,
 jakarta.ws.rs.core.MediaType mediaType)
                                       throws SDKException

Description copied from interface: BinariesApi

Upload a file (binary) with custom content-type.

Specified by:

uploadFile in interface BinariesApi

Parameters:

container - ManagedObjectRepresentation with binary metadata

bytes - file (binary) to be uploaded

mediaType - content-type of file (binary)

Returns:

ManagedObjectRepresentation with binary metadata

Throws:

SDKException - if upload fails

uploadFile

public ManagedObjectRepresentation uploadFile(ManagedObjectRepresentation container,
 InputStream inputStream)
                                       throws SDKException

Description copied from interface: BinariesApi

Upload a file (binary) with content-type of "application/octet-stream" (default).

Specified by:

uploadFile in interface BinariesApi

Parameters:

container - ManagedObjectRepresentation with binary metadata

inputStream - file (binary) to be uploaded

Returns:

ManagedObjectRepresentation with binary metadata

Throws:

SDKException - if upload fails

uploadFile

public ManagedObjectRepresentation uploadFile(ManagedObjectRepresentation container,
 InputStream inputStream,
 jakarta.ws.rs.core.MediaType mediaType)
                                       throws SDKException

Description copied from interface: BinariesApi

Upload a file (binary) with custom content-type.

Specified by:

uploadFile in interface BinariesApi

Parameters:

container - ManagedObjectRepresentation with binary metadata

inputStream - file (binary) to be uploaded

mediaType - content-type of file (binary)

Returns:

ManagedObjectRepresentation with binary metadata

Throws:

SDKException - if upload fails

replaceFile

public ManagedObjectRepresentation replaceFile(GId containerId,
 String contentType,
 InputStream fileStream)
                                        throws SDKException

Description copied from interface: BinariesApi

Upload and replace the attached file (binary) of a specific managed object by a given ID.

Specified by:

replaceFile in interface BinariesApi

Parameters:

containerId - ID of managed object

contentType - content-type of file (binary)

fileStream - file (binary) to be uploaded

Returns:

ManagedObjectRepresentation with binary metadata

Throws:

SDKException - if upload fails

deleteFile

public void deleteFile(GId containerId)
                throws SDKException

Description copied from interface: BinariesApi

Remove a managed object and its stored file by a given ID.

Specified by:

deleteFile in interface BinariesApi

Parameters:

containerId - ID of managed object

Throws:

SDKException - if delete fails

downloadFile

public InputStream downloadFile(GId id)
                         throws SDKException

Description copied from interface: BinariesApi

Download a stored file (managed object) by a given ID.

Specified by:

downloadFile in interface BinariesApi

Parameters:

id - ID of managed object

Returns:

file (binary)

Throws:

SDKException - if download fails