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
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConfigurationStoreConnection(String userId)
    Clear the connection object for the configuration store which means the platform uses the default store.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearDefaultOMAGServerConfig(String userId)
    Clear the default configuration document.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearPlaceholderVariables(String userId)
    Clear the placeholder variables used whenever an OMAG Server is started.
    org.odpi.openmetadata.adminservices.rest.ConnectionResponse
    getConfigurationStoreConnection(String userId)
    Return the connection object for the configuration store.
    org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse
    getDefaultOMAGServerConfig(String userId)
    Return the default server configuration document.
    org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse
    getPlaceholderVariables(String userId)
    Return the placeholder variables.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setConfigurationStoreConnection(String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Override the default implementation or configuration of the configuration document store.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setDefaultOMAGServerConfig(String userId, org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig defaultServerConfig)
    Override the default server configuration document.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setPlaceholderVariables(String userId, Map<String,String> placeholderVariables)
    Override the placeholder variables.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigStoreResource

      public ConfigStoreResource()

  • Method Details

    • setDefaultOMAGServerConfig

      @PostMapping(path="/default-configuration-document") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setDefaultOMAGServerConfig(@PathVariable String userId, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig defaultServerConfig)
      Override the default server configuration document.
      Parameters:
      userId - calling user.
      defaultServerConfig - values to include in every new configured server.
      Returns:
      void response

    • getDefaultOMAGServerConfig

      @GetMapping(path="/default-configuration-document") public org.odpi.openmetadata.adminservices.rest.OMAGServerConfigResponse getDefaultOMAGServerConfig(@PathVariable String userId)
      Return the default server configuration document.
      Parameters:
      userId - calling user
      Returns:
      OMAGServerConfig response

    • clearDefaultOMAGServerConfig

      @DeleteMapping(path="/default-configuration-document") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearDefaultOMAGServerConfig(@PathVariable String userId)
      Clear the default configuration document.
      Parameters:
      userId - calling user
      Returns:
      void

    • setPlaceholderVariables

      @PostMapping(path="/placeholder-variables") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setPlaceholderVariables(@PathVariable String userId, @RequestBody Map<String,String> placeholderVariables)
      Override the placeholder variables.
      Parameters:
      userId - calling user.
      placeholderVariables - values to include in every new configured server.
      Returns:
      void response

    • getPlaceholderVariables

      @GetMapping(path="/placeholder-variables") public org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse getPlaceholderVariables(@PathVariable String userId)
      Return the placeholder variables.
      Parameters:
      userId - calling user
      Returns:
      string map response

    • clearPlaceholderVariables

      @DeleteMapping(path="/placeholder-variables") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearPlaceholderVariables(@PathVariable String userId)
      Clear the placeholder variables used whenever an OMAG Server is started.
      Parameters:
      userId - calling user
      Returns:
      current setting of default server configuration

    • setConfigurationStoreConnection

      @PostMapping(path="/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfigurationStoreConnection(@PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.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 org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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