Package com.oceanprotocol.squid.api
Interface AssetsAPI
-
- All Known Implementing Classes:
AssetsImpl
public interface AssetsAPI
Exposes the Public API related with Assets
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Boolean
consume(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, String basePath)
Downloads a single file of an Asset previously ordered through a Service AgreementBoolean
consume(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, String basePath, int threshold)
Downloads a single file of an Asset previously ordered through a Service AgreementBoolean
consume(String serviceAgreementId, DID did, String serviceDefinitionId, String basePath)
Downloads an Asset previously ordered through a Service AgreementBoolean
consume(String serviceAgreementId, DID did, String serviceDefinitionId, String basePath, int threshold)
Downloads an Asset previously ordered through a Service AgreementInputStream
consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index)
Gets the input stream of one file of the assetInputStream
consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, int threshold)
Gets the input stream of one file of the assetInputStream
consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, Integer rangeStart, Integer rangeEnd)
Gets a range of bytes of the input stream of one file of the assetInputStream
consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, Integer rangeStart, Integer rangeEnd, int threshold)
Gets a range of bytes of the input stream of one file of the assetList<DID>
consumerAssets(String consumerAddress)
List of Asset objects purchased by consumerAddressDDO
create(AssetMetadata metadata, ProviderConfig providerConfig)
Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in AquariusDDO
create(AssetMetadata metadata, ProviderConfig providerConfig, int threshold)
Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in AquariusList<AssetMetadata.File>
getMetadataFiles(DID did)
Gets the list of the files that belongs to a DDOio.reactivex.Flowable<OrderResult>
order(DID did, String serviceDefinitionId)
Purchases an Asset represented by a DID.String
owner(DID did)
Return the owner of the asset.List<DID>
ownerAssets(String ownerAddress)
List of Asset objects published by ownerAddressSearchResult
query(Map<String,Object> params)
Gets all the DDOs that match the parameters of the querySearchResult
query(Map<String,Object> params, int offset, int page, int sort)
Gets all the DDOs that match the parameters of the queryDDO
resolve(DID did)
Gets a DDO from a DIDBoolean
retire(DID did)
Retire this did of AquariusSearchResult
search(String text)
Gets all the DDO that match the search criteriaSearchResult
search(String text, int offset, int page)
Gets all the DDOs that match the search criteriaBoolean
validate(AssetMetadata metadata)
Validate the asset metadata.
-
-
-
Method Detail
-
create
DDO create(AssetMetadata metadata, ProviderConfig providerConfig, int threshold) throws DDOException
Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in Aquarius- Parameters:
metadata
- the metadata of the DDOproviderConfig
- the endpoints of the DDO's servicesthreshold
- the secret store threshold- Returns:
- an instance of the DDO created
- Throws:
DDOException
- DDOException
-
create
DDO create(AssetMetadata metadata, ProviderConfig providerConfig) throws DDOException
Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in Aquarius- Parameters:
metadata
- the metadata of the DDOproviderConfig
- the endpoints of the DDO's services- Returns:
- an instance of the DDO created
- Throws:
DDOException
- DDOException
-
resolve
DDO resolve(DID did) throws EthereumException, DDOException
Gets a DDO from a DID- Parameters:
did
- the DID to resolve- Returns:
- an instance of the DDO represented by the DID
- Throws:
EthereumException
- EthereumExceptionDDOException
- DDOException
-
getMetadataFiles
List<AssetMetadata.File> getMetadataFiles(DID did) throws DDOException
Gets the list of the files that belongs to a DDO- Parameters:
did
- the DID to resolve- Returns:
- a list of the Files
- Throws:
DDOException
- EncryptionException
-
search
SearchResult search(String text) throws DDOException
Gets all the DDO that match the search criteria- Parameters:
text
- the criteria- Returns:
- a List with all the DDOs found
- Throws:
DDOException
- DDOException
-
search
SearchResult search(String text, int offset, int page) throws DDOException
Gets all the DDOs that match the search criteria- Parameters:
text
- the criteriaoffset
- parameter to paginatepage
- parameter to paginate- Returns:
- a List with all the DDOs found
- Throws:
DDOException
- DDOException
-
query
SearchResult query(Map<String,Object> params, int offset, int page, int sort) throws DDOException
Gets all the DDOs that match the parameters of the query- Parameters:
params
- the criteriaoffset
- parameter to paginatepage
- parameter to paginatesort
- parameter to sort- Returns:
- a List with all the DDOs found
- Throws:
DDOException
- DDOException
-
query
SearchResult query(Map<String,Object> params) throws DDOException
Gets all the DDOs that match the parameters of the query- Parameters:
params
- the criteria- Returns:
- a List with all the DDOs found
- Throws:
DDOException
- DDOException
-
consume
Boolean consume(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, String basePath, int threshold) throws ConsumeServiceException
Downloads a single file of an Asset previously ordered through a Service Agreement- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- of the file inside the files definition in metadatabasePath
- the path where the asset will be downloadedthreshold
- secret store threshold to decrypt the urls of the asset- Returns:
- a flag that indicates if the consume flow was executed correctly
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consume
Boolean consume(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, String basePath) throws ConsumeServiceException
Downloads a single file of an Asset previously ordered through a Service Agreement- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- of the file inside the files definition in metadatabasePath
- the path where the asset will be downloaded- Returns:
- a flag that indicates if the consume flow was executed correctly
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consume
Boolean consume(String serviceAgreementId, DID did, String serviceDefinitionId, String basePath, int threshold) throws ConsumeServiceException
Downloads an Asset previously ordered through a Service Agreement- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idbasePath
- the path where the asset will be downloadedthreshold
- secret store threshold to decrypt the urls of the asset- Returns:
- a flag that indicates if the consume flow was executed correctly
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consume
Boolean consume(String serviceAgreementId, DID did, String serviceDefinitionId, String basePath) throws ConsumeServiceException
Downloads an Asset previously ordered through a Service Agreement- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idbasePath
- the path where the asset will be downloaded- Returns:
- a flag that indicates if the consume flow was executed correctly
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consumeBinary
InputStream consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index) throws ConsumeServiceException
Gets the input stream of one file of the asset- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- the index of the file- Returns:
- the input stream wit the binary content of the file
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consumeBinary
InputStream consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, int threshold) throws ConsumeServiceException
Gets the input stream of one file of the asset- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- the index of the filethreshold
- secret store threshold to decrypt the urls of the asset- Returns:
- the input stream wit the binary content of the file
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consumeBinary
InputStream consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, Integer rangeStart, Integer rangeEnd) throws ConsumeServiceException
Gets a range of bytes of the input stream of one file of the asset- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- the index of the filerangeStart
- the start of the bytes rangerangeEnd
- the end of the bytes range- Returns:
- the input stream wit the binary content of the specified range
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
consumeBinary
InputStream consumeBinary(String serviceAgreementId, DID did, String serviceDefinitionId, Integer index, Integer rangeStart, Integer rangeEnd, int threshold) throws ConsumeServiceException
Gets a range of bytes of the input stream of one file of the asset- Parameters:
serviceAgreementId
- the service agreement id of the assetdid
- the didserviceDefinitionId
- the service definition idindex
- the index of the filerangeStart
- the start of the bytes rangerangeEnd
- the end of the bytes rangethreshold
- secret store threshold to decrypt the urls of the asset- Returns:
- the input stream wit the binary content of the specified range
- Throws:
ConsumeServiceException
- ConsumeServiceException
-
order
io.reactivex.Flowable<OrderResult> order(DID did, String serviceDefinitionId) throws OrderException
Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer- Parameters:
did
- the did of the DDOserviceDefinitionId
- the service definition id- Returns:
- a Flowable instance over an OrderResult to get the result of the flow in an asynchronous fashion
- Throws:
OrderException
- OrderException
-
owner
String owner(DID did) throws Exception
Return the owner of the asset.- Parameters:
did
- the did- Returns:
- the ethereum address of the owner/publisher of given asset did
- Throws:
Exception
- Exception
-
ownerAssets
List<DID> ownerAssets(String ownerAddress) throws ServiceException
List of Asset objects published by ownerAddress- Parameters:
ownerAddress
- ethereum address of owner/publisher- Returns:
- list of dids
- Throws:
ServiceException
- ServiceException
-
consumerAssets
List<DID> consumerAssets(String consumerAddress) throws ServiceException
List of Asset objects purchased by consumerAddress- Parameters:
consumerAddress
- ethereum address of consumer- Returns:
- list of dids
- Throws:
ServiceException
- ServiceException
-
retire
Boolean retire(DID did) throws DDOException
Retire this did of Aquarius- Parameters:
did
- the did- Returns:
- a flag that indicates if the action was executed correctly
- Throws:
DDOException
- DDOException
-
validate
Boolean validate(AssetMetadata metadata) throws DDOException
Validate the asset metadata.- Parameters:
metadata
- the metadata of the DDO- Returns:
- a flag that indicates if the metadata is valid
- Throws:
DDOException
- DDOException
-
-