Package io.keyko.nevermined.api

Class NeverminedAPI

java.lang.Object

io.keyko.nevermined.api.NeverminedAPI

public class NeverminedAPI
extends Object

Class that represents the entry point to initialize and use the API

Field Summary

Fields

Modifier and Type	Field	Description
private io.keyko.nevermined.contracts.AccessSecretStoreCondition	accessSecretStoreCondition
private AccountsAPI	accountsAPI
private AccountsManager	accountsManager
private AgreementsAPI	agreementsAPI
private AgreementsManager	agreementsManager
private io.keyko.nevermined.contracts.AgreementStoreManager	agreementStoreManagerContract
private AssetsAPI	assetsAPI
private AssetsManager	assetsManager
private io.keyko.nevermined.contracts.ComputeExecutionCondition	computeExecutionCondition
private ConditionsAPI	conditionsAPI
private ConditionsManager	conditionsManager
private io.keyko.nevermined.contracts.ConditionStoreManager	conditionStoreManager
private io.keyko.nevermined.contracts.DIDRegistry	didRegistryContract
private io.keyko.nevermined.contracts.Dispenser	dispenser
private io.keyko.nevermined.contracts.EscrowAccessSecretStoreTemplate	escrowAccessSecretStoreTemplate
private io.keyko.nevermined.contracts.EscrowComputeExecutionTemplate	escrowComputeExecutionTemplate
private io.keyko.nevermined.contracts.EscrowReward	escrowReward
private com.oceanprotocol.secretstore.core.EvmDto	evmDto
private io.keyko.common.web3.KeeperService	keeperService
private io.keyko.nevermined.contracts.LockRewardCondition	lockRewardCondition
private static org.apache.logging.log4j.Logger	log
private Account	mainAccount
private MetadataApiService	metadataApiService
private static NeverminedAPI	neverminedAPI
private NeverminedConfig	neverminedConfig
private NeverminedManager	neverminedManager
private SecretStoreAPI	secretStoreAPI
private com.oceanprotocol.secretstore.core.SecretStoreDto	secretStoreDto
private SecretStoreManager	secretStoreManager
private TemplatesAPI	templatesAPI
private TemplatesManager	templatesManager
private io.keyko.nevermined.contracts.TemplateStoreManager	templateStoreManagerContract
private io.keyko.nevermined.contracts.NeverminedToken	tokenContract
private TokensAPI	tokensAPI

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NeverminedAPI(NeverminedConfig neverminedConfig)	Private constructor

Method Summary

Modifier and Type	Method	Description
AccountsAPI	getAccountsAPI()	Gets the AccountsAPI
AgreementsAPI	getAgreementsAPI()	Gets the AgreementsAPI
AssetsAPI	getAssetsAPI()	Gets the AssetsAPI
ConditionsAPI	getConditionsAPI()	Gets the ConditionsAPI
static NeverminedAPI	getInstance(com.typesafe.config.Config config)	Build an Instance of Nevermined API from a TypeSafe Config object
static NeverminedAPI	getInstance(Properties properties)	Build an Instance of Nevermined API from a Properties object
Account	getMainAccount()	Gets the account used to initialized the API
SecretStoreAPI	getSecretStoreAPI()	Gets the SecretStoreAPI
TemplatesAPI	getTemplatesAPI()	Gets the TemplatesAPI
TokensAPI	getTokensAPI()	Gets the TokensAPI
private static void	setRxUndeliverableExceptionHandler()
void	setTemplateStoreManagerContract(io.keyko.nevermined.contracts.TemplateStoreManager contract)	Allows to overwrite the TemplateStoreManager contract instance
private static Properties	toProperties(com.typesafe.config.Config config)	Transform a TypeSafe Config object into a Java's Properties

Methods inherited from class java.lang.Object

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

Field Detail

log

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

neverminedConfig

private NeverminedConfig neverminedConfig

keeperService

private io.keyko.common.web3.KeeperService keeperService

metadataApiService

private MetadataApiService metadataApiService

secretStoreDto

private com.oceanprotocol.secretstore.core.SecretStoreDto secretStoreDto

evmDto

private com.oceanprotocol.secretstore.core.EvmDto evmDto

secretStoreManager

private SecretStoreManager secretStoreManager

neverminedManager

private NeverminedManager neverminedManager

assetsManager

private AssetsManager assetsManager

accountsManager

private AccountsManager accountsManager

agreementsManager

private AgreementsManager agreementsManager

conditionsManager

private ConditionsManager conditionsManager

templatesManager

private TemplatesManager templatesManager

tokenContract

private io.keyko.nevermined.contracts.NeverminedToken tokenContract

