Package io.keyko.nevermined.manager

Class NeverminedManager

java.lang.Object

io.keyko.nevermined.manager.BaseManager

io.keyko.nevermined.manager.NeverminedManager

public class NeverminedManager
extends BaseManager

Handles several operations related with Ocean's flow

Nested Class Summary

Nested classes/interfaces inherited from class io.keyko.nevermined.manager.BaseManager

BaseManager.ContractAddresses

Field Summary

Fields

Modifier and Type	Field	Description
private AgreementsManager	agreementsManager
private static org.apache.logging.log4j.Logger	log
private TemplatesManager	templatesManager

Fields inherited from class io.keyko.nevermined.manager.BaseManager

accessSecretStoreCondition, agreementStoreManager, computeExecutionCondition, condition, conditionStoreManager, config, contractAddresses, didRegistry, dispenser, escrowAccessSecretStoreTemplate, escrowComputeExecutionTemplate, escrowReward, lockRewardCondition, mainAccount, providerAddress, templateStoreManager, tokenContract

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NeverminedManager(io.keyko.common.web3.KeeperService keeperService, MetadataApiService metadataApiService)

Method Summary

Modifier and Type	Method	Description
boolean	access(String serviceAgreementId, DID did, int serviceIndex, int fileIndex, String basePath)	Downloads an Asset previously ordered through a Service Agreement
boolean	access(String serviceAgreementId, DID did, int serviceIndex, String basePath)	Downloads an Asset previously ordered through a Service Agreement
private Map<String,Object>	buildBasicAccessServiceConfiguration(ProviderConfig providerConfig, String price, String creatorAddress)
private Map<String,Object>	buildBasicComputingServiceConfiguration(ProviderConfig providerConfig, ComputingService.Provider computingProvider, String price, String creatorAddress)
private String	buildDestinationPath(String basePath, DID did, int fileIndex, AssetMetadata.File file)	Constructs the final path where the file should be downloaded
private boolean	checkAgreementStatus(String serviceAgreementId)
InputStream	consumeBinary(String serviceAgreementId, DID did, int serviceIndex, int fileIndex)	Downloads a single file of an Asset previously ordered through a Service Agreement
InputStream	consumeBinary(String serviceAgreementId, DID did, int serviceIndex, int fileIndex, Boolean isRangeRequest, Integer rangeStart, Integer rangeEnd)	Downloads a single file of an Asset previously ordered through a Service Agreement.
boolean	downloadAssetByOwner(DID did, int serviceIndex, String basePath)	Purchases an Asset represented by a DID.
boolean	downloadAssetByOwner(DID did, int serviceIndex, String basePath, int fileIndex)	Purchases an Asset represented by a DID.
GatewayService.ServiceExecutionResult	executeComputeService(String agreementId, DID did, int index, DID workflowDID)	Executes a remote service associated with an asset and serviceAgreementId
private Map<String,Object>	fetchAssetDataBeforeConsume(DID did, int serviceIndex)	Gets the data needed to download an asset
private boolean	fulfillEscrowReward(DDO ddo, int serviceIndex, String serviceAgreementId)	Executes the fulfill of the EscrowReward
private boolean	fulfillLockReward(DDO ddo, int serviceIndex, String serviceAgreementId)	Executes the fulfill of the LockRewardCondition
DID	generateDID(DDO ddo)	Given a DDO, returns a DID created using the ddo
List<byte[]>	generateServiceConditionsId(String serviceAgreementId, String consumerAddress, DDO ddo, int serviceIndex)
String	generateSignature(String message)
List<ComputeLogs>	getComputeLogs(String serviceAgreementId, String executionId, String consumerAddress, ProviderConfig providerConfig)	Generates the service endpoint and signature and calls the gateway to get the logs of a compute job
ComputeStatus	getComputeStatus(String serviceAgreementId, String executionId, String consumerAddress, ProviderConfig providerConfig)	Generates the service endpoint and signature and calls the gateway to get the status of a compute job
static NeverminedManager	getInstance(io.keyko.common.web3.KeeperService keeperService, MetadataApiService metadataApiService)	Given the KeeperService and MetadataApiService, returns a new instance of OceanManager using them as attributes
Order	getOrder(String orderId)
private boolean	initializeServiceAgreement(DDO ddo, int serviceIndex, String serviceAgreementId)	Initialize a new ServiceExecutionAgreement between a publisher and a consumer
protected boolean	initializeServiceAgreementDirect(DDO ddo, int serviceIndex, String serviceAgreementId)	Initialize a new ServiceExecutionAgreement between a publisher and a consumer
protected io.reactivex.Flowable<String>	initializeServiceAgreementFlowable(DDO ddo, int serviceIndex, String serviceAgreementId)	Initialize a new ServiceExecutionAgreement between a publisher and a consumer return a flowable to listen contract initialization events
boolean	isConditionFulfilled(String serviceAgreementId, Condition.ConditionTypes conditionType)
OrderResult	purchaseAssetDirect(DID did)	Purchases an Asset represented by a DID.
OrderResult	purchaseAssetDirect(DID did, int serviceIndex)	Purchases an Asset represented by a DID.
OrderResult	purchaseAssetDirect(DID did, int serviceIndex, Service.ServiceTypes serviceType)	Purchases an Asset represented by a DID.
OrderResult	purchaseAssetDirect(DID did, Service.ServiceTypes serviceType)	Purchases an Asset represented by a DID.
io.reactivex.Flowable<OrderResult>	purchaseAssetFlowable(DID did, int serviceIndex)	Purchases an Asset represented by a DID.
DDO	registerAccessServiceAsset(AssetMetadata metadata, ProviderConfig providerConfig)	Creates a new DDO with an AccessService
DDO	registerAccessServiceAsset(AssetMetadata metadata, ProviderConfig providerConfig, AuthConfig authConfig)	Creates a new DDO with an AccessService
private DDO	registerAsset(AssetMetadata metadata, ProviderConfig providerConfig, Service service, AuthConfig authConfig)	Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in Metadata Api
DDO	registerComputeService(AssetMetadata metadata, ProviderConfig providerConfig, ComputingService.Provider computingProvider)	Creates a new DDO with a ComputeService
boolean	registerDID(DID did, String url, String checksum, List<String> providers)	Given a DID and a Metadata API url, register on-chain the DID.
List<AssetMetadata>	searchOrders()
NeverminedManager	setAgreementManager(AgreementsManager agreementManager)
NeverminedManager	setTemplatesManager(TemplatesManager templatesManager)

