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.marklogic.client.SessionState	newSessionState() Creates an object to track a session for a set of operations that require session state on the database server.
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.
java.io.Reader	pruneProvenance(com.marklogic.client.SessionState session, java.io.Reader endpointState, java.io.Reader endpointConstants) Prunes provenance according to the retainDuration property provided in endpointConstants.

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

newSessionState

com.marklogic.client.SessionState newSessionState()

Creates an object to track a session for a set of operations that require session state on the database server.

Returns:

an object for session state

pruneProvenance

java.io.Reader pruneProvenance(com.marklogic.client.SessionState session,
                               java.io.Reader endpointState,
                               java.io.Reader endpointConstants)

Prunes provenance according to the retainDuration property provided in endpointConstants.

Parameters:

session - provides input

endpointState - provides input

endpointConstants - provides input

Returns:

as output