dispenser

private io.keyko.nevermined.contracts.Dispenser dispenser

didRegistryContract

private io.keyko.nevermined.contracts.DIDRegistry didRegistryContract

escrowAccessSecretStoreTemplate

private io.keyko.nevermined.contracts.EscrowAccessSecretStoreTemplate escrowAccessSecretStoreTemplate

lockRewardCondition

private io.keyko.nevermined.contracts.LockRewardCondition lockRewardCondition

accessSecretStoreCondition

private io.keyko.nevermined.contracts.AccessSecretStoreCondition accessSecretStoreCondition

escrowReward

private io.keyko.nevermined.contracts.EscrowReward escrowReward

templateStoreManagerContract

private io.keyko.nevermined.contracts.TemplateStoreManager templateStoreManagerContract

agreementStoreManagerContract

private io.keyko.nevermined.contracts.AgreementStoreManager agreementStoreManagerContract

conditionStoreManager

private io.keyko.nevermined.contracts.ConditionStoreManager conditionStoreManager

computeExecutionCondition

private io.keyko.nevermined.contracts.ComputeExecutionCondition computeExecutionCondition

escrowComputeExecutionTemplate

private io.keyko.nevermined.contracts.EscrowComputeExecutionTemplate escrowComputeExecutionTemplate

accountsAPI

private AccountsAPI accountsAPI

agreementsAPI

private AgreementsAPI agreementsAPI

conditionsAPI

private ConditionsAPI conditionsAPI

tokensAPI

private TokensAPI tokensAPI

assetsAPI

private AssetsAPI assetsAPI

secretStoreAPI

private SecretStoreAPI secretStoreAPI

templatesAPI

private TemplatesAPI templatesAPI

mainAccount

private Account mainAccount

neverminedAPI

private static NeverminedAPI neverminedAPI

Constructor Detail

NeverminedAPI

private NeverminedAPI(NeverminedConfig neverminedConfig)

Private constructor

Parameters:

neverminedConfig - the object to configure the API

Method Detail

toProperties

private static Properties toProperties(com.typesafe.config.Config config)

Transform a TypeSafe Config object into a Java's Properties

Parameters:

config - the config object

Returns:

a Properties object with the configuration of the API

setRxUndeliverableExceptionHandler

private static void setRxUndeliverableExceptionHandler()

getInstance

public static NeverminedAPI getInstance(Properties properties)
                                 throws InitializationException,
                                        InvalidConfiguration

Build an Instance of Nevermined API from a Properties object

Parameters:

properties - values of the configuration

Returns:

an Initialized NeverminedAPI object

Throws:

InitializationException - InitializationException

InvalidConfiguration - InvalidConfiguration

getInstance

public static NeverminedAPI getInstance(com.typesafe.config.Config config)
                                 throws InitializationException,
                                        InvalidConfiguration

Build an Instance of Nevermined API from a TypeSafe Config object

Parameters:

config - the config object

Returns:

an Initialized NeverminedAPI object

Throws:

InitializationException - InitializationException

InvalidConfiguration - InvalidConfiguration

getMainAccount

public Account getMainAccount()

Gets the account used to initialized the API

Returns:

the account used to initialized the API

getAccountsAPI

public AccountsAPI getAccountsAPI()

Gets the AccountsAPI

Returns:

an instance of an Implementation class of AccountsAPI

getAgreementsAPI

public AgreementsAPI getAgreementsAPI()

Gets the AgreementsAPI

Returns:

an instance of an Implementation class of AgreementsAPI

getConditionsAPI

public ConditionsAPI getConditionsAPI()

Gets the ConditionsAPI

Returns:

an instance of an Implementation class of ConditionsAPI

getTokensAPI

public TokensAPI getTokensAPI()

Gets the TokensAPI

Returns:

an instance of an Implementation class of TokensAPI

getAssetsAPI

public AssetsAPI getAssetsAPI()

Gets the AssetsAPI

Returns:

an instance of an Implementation class of AssetsAPI

getSecretStoreAPI

public SecretStoreAPI getSecretStoreAPI()

Gets the SecretStoreAPI

Returns:

an instance of an Implementation class of SecretStoreAPI

getTemplatesAPI

public TemplatesAPI getTemplatesAPI()

Gets the TemplatesAPI

Returns:

an instance of an Implementation class of TemplatesAPI

setTemplateStoreManagerContract

public void setTemplateStoreManagerContract(io.keyko.nevermined.contracts.TemplateStoreManager contract)

Allows to overwrite the TemplateStoreManager contract instance

Parameters:

contract - TemplateStoreManager