com.marklogic.hub.dataservices

Interface ArtifactService

public interface ArtifactService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
void	clearUserArtifacts() Invokes the clearUserArtifacts operation on the database server
com.fasterxml.jackson.databind.JsonNode	getArtifactsWithProjectPaths() Returns a JSON array with an entry for each project artifact and its file path within a project
com.fasterxml.jackson.databind.JsonNode	getList(java.lang.String artifactType) Invokes the getList operation on the database server
static ArtifactService	on(com.marklogic.client.DatabaseClient db) Creates a ArtifactService object for executing operations on the database server.
static ArtifactService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a ArtifactService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	setArtifact(java.lang.String artifactType, java.lang.String artifactName, com.fasterxml.jackson.databind.JsonNode artifact, java.lang.String dirFileName) Invokes the setArtifact operation on the database server

Method Detail

on

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

Creates a ArtifactService 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 ArtifactService on(com.marklogic.client.DatabaseClient db,
                          com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a ArtifactService 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

getArtifactsWithProjectPaths

com.fasterxml.jackson.databind.JsonNode getArtifactsWithProjectPaths()

Returns a JSON array with an entry for each project artifact and its file path within a project

Returns:

as output

setArtifact

com.fasterxml.jackson.databind.JsonNode setArtifact(java.lang.String artifactType,
                                                    java.lang.String artifactName,
                                                    com.fasterxml.jackson.databind.JsonNode artifact,
                                                    java.lang.String dirFileName)

Invokes the setArtifact operation on the database server

Parameters:

artifactType - provides input

artifactName - provides input

artifact - provides input

dirFileName - provides input

Returns:

as output

clearUserArtifacts

void clearUserArtifacts()

Invokes the clearUserArtifacts operation on the database server

getList

com.fasterxml.jackson.databind.JsonNode getList(java.lang.String artifactType)

Invokes the getList operation on the database server

Parameters:

artifactType - provides input

Returns:

as output