Package org.odpi.openmetadata.adminservices.spring

Class ConfigStoreResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigStoreResource

@RestController
@RequestMapping("/open-metadata/admin-services/users/{userId}/stores")
public class ConfigStoreResource
extends Object

ConfigStoreResource provides the API to configure the connector that should be used to manage configuration documents. The default is to use a file for each configured OMAG server.

Constructor Summary

Constructors

Constructor	Description
ConfigStoreResource()

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearConfigurationStoreConnection(String userId)	Clear the connection object for the configuration store which means the platform uses the default store.
ConnectionResponse	getConfigurationStoreConnection(String userId)	Return the connection object for the configuration store.
VoidResponse	setConfigurationStoreConnection(String userId, Connection connection)	Override the default implementation or configuration of the configuration document store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigStoreResource

public ConfigStoreResource()

Method Detail

setConfigurationStoreConnection

@PostMapping(path="/connection")
public VoidResponse setConfigurationStoreConnection(@PathVariable
                                                    String userId,
                                                    @RequestBody
                                                    Connection connection)

Override the default implementation or configuration of the configuration document store.

Parameters:

userId - calling user.

connection - connection used to create and configure the connector that interacts with the real store.

Returns:

void response

getConfigurationStoreConnection

@GetMapping(path="/connection")
public ConnectionResponse getConfigurationStoreConnection(@PathVariable
                                                          String userId)

Return the connection object for the configuration store. Null is returned if the server should use the default store.

Parameters:

userId - calling user

Returns:

connection response

clearConfigurationStoreConnection

@DeleteMapping(path="/connection")
public VoidResponse clearConfigurationStoreConnection(@PathVariable
                                                      String userId)

Clear the connection object for the configuration store which means the platform uses the default store.

Parameters:

userId - calling user

Returns:

void response