Methods inherited from class io.keyko.nevermined.manager.BaseManager

buildDDO, getAccessSecretStoreCondition, getComputeExecutionCondition, getContractAddresses, getDecriptedSecretStoreMetadataFiles, getDecriptedSecretStoreMetadataFiles, getEscrowComputeExecutionTemplate, getEscrowReward, getEvmDto, getKeeperService, getLockRewardCondition, getMainAccount, getMetadataApiService, getProviderAddress, getSecretStoreDto, getSecretStoreManager, getTemplateIdByName, resolveDID, setAccessSecretStoreCondition, setAgreementStoreManagerContract, setComputeExecutionCondition, setConditionStoreManagerContract, setDidRegistryContract, setDispenserContract, setEscrowAccessSecretStoreTemplate, setEscrowComputeExecutionTemplate, setEscrowReward, setEvmDto, setKeeperService, setLockRewardCondition, setMainAccount, setMetadataApiService, setProviderAddress, setSecretStoreDto, setSecretStoreManager, setTemplateStoreManagerContract, setTokenContract, tokenApprove, toString

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.logging.log4j.Logger log

agreementsManager

private AgreementsManager agreementsManager

templatesManager

private TemplatesManager templatesManager

Constructor Detail

NeverminedManager

protected NeverminedManager(io.keyko.common.web3.KeeperService keeperService,
                            MetadataApiService metadataApiService)

Method Detail

getInstance

public static NeverminedManager getInstance(io.keyko.common.web3.KeeperService keeperService,
                                            MetadataApiService metadataApiService)

Given the KeeperService and MetadataApiService, returns a new instance of OceanManager using them as attributes

Parameters:

keeperService - Keeper Dto

metadataApiService - Provider Dto

Returns:

NeverminedManager

setAgreementManager

public NeverminedManager setAgreementManager(AgreementsManager agreementManager)

setTemplatesManager

public NeverminedManager setTemplatesManager(TemplatesManager templatesManager)

generateDID

public DID generateDID(DDO ddo)
                throws DIDFormatException

Given a DDO, returns a DID created using the ddo

Parameters:

ddo - the DDO

Returns:

DID

Throws:

DIDFormatException - DIDFormatException

registerDID

public boolean registerDID(DID did,
                           String url,
                           String checksum,
                           List<String> providers)
                    throws DIDRegisterException

Given a DID and a Metadata API url, register on-chain the DID. It allows to resolve DDO's using DID's as input

Parameters:

did - the did

url - metadata url

checksum - calculated hash of the metadata

providers - list of providers addresses to give access

