JSDoc: Class: GraphDBServerClient

Constructor

new GraphDBServerClient()

Author:

Teodossi Dossev

Source:

server/graphdb-server-client.js, line 33

Methods

createRepository(repositoryConfig) → {Promise.<(HttpResponse|Error)>}

Creates a repository based on the provided configuration.

Parameters:

Name	Type	Description
`repositoryConfig`	RepositoryConfig	The configuration of the repository to be created.

Source:

server/graphdb-server-client.js, line 197

Returns:

A promise that resolves to the response wrapper, or rejects with an error if one occurs during execution.

Type: Promise.<(HttpResponse|Error)>

createUser(username, password, grantedAuthoritiesopt, appSettingsopt) → {Promise.<(HttpResponse|Error)>}

Create a user

Parameters:

Name	Type	Attributes	Description
`username`	string		User name
`password`	string		User password
`grantedAuthorities`	Array.<string>	<optional>	Array of read and/or write access rights described in the following template: `READ_REPO_{repository ID}` to grant repository read rights `WRITE_REPO_{repository ID}` to grant repository write rights
`appSettings`	AppSettings	<optional>	configure the default behavior of the GraphDB Workbench

Source:

server/graphdb-server-client.js, line 294

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

deleteRepository(id, locationopt) → {Promise.<any>}

Deletes the repository with the provided ID.

Parameters:

Name	Type	Attributes	Description
`id`	string		The ID of the repository to delete.
`location`	string	<optional>	The location of the repository (optional).

Source:

server/graphdb-server-client.js, line 107

Returns:

A promise that resolves with the result of the delete operation.

Type: Promise.<any>

deleteUser(username) → {Promise.<(HttpResponse|Error)>}

Deletes a user

Parameters:

Name	Type	Description
`username`	string	User name

Source:

server/graphdb-server-client.js, line 386

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

downloadRepositoryConfig(repositoryId, locationopt) → {Promise.<(string|any)>}

Download the repository configuration in turtle format

Parameters:

Name	Type	Attributes	Description
`repositoryId`	string		the repository id
`location`	string	<optional>	optional repository location

Source:

server/graphdb-server-client.js, line 174

Returns:

a service request that will resolve to a readable stream to which the client can subscribe and consume the emitted strings as soon as they are available. Resolves to turtle format.

Type: Promise.<(string|any)>

getDefaultConfig(repositoryType) → {Promise.<(HttpResponse|Error)>}

Get the default repository configuration for the repository type

Parameters:

Name	Type	Description
`repositoryType`	RepositoryType \| String	the type for which a default configuration is required

Source:

server/graphdb-server-client.js, line 129

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

getFreeAccess() → {Promise.<(HttpResponse|Error)>}

Check if free access is enabled

Source:

server/graphdb-server-client.js, line 273

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

getRepository(id, config) → {Promise.<RDFRepositoryClient>}

Creates a repository client instance with the provided id and configuration.

Parameters:

Name	Type	Description
`id`	string	of the repository
`config`	RepositoryClientConfig	for the overridable repository configuration.

Source:

server/graphdb-server-client.js, line 81

Returns:

promise which resolves with new RDFRepositoryClient instance.

Type: Promise.<RDFRepositoryClient>

getRepositoryConfig(repositoryId, locationopt) → {Promise.<(HttpResponse|string|Error)>}

Retrieves the configuration of a repository.

Parameters:

Name	Type	Attributes	Description
`repositoryId`	string		The ID of the repository whose configuration is to be retrieved.
`location`	string	<optional>	The optional location of the repository.

Source:

server/graphdb-server-client.js, line 152

Returns:

A promise that resolves to the response wrapper, or rejects with an error if one occurs during the execution.

Type: Promise.<(HttpResponse|string|Error)>

getRepositoryIDs(locationopt) → {Promise.<Array.<string>>}

Retrieves the list of repository IDs from the specified location.

Parameters:

Name	Type	Attributes	Description
`location`	string	<optional>	Optional repository location. If provided, the request will be executed for the specified location.

Source:

server/graphdb-server-client.js, line 43

Returns:

A promise that resolves to an array of repository IDs.

Type: Promise.<Array.<string>>

getUser(username) → {Promise.<(HttpResponse|Error)>}

Get a user

Parameters:

Name	Type	Description
`username`	string	User name

Source:

server/graphdb-server-client.js, line 372

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

hasRepository(id, locationopt) → {Promise.<boolean>}

Checks if a repository with the provided ID exists.

Parameters:

Name	Type	Attributes	Description
`id`	string		The ID of the repository to check.
`location`	string	<optional>	The location of the repository (optional).

Source:

server/graphdb-server-client.js, line 63

Returns:

A promise that resolves with a boolean value indicating whether the repository exists.

Type: Promise.<boolean>

isSecurityEnabled() → {Promise.<(HttpResponse|Error)>}

Checks if GraphDB security is enabled.

Source:

server/graphdb-server-client.js, line 212

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

toggleSecurity(enabled) → {Promise.<(HttpResponse|Error)>}

Enable or disable GraphDB security.

Parameters:

Name	Type	Description
`enabled`	boolean	`true` if security is enabled and `false` otherwise.

Source:

server/graphdb-server-client.js, line 226

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

updateFreeAccess(enabled, authorities, appSettings) → {Promise.<(HttpResponse|Error)>}

Enable or disable access to a predefined set of functionalities without having to log in. To use free access, you must have security enabled. Use with extreme caution, as the changes that are made to the application settings may possibly change the behavior of the GraphDB Workbench for the logged-in user or for all users if logged in as admin.

Parameters:

Name	Type	Description
`enabled`	boolean	`true` if free access is enabled and `false` otherwise.
`authorities`	Array.<string>	Array of read and/or write access rights described in the following template: `READ_REPO_{repository ID}` to grant repository read rights `WRITE_REPO_{repository ID}` to grant repository write rights
`appSettings`	AppSettings	configure the default behavior of the GraphDB Workbench

Source:

server/graphdb-server-client.js, line 254

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

updateUser(username, passwordopt, grantedAuthoritiesopt, appSettingsopt) → {Promise.<(HttpResponse|Error)>}

Edit user. Use with extreme caution, as the changes that are made to the application settings may possibly change the behavior of the GraphDB Workbench for the user.

Parameters:

Name	Type	Attributes	Description
`username`	string		User name
`password`	string	<optional>	User password
`grantedAuthorities`	Array.<string>	<optional>	Array of read and/or write access rights described in the following template: `READ_REPO_{repository ID}` to grant repository read rights `WRITE_REPO_{repository ID}` to grant repository write rights
`appSettings`	AppSettings	<optional>	configure the default behavior of the GraphDB Workbench

Source:

server/graphdb-server-client.js, line 325

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>

updateUserData(username, passwordopt, appSettingsopt) → {Promise.<(HttpResponse|Error)>}

Change setting for a logged user. Use with extreme caution, as the changes that are made to the application settings may possibly change the behavior of the GraphDB Workbench for the user.

Parameters:

Name	Type	Attributes	Description
`username`	string		User name
`password`	string	<optional>	User password
`appSettings`	AppSettings	<optional>	configure the default behavior of the GraphDB Workbench

Source:

server/graphdb-server-client.js, line 352

Returns:

a promise which resolves to response wrapper or rejects with error if thrown during execution.

Type: Promise.<(HttpResponse|Error)>