com.marklogic.hub.dataservices

Interface SecurityService

public interface SecurityService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	describeRole(java.lang.String roleName) Returns the roles, privileges, default permissions, and default collections for the given role
com.fasterxml.jackson.databind.JsonNode	describeUser(java.lang.String username) Returns the roles, privileges, default permissions, and default collections for the given username
static SecurityService	on(com.marklogic.client.DatabaseClient db) Creates a SecurityService object for executing operations on the database server.
static SecurityService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a SecurityService object for executing operations on the database server.

Method Detail

on

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

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

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

describeRole

com.fasterxml.jackson.databind.JsonNode describeRole(java.lang.String roleName)

Returns the roles, privileges, default permissions, and default collections for the given role

Parameters:

roleName - Name of the MarkLogic role to describe

Returns:

JSON object containing the role description data

describeUser

com.fasterxml.jackson.databind.JsonNode describeUser(java.lang.String username)

Returns the roles, privileges, default permissions, and default collections for the given username

Parameters:

username - Name of the MarkLogic user to describe

Returns:

JSON object containing the user description data