Package io.keyko.nevermined.api.impl

Class ProvenanceImpl

java.lang.Object

io.keyko.nevermined.api.impl.ProvenanceImpl

All Implemented Interfaces:

ProvenanceAPI

public class ProvenanceImpl
extends Object
implements ProvenanceAPI

Implementation of AssetsAPI

Field Summary

Fields

Modifier and Type	Field	Description
private NeverminedManager	neverminedManager
private ProvenanceManager	provenanceManager

Constructor Summary

Constructors

Constructor	Description
ProvenanceImpl(NeverminedManager neverminedManager, ProvenanceManager provenanceManager)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	actedOnBehalf(String provenanceId, DID did, String delegateAgentId, String responsibleAgentId, String activityId, String signature, String attributes)	Implements the W3C PROV Delegation action
boolean	addDIDProvenanceDelegate(DID did, String delegate)	Adds an address as delegate for a given DID
List<ProvenanceEvent>	getDIDProvenanceEvents(DID did)	Search for ProvenanceAttributeRegistered events related with a specific DID
ProvenanceEntry	getProvenanceEntry(String provenanceId)	Fetch from the on-chain Provenance registry the information about one provenance event, given a provenance id
List<ProvenanceEvent>	getProvenanceMethodEvents(ProvenanceEntry.ProvenanceMethod method, DID did)	Search for provenance methods (used, wasGeneratedBy, etc.) given a DID
String	getProvenanceOwner(String provenanceId)	Adds an address as delegate for a given DID
boolean	isProvenanceDelegate(DID did, String delegate)	Indicates if an address is a provenance delegate for a given DID
boolean	removeDIDProvenanceDelegate(DID did, String delegate)	Remove an address as delegate for a given DID
boolean	used(String provenanceId, DID did, String agentId, String activityId, String signature, String attributes)	Implements the W3C PROV Usage action
boolean	wasAssociatedWith(String provenanceId, DID did, String agentId, String activityId, String attributes)	Implements the W3C PROV Association action
boolean	wasDerivedFrom(String provenanceId, DID newEntityDid, DID usedEntityDid, String agentId, String activityId, String attributes)	Implements the W3C PROV Derivation action

Methods inherited from class java.lang.Object

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

Field Detail

neverminedManager

private NeverminedManager neverminedManager

provenanceManager

private ProvenanceManager provenanceManager

Constructor Detail

ProvenanceImpl

public ProvenanceImpl(NeverminedManager neverminedManager,
                      ProvenanceManager provenanceManager)

Constructor

Parameters:

neverminedManager - the neverminedManager

provenanceManager - the provenanceManager

Method Detail

used

public boolean used(String provenanceId,
                    DID did,
                    String agentId,
                    String activityId,
                    String signature,
                    String attributes)
             throws ProvenanceException

Description copied from interface: ProvenanceAPI

Implements the W3C PROV Usage action

Specified by:

used in interface ProvenanceAPI

Parameters:

provenanceId - Provenance ID

did - Identifier of the entity created

agentId - Agent Identifier

activityId - Identifier of the activity creating the new entity

signature - Signature (optional) provided by the agent involved

attributes - Attributes associated with the action

Returns:

true if the provenance event was registered correctly

Throws:

ProvenanceException - Error registering the event

wasDerivedFrom

public boolean wasDerivedFrom(String provenanceId,
                              DID newEntityDid,
                              DID usedEntityDid,
                              String agentId,
                              String activityId,
                              String attributes)
                       throws ProvenanceException

Description copied from interface: ProvenanceAPI

Implements the W3C PROV Derivation action

Specified by:

wasDerivedFrom in interface ProvenanceAPI

Parameters:

provenanceId - Provenance ID

newEntityDid - Identifier of the new entity derived

usedEntityDid - Identifier of the entity used to derive the new entity

agentId - Agent Identifier

activityId - Identifier of the activity creating the new entity

attributes - Attributes associated with the action

Returns:

true if the provenance event was registered correctly

Throws:

ProvenanceException - Error registering the event

wasAssociatedWith

public boolean wasAssociatedWith(String provenanceId,
                                 DID did,
                                 String agentId,
                                 String activityId,
                                 String attributes)
                          throws ProvenanceException

Description copied from interface: ProvenanceAPI

Implements the W3C PROV Association action

Specified by:

wasAssociatedWith in interface ProvenanceAPI

Parameters:

provenanceId - Provenance ID

did - Identifier of the entity created

agentId - Agent Identifier

