com.marklogic.hub.dataservices

Interface ProvenanceService

public interface ProvenanceService

Defines endpoints for viewing and managing provenance documents

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	deleteProvenance(java.io.Reader endpointState, java.io.Reader endpointConstants) Deletes provenance according to the retainDuration property provided in endpointConstants.
com.fasterxml.jackson.databind.JsonNode	getProvenanceGraph(java.lang.String documentURI) Returns a JSON Object contain Provenance nodes and links.
com.fasterxml.jackson.databind.JsonNode	migrateProvenance(java.io.Reader endpointState, java.io.Reader endpointConstants) Migrates provenance to provenance format starting in DH 5.7.
static ProvenanceService	on(com.marklogic.client.DatabaseClient db) Creates a ProvenanceService object for executing operations on the database server.
static ProvenanceService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a ProvenanceService object for executing operations on the database server.

Method Detail

on

static ProvenanceService on(com.marklogic.client.DatabaseClient db)

Creates a ProvenanceService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.

Parameters:

db - provides a client for communicating with the database server

Returns:

an object for executing database operations

on

static ProvenanceService on(com.marklogic.client.DatabaseClient db,
                            com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a ProvenanceService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.

Parameters:

db - provides a client for communicating with the database server

serviceDeclaration - substitutes a custom implementation of the service

Returns:

an object for executing database operations

getProvenanceGraph

com.fasterxml.jackson.databind.JsonNode getProvenanceGraph(java.lang.String documentURI)

Returns a JSON Object contain Provenance nodes and links. Requires either docURI or jobID to be provided.

Parameters:

documentURI - The documentURI that you wish to get provenance data about.

Returns:

as output

migrateProvenance

com.fasterxml.jackson.databind.JsonNode migrateProvenance(java.io.Reader endpointState,
                                                          java.io.Reader endpointConstants)

Migrates provenance to provenance format starting in DH 5.7.

Parameters:

endpointState - provides input

endpointConstants - provides input

Returns:

as output

deleteProvenance

com.fasterxml.jackson.databind.JsonNode deleteProvenance(java.io.Reader endpointState,
                                                         java.io.Reader endpointConstants)

Deletes provenance according to the retainDuration property provided in endpointConstants.

Parameters:

endpointState - provides input

endpointConstants - provides input

Returns:

as output