JSDoc: Class: RepositoryClientConfig

Constructor

new RepositoryClientConfig(endpoint)

Repository client configuration constructor. Initializes endpoints and sets configuration default values to defaultRDFMimeType, readTimeout and writeTimeout

Parameters:

Name	Type	Description
`endpoint`	string	server base URL that will be prepend to all server requests

Author:

Mihail Radkov
Svilen Velikov
Teodossi Dossev

Source:

repository/repository-client-config.js, line 16

Extends

ClientConfig

Methods

addEndpoint(endpoint) → {this}

Inserts a repository endpoint URL to the rest of the endpoints.

Parameters:

Name	Type	Description
`endpoint`	string	repository endpoint URL

Source:

repository/repository-client-config.js, line 57

Returns:

current config for method chaining

Type: this

disableAuthentication()

Disables authentication.

Overrides:

ClientConfig#disableAuthentication

Source:

http/client-config.js, line 135

getBasicAuthentication() → {boolean}

Overrides:

ClientConfig#getBasicAuthentication

Source:

http/client-config.js, line 96

Returns:

[basicAuth] if use Basic Auth

Type: boolean

getDefaultRDFMimeType() → {string}

Returns the default RDF MIME type.

Source:

repository/repository-client-config.js, line 91

Returns:

Type: string

getEndpoint() → {string}

Returns the server's endpoint URL.

Overrides:

ClientConfig#getEndpoint

Source:

http/client-config.js, line 159

Returns:

the endpoint URL

Type: string

getEndpoints() → {Array.<string>}

Gets the repository endpoint URLs.

Source:

repository/repository-client-config.js, line 70

Returns:

Type: Array.<string>

getGdbTokenAuthentication() → {boolean}

Overrides:

ClientConfig#getGdbTokenAuthentication

Source:

http/client-config.js, line 112

Returns:

[gdbTokenAuth] if use Gdb Token Auth

Type: boolean

getHeaders() → {Object.<string, string>}

Returns the default headers for each HTTP request.

Overrides:

ClientConfig#getHeaders

Source:

http/client-config.js, line 42

Returns:

the default headers map

Type: Object.<string, string>

getKeepAlive() → {boolean}

Overrides:

ClientConfig#getKeepAlive

Source:

http/client-config.js, line 63

Returns:

if the user should be re-logged in after token expires

Type: boolean

getPass() → {string}

Overrides:

ClientConfig#getPass

Source:

http/client-config.js, line 56

Returns:

the user password

Type: string

getReadTimeout() → {number}

Returns the default read timeout for HTTP requests.

Source:

repository/repository-client-config.js, line 112

Returns:

Type: number

getUsername() → {string}

Overrides:

ClientConfig#getUsername

Source:

http/client-config.js, line 49

Returns:

the username

Type: string

getWriteTimeout() → {number}

Returns the default write timeout for HTTP requests.

Source:

repository/repository-client-config.js, line 133

Returns:

Type: number

setDefaultRDFMimeType(defaultRDFMimeType) → {this}

Sets the default RDF MIME type.

Parameters:

Name	Type	Description
`defaultRDFMimeType`	string

Source:

repository/repository-client-config.js, line 81

Returns:

current config for method chaining

Type: this

setEndpoint(endpoint) → {this}

Sets the server's endpoint URL.

Parameters:

Name	Type	Description
`endpoint`	string	the endpoint URL

Overrides:

ClientConfig#setEndpoint

Source:

http/client-config.js, line 145

Returns:

the current config for method chaining

Type: this

setEndpoints(endpoints) → {this}

Sets the repository endpoint URLs.

Parameters:

Name	Type	Description
`endpoints`	Array.<string>	the endpoint URLs

Source:

repository/repository-client-config.js, line 45

Returns:

current config for method chaining

Type: this

setHeaders(headers) → {this}

Sets the default headers map for each HTTP request.

Parameters:

Name	Type	Description
`headers`	Object.<string, string>	the default headers

Overrides:

ClientConfig#setHeaders

Source:

http/client-config.js, line 32

Returns:

the concrete configuration config for method chaining

Type: this

setKeepAlive(keepAlive) → {this}

Parameters:

Name	Type	Description
`keepAlive`	boolean

Overrides:

ClientConfig#setKeepAlive

Source:

http/client-config.js, line 71

Returns:

the concrete configuration config for method chaining

Type: this

setReadTimeout(readTimeout) → {this}

Sets the default read timeout for HTTP requests.

Parameters:

Name	Type	Description
`readTimeout`	number	the timeout in milliseconds

Source:

repository/repository-client-config.js, line 102

Returns:

current config for method chaining

Type: this

setWriteTimeout(writeTimeout) → {this}

Sets the default write timeout for HTTP requests.

Parameters:

Name	Type	Description
`writeTimeout`	number	the timeout in milliseconds

Source:

repository/repository-client-config.js, line 123

Returns:

current config for method chaining

Type: this

shouldAuthenticate() → {boolean}

Returns true if basic or gdb token authentication is enabled. false otherwise.

Overrides:

ClientConfig#shouldAuthenticate

Source:

http/client-config.js, line 169

Returns:

is authentication enabled

Type: boolean

useBasicAuthentication(usernameopt, passopt) → {this}

Username and password for user logging setter. Sets basic authentication as client authentication type.

Parameters:

Name	Type	Attributes	Description
`username`	string	<optional>
`pass`	string	<optional>

Overrides:

ClientConfig#useBasicAuthentication

Source:

http/client-config.js, line 85

Returns:

the concrete configuration config for method chaining

Type: this

useGdbTokenAuthentication(usernameopt, passopt) → {this}

Username and password for user logging setter. Sets gdb token authentication as client authentication type. *

Parameters:

Name	Type	Attributes	Description
`username`	string	<optional>
`pass`	string	<optional>

Overrides:

ClientConfig#useGdbTokenAuthentication

Source:

http/client-config.js, line 125

Returns:

the concrete configuration config for method chaining

Type: this