activityId - Identifier of the activity creating the new entity

attributes - Attributes associated with the action

Returns:

true if the provenance event was registered correctly

Throws:

ProvenanceException - Error registering the event

actedOnBehalf

public boolean actedOnBehalf(String provenanceId,
                             DID did,
                             String delegateAgentId,
                             String responsibleAgentId,
                             String activityId,
                             String signature,
                             String attributes)
                      throws ProvenanceException

Description copied from interface: ProvenanceAPI

Implements the W3C PROV Delegation action

Specified by:

actedOnBehalf in interface ProvenanceAPI

Parameters:

provenanceId - Provenance ID

did - Identifier of the entity created

delegateAgentId - Delegate Agent Identifier

responsibleAgentId - Responsible Agent Identifier

activityId - Identifier of the activity creating the new entity

signature - Signature provided by the delegated agent

attributes - Attributes associated with the action

Returns:

true if the provenance event was registered correctly

Throws:

ProvenanceException - Error registering the event

getProvenanceEntry

public ProvenanceEntry getProvenanceEntry(String provenanceId)
                                   throws ProvenanceException

Description copied from interface: ProvenanceAPI

Fetch from the on-chain Provenance registry the information about one provenance event, given a provenance id

Specified by:

getProvenanceEntry in interface ProvenanceAPI

Parameters:

provenanceId - unique identifier of the provenance entry

Returns:

ProvenanceEntry object with all the information stored on-chain

Throws:

ProvenanceException - Error fetching the data

isProvenanceDelegate

public boolean isProvenanceDelegate(DID did,
                                    String delegate)
                             throws ProvenanceException

Description copied from interface: ProvenanceAPI

Indicates if an address is a provenance delegate for a given DID

Specified by:

isProvenanceDelegate in interface ProvenanceAPI

Parameters:

did - Identifier of the asset

delegate - address of the delegate

Returns:

true if the address is a provenance delegate

Throws:

ProvenanceException - Error fetching the data

addDIDProvenanceDelegate

public boolean addDIDProvenanceDelegate(DID did,
                                        String delegate)
                                 throws ProvenanceException

Description copied from interface: ProvenanceAPI

Adds an address as delegate for a given DID

Specified by:

addDIDProvenanceDelegate in interface ProvenanceAPI

Parameters:

did - Identifier of the asset

delegate - address of the delegate

Returns:

true if the address was added as a delegate for the DID given

Throws:

ProvenanceException - Error fetching the data

removeDIDProvenanceDelegate

public boolean removeDIDProvenanceDelegate(DID did,
                                           String delegate)
                                    throws ProvenanceException

Description copied from interface: ProvenanceAPI

Remove an address as delegate for a given DID

Specified by:

removeDIDProvenanceDelegate in interface ProvenanceAPI

Parameters:

did - Identifier of the asset

delegate - address of the delegate

Returns:

true if the address was removed as a delegate for the DID given

Throws:

ProvenanceException - Error fetching the data

getProvenanceOwner

public String getProvenanceOwner(String provenanceId)
                          throws ProvenanceException

Description copied from interface: ProvenanceAPI

Adds an address as delegate for a given DID

Specified by:

getProvenanceOwner in interface ProvenanceAPI

Parameters:

provenanceId - unique identifier of the provenance entry

Returns:

String with the address owning the provenance entry

Throws:

ProvenanceException - Error fetching the data

getDIDProvenanceEvents

public List<ProvenanceEvent> getDIDProvenanceEvents(DID did)
                                             throws ProvenanceException

Description copied from interface: ProvenanceAPI

Search for ProvenanceAttributeRegistered events related with a specific DID

Specified by:

getDIDProvenanceEvents in interface ProvenanceAPI

Parameters:

did - Identifier of the entity we are looking provenance events

Returns:

List of ProvenanceEvents found

Throws:

ProvenanceException - DDOException

getProvenanceMethodEvents

public List<ProvenanceEvent> getProvenanceMethodEvents(ProvenanceEntry.ProvenanceMethod method,
                                                       DID did)
                                                throws ProvenanceException

Description copied from interface: ProvenanceAPI

Search for provenance methods (used, wasGeneratedBy, etc.) given a DID

Specified by:

getProvenanceMethodEvents in interface ProvenanceAPI

Parameters:

method - Provenance methods to fetch

did - Identifier of the entity we are looking provenance events

Returns:

List of ProvenanceEvents found

Throws:

ProvenanceException - DDOException