Returns:

boolean success

Throws:

DIDRegisterException - DIDRegisterException

buildBasicAccessServiceConfiguration

private Map<String,Object> buildBasicAccessServiceConfiguration(ProviderConfig providerConfig,
                                                                      String price,
                                                                      String creatorAddress)

buildBasicComputingServiceConfiguration

private Map<String,Object> buildBasicComputingServiceConfiguration(ProviderConfig providerConfig,
                                                                         ComputingService.Provider computingProvider,
                                                                         String price,
                                                                         String creatorAddress)

registerAccessServiceAsset

public DDO registerAccessServiceAsset(AssetMetadata metadata,
                                      ProviderConfig providerConfig)
                               throws DDOException

Creates a new DDO with an AccessService

Parameters:

metadata - the metadata

providerConfig - the service Endpoints

Returns:

an instance of the DDO created

Throws:

DDOException - DDOException

registerAccessServiceAsset

public DDO registerAccessServiceAsset(AssetMetadata metadata,
                                      ProviderConfig providerConfig,
                                      AuthConfig authConfig)
                               throws DDOException

Creates a new DDO with an AccessService

Parameters:

metadata - the metadata

providerConfig - the service Endpoints

authConfig - auth configuration

Returns:

an instance of the DDO created

Throws:

DDOException - DDOException

registerComputeService

public DDO registerComputeService(AssetMetadata metadata,
                                  ProviderConfig providerConfig,
                                  ComputingService.Provider computingProvider)
                           throws DDOException

Creates a new DDO with a ComputeService

Parameters:

metadata - the metadata

providerConfig - the service Endpoints

computingProvider - the data relative to the provider

Returns:

an instance of the DDO created

Throws:

DDOException - DDOException

registerAsset

private DDO registerAsset(AssetMetadata metadata,
                          ProviderConfig providerConfig,
                          Service service,
                          AuthConfig authConfig)
                   throws DDOException

Creates a new DDO, registering it on-chain through DidRegistry contract and off-chain in Metadata Api

Parameters:

metadata - the metadata

providerConfig - the service Endpoints

service - the service

authConfig - auth configuration

Returns:

an instance of the DDO created

Throws:

DDOException - DDOException

isConditionFulfilled

public boolean isConditionFulfilled(String serviceAgreementId,
                                    Condition.ConditionTypes conditionType)
                             throws Exception

Throws:

Exception

purchaseAssetDirect

public OrderResult purchaseAssetDirect(DID did)
                                throws OrderException,
                                       ServiceException,
                                       EscrowRewardException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

Returns:

true if the asset was purchased successfully, if not false

Throws:

OrderException - OrderException

ServiceException - ServiceException

EscrowRewardException - EscrowRewardException

purchaseAssetDirect

public OrderResult purchaseAssetDirect(DID did,
                                       int serviceIndex)
                                throws OrderException,
                                       ServiceException,
                                       EscrowRewardException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceIndex - the index of the service

Returns:

true if the asset was purchased successfully, if not false

Throws:

OrderException - OrderException

ServiceException - ServiceException

EscrowRewardException - EscrowRewardException

purchaseAssetDirect

public OrderResult purchaseAssetDirect(DID did,
                                       Service.ServiceTypes serviceType)
                                throws OrderException,
                                       ServiceException,
                                       EscrowRewardException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceType - Service to purchase

Returns:

true if the asset was purchased successfully, if not false

Throws:

OrderException - OrderException

ServiceException - ServiceException

EscrowRewardException - EscrowRewardException

purchaseAssetDirect

public OrderResult purchaseAssetDirect(DID did,
                                       int serviceIndex,
                                       Service.ServiceTypes serviceType)
                                throws OrderException,
                                       ServiceException,
                                       EscrowRewardException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceIndex - the index of the service

serviceType - Service to purchase

Returns:

true if the asset was purchased successfully, if not false

Throws:

OrderException - OrderException

ServiceException - ServiceException

EscrowRewardException - EscrowRewardException

purchaseAssetFlowable

public io.reactivex.Flowable<OrderResult> purchaseAssetFlowable(DID did,
                                                                int serviceIndex)
                                                         throws OrderException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceIndex - the index of the service

Returns:

a Flowable instance over an OrderResult to get the result of the flow in an asynchronous fashion

Throws:

OrderException - OrderException

downloadAssetByOwner

public boolean downloadAssetByOwner(DID did,
                                    int serviceIndex,
                                    String basePath)
                             throws ServiceException,
                                    ConsumeServiceException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceIndex - the service index in the ddo to download

