com.marklogic.hub.dataservices

Interface SystemService

public interface SystemService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getVersions() Invokes the getVersions operation on the database server
static SystemService	on(com.marklogic.client.DatabaseClient db) Creates a SystemService object for executing operations on the database server.
static SystemService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a SystemService object for executing operations on the database server.

Method Detail

on

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

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

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

getVersions

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

Invokes the getVersions operation on the database server

Returns:

as output