basePath - path where we want to download the asset files

Returns:

true if the asset was purchased successfully, if not false

Throws:

ServiceException - ServiceException

ConsumeServiceException - ConsumeServiceException

downloadAssetByOwner

public boolean downloadAssetByOwner(DID did,
                                    int serviceIndex,
                                    String basePath,
                                    int fileIndex)
                             throws ServiceException,
                                    ConsumeServiceException

Purchases an Asset represented by a DID. It implies to initialize a Service Agreement between publisher and consumer

Parameters:

did - the did

serviceIndex - the service index in the ddo to download

basePath - path where we want to download the asset files

fileIndex - index of the file inside the files definition in metadata

Returns:

true if the asset was purchased successfully, if not false

Throws:

ServiceException - ServiceException

ConsumeServiceException - ConsumeServiceException

generateServiceConditionsId

public List<byte[]> generateServiceConditionsId(String serviceAgreementId,
                                                String consumerAddress,
                                                DDO ddo,
                                                int serviceIndex)
                                         throws ServiceAgreementException,
                                                ServiceException

Throws:

ServiceAgreementException

ServiceException

initializeServiceAgreement

private boolean initializeServiceAgreement(DDO ddo,
                                           int serviceIndex,
                                           String serviceAgreementId)
                                    throws ServiceException,
                                           ServiceAgreementException

Initialize a new ServiceExecutionAgreement between a publisher and a consumer

Parameters:

ddo - the ddi

serviceIndex - the service index

serviceAgreementId - the service agreement id

Returns:

true if the agreement was initialized correctly, if not false

Throws:

ServiceException - ServiceException

ServiceAgreementException - ServiceAgreementException

initializeServiceAgreementDirect

protected boolean initializeServiceAgreementDirect(DDO ddo,
                                                   int serviceIndex,
                                                   String serviceAgreementId)
                                            throws ServiceException,
                                                   ServiceAgreementException

Initialize a new ServiceExecutionAgreement between a publisher and a consumer

Parameters:

ddo - the ddi

serviceIndex - the service index

serviceAgreementId - the service agreement id

Returns:

true if the agreement was initialized correctly, if not false

Throws:

ServiceException - ServiceException

ServiceAgreementException - ServiceAgreementException

initializeServiceAgreementFlowable

protected io.reactivex.Flowable<String> initializeServiceAgreementFlowable(DDO ddo,
                                                                           int serviceIndex,
                                                                           String serviceAgreementId)
                                                                    throws ServiceException,
                                                                           ServiceAgreementException

Initialize a new ServiceExecutionAgreement between a publisher and a consumer return a flowable to listen contract initialization events

Parameters:

ddo - the ddi

serviceIndex - the service index

serviceAgreementId - the service agreement id

Returns:

a Flowable over an AgreementInitializedEventResponse

Throws:

ServiceException - ServiceException

ServiceAgreementException - ServiceAgreementException

checkAgreementStatus

private boolean checkAgreementStatus(String serviceAgreementId)
                              throws ServiceAgreementException

Throws:

ServiceAgreementException

fulfillLockReward

private boolean fulfillLockReward(DDO ddo,
                                  int serviceIndex,
                                  String serviceAgreementId)
                           throws ServiceException,
                                  LockRewardFulfillException

Executes the fulfill of the LockRewardCondition

Parameters:

ddo - the ddo

serviceIndex - the index of the service

serviceAgreementId - service agreement id

Returns:

a flag that indicates if the function was executed correctly

Throws:

ServiceException - ServiceException

LockRewardFulfillException - LockRewardFulfillException

fulfillEscrowReward

private boolean fulfillEscrowReward(DDO ddo,
                                    int serviceIndex,
                                    String serviceAgreementId)
                             throws ServiceException,
                                    EscrowRewardException

Executes the fulfill of the EscrowReward

Parameters:

ddo - the ddo

serviceIndex - the index of the service

serviceAgreementId - service agreement id

Returns:

a flag that indicates if the function was executed correctly

Throws:

ServiceException - ServiceException

EscrowRewardException - EscrowRewardException

fetchAssetDataBeforeConsume

private Map<String,Object> fetchAssetDataBeforeConsume(DID did,
                                                             int serviceIndex)
                                                      throws ConsumeServiceException

Gets the data needed to download an asset

Parameters:

did - the did

serviceIndex - the id of the service in the DDO

Returns:

a Map with the data needed to consume the asset

Throws:

ConsumeServiceException - ConsumeServiceException

access

public boolean access(String serviceAgreementId,
                      DID did,
                      int serviceIndex,
                      String basePath)
               throws ConsumeServiceException

Downloads an Asset previously ordered through a Service Agreement

Parameters:

serviceAgreementId - the service agreement id

did - the did

serviceIndex - the service index in the DDO

basePath - the path where the asset will be downloaded

Returns:

a flag that indicates if the consume operation was executed correctly

Throws:

ConsumeServiceException - ConsumeServiceException

access

public boolean access(String serviceAgreementId,
                      DID did,
                      int serviceIndex,
                      int fileIndex,
                      String basePath)
               throws ConsumeServiceException

Downloads an Asset previously ordered through a Service Agreement

Parameters:

serviceAgreementId - the service agreement id

did - the did

serviceIndex - id of the service in the DDO

fileIndex - of the file inside the files definition in metadata

basePath - the path where the asset will be downloaded

Returns:

a flag that indicates if the consume operation was executed correctly

Throws:

ConsumeServiceException - ConsumeServiceException

buildDestinationPath

private String buildDestinationPath(String basePath,
                                    DID did,
                                    int fileIndex,
                                    AssetMetadata.File file)

Constructs the final path where the file should be downloaded

Parameters:

basePath - the path where the asset will be downloaded

did - the did

fileIndex - index of the file inside the files definition in metadata

file - the asset metadata file

Returns:

the destination path to download the file

generateSignature

public String generateSignature(String message)
                         throws IOException,
                                org.web3j.crypto.CipherException

Throws:

IOException

org.web3j.crypto.CipherException

consumeBinary

public InputStream consumeBinary(String serviceAgreementId,
                                 DID did,
                                 int serviceIndex,
                                 int fileIndex)
                          throws ConsumeServiceException

Downloads a single file of an Asset previously ordered through a Service Agreement

Parameters:

serviceAgreementId - the service agreement id

did - the did

serviceIndex - the id of the service index in the DDO

fileIndex - of the file inside the files definition in metadata

Returns:

an InputStream that represents the binary content

Throws:

ConsumeServiceException - ConsumeServiceException

consumeBinary

public InputStream consumeBinary(String serviceAgreementId,
                                 DID did,
                                 int serviceIndex,
                                 int fileIndex,
                                 Boolean isRangeRequest,
                                 Integer rangeStart,
                                 Integer rangeEnd)
                          throws ConsumeServiceException

Downloads a single file of an Asset previously ordered through a Service Agreement. It could be a request by range of bytes

Parameters:

serviceAgreementId - the service agreement id

did - the did

serviceIndex - id of the service in the DDO

fileIndex - of the file inside the files definition in metadata

isRangeRequest - indicates if is a request by range of bytes

rangeStart - the start of the bytes range

rangeEnd - the end of the bytes range

Returns:

an InputStream that represents the binary content

Throws:

ConsumeServiceException - ConsumeServiceException

executeComputeService

public GatewayService.ServiceExecutionResult executeComputeService(String agreementId,
                                                                   DID did,
                                                                   int index,
                                                                   DID workflowDID)
                                                            throws ServiceException

Executes a remote service associated with an asset and serviceAgreementId

Parameters:

agreementId - the agreement id

did - the did

index - the index of the service

workflowDID - the workflow id

Returns:

an execution id

Throws:

ServiceException - ServiceException

getComputeLogs

public List<ComputeLogs> getComputeLogs(String serviceAgreementId,
                                        String executionId,
                                        String consumerAddress,
                                        ProviderConfig providerConfig)
                                 throws ServiceException

Generates the service endpoint and signature and calls the gateway to get the logs of a compute job

Parameters:

serviceAgreementId - The agreement id for the compute to the data

executionId - The id of the compute job

consumerAddress - The address of the consumer of the compute to the data job

providerConfig - The configuration of the provider.

Returns:

A list of log lines.

Throws:

ServiceException - Service Exception

getComputeStatus

public ComputeStatus getComputeStatus(String serviceAgreementId,
                                      String executionId,
                                      String consumerAddress,
                                      ProviderConfig providerConfig)
                               throws ServiceException

Generates the service endpoint and signature and calls the gateway to get the status of a compute job

Parameters:

serviceAgreementId - The agreement id for the compute to the data

executionId - The id of the compute job

consumerAddress - The address of the consumer of the compute to the data job

providerConfig - The configuration of the provider.

Returns:

The current status of the compute job.

Throws:

ServiceException - Service Exception

getOrder

public Order getOrder(String orderId)

searchOrders

public List<AssetMetadata> searchOrders()