Package org.odpi.openmetadata.adminservices.spring

Class ConfigRepositoryServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigRepositoryServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}") public class ConfigRepositoryServicesResource extends Object
ConfigRepositoryServicesResource provides the configuration services for setting up the repository services subsystems.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigRepositoryServicesResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addAuditLogDestination(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Add an audit log destination that is defined by the supplied connection object.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addCohortRegistration(String userId, String serverName, String cohortName, Map<String,Object> additionalProperties)
    Enable registration of server to an open metadata repository cohort using the default topic structure (DEDICATED_TOPICS).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addCohortRegistration(String userId, String serverName, String cohortName, org.odpi.openmetadata.adminservices.configuration.properties.CohortTopicStructure cohortTopicStructure, Map<String,Object> additionalProperties)
    Enable registration of server to an open metadata repository cohort using the topic pattern specified by cohortTopicStructure.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addConsoleAuditLogDestination(String userId, String serverName, List<String> supportedSeverities)
    Set up the console audit log for the server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addEventTopicAuditLogDestination(String userId, String serverName, String topicName, List<String> supportedSeverities)
    Add an audit log destination that sends each log record as an event on the supplied event topic.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addFileAuditLogDestination(String userId, String serverName, String directoryName, List<String> supportedSeverities)
    Add an audit log destination that creates log records as JSON files in a shared directory.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addJDBCAuditLogDestination(String userId, String serverName, String connectionString, List<String> supportedSeverities)
    Add an audit log destination that creates log records as rows in a JDBC Database.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSLF4JAuditLogDestination(String userId, String serverName, List<String> supportedSeverities)
    Add an audit log destination that creates slf4j records.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addStartUpOpenMetadataArchiveFile(String userId, String serverName, String fileName)
    Add a new open metadata archive to load at startup.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAuditLogDestination(String userId, String serverName, String connectionName)
    Delete an audit log destination that is identified with the supplied connection's name.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAuditLogDestinations(String userId, String serverName)
    Clears all audit log destinations for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearCohortConfig(String userId, String serverName, String cohortName)
    Unregister this server from an open metadata repository cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearLocalRepositoryConfig(String userId, String serverName)
    Remove all configuration for a local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearOpenMetadataArchives(String userId, String serverName)
    Clear the list of open metadata archives.
    org.odpi.openmetadata.adminservices.rest.ConnectionListResponse
    getAuditLogDestinations(String userId, String serverName)
    Set up the list of audit log destinations.
    org.odpi.openmetadata.adminservices.rest.CohortConfigResponse
    getCohortConfig(String userId, String serverName, String cohortName)
    Retrieve the registration of server to an open metadata repository cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse
    getCohortTopicName(String userId, String serverName, String cohortName)
    Retrieve the current topic name for the cohort.
    org.odpi.openmetadata.adminservices.rest.DedicatedTopicListResponse
    getDedicatedCohortTopicNames(String userId, String serverName, String cohortName)
    Retrieve the current topic name for the cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    getLocalMetadataCollectionId(String userId, String serverName)
    Return the local metadata collection id.
    org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse
    getLocalMetadataCollectionName(String userId, String serverName)
    Return the local metadata collection name.
    org.odpi.openmetadata.adminservices.rest.LocalRepositoryConfigResponse
    getLocalRepositoryConfig(String userId, String serverName)
    Return the configuration for the local repository.
    org.odpi.openmetadata.adminservices.rest.ConnectionListResponse
    getOpenMetadataArchives(String userId, String serverName)
    Return the list of open metadata archives.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    overrideCohortTopicName(String userId, String serverName, String cohortName, String topicName)
    Override the current name for the single topic for the cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    overrideInstancesCohortTopicName(String userId, String serverName, String cohortName, String topicName)
    Override the current name for the "instances" topic for the cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    overrideRegistrationCohortTopicName(String userId, String serverName, String cohortName, String topicName)
    Override the current name for the registration topic for the cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    overrideTypesCohortTopicName(String userId, String serverName, String cohortName, String topicName)
    Override the current name for the "types" topic for the cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    resetRemoteCohortURL(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.URLRequestBody requestBody)
    Update the URL broadcast across the cohort to allow other members to issue queries to this repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setAuditLogDestinations(String userId, String serverName, List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection> auditLogDestinations)
    Set up the list of audit log destinations.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setCohortConfig(String userId, String serverName, String cohortName, org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig cohortConfig)
    Set up the configuration properties for a cohort.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setDefaultAuditLog(String userId, String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Set up the default audit log for the server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setGraphLocalRepository(String userId, String serverName, Map<String,Object> storageProperties)
    Set up a graph store as the local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setInMemLocalRepository(String userId, String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Set up an in memory local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setLocalMetadataCollectionId(String userId, String serverName, String metadataCollectionId)
    Set up the local metadata collection id.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setLocalMetadataCollectionName(String userId, String serverName, String name)
    Set up the local metadata collection name.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setLocalRepositoryConfig(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig localRepositoryConfig)
    Set up the configuration for the local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setNoRepositoryMode(String userId, String serverName)
    Remove all configuration for a local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setOpenMetadataArchives(String userId, String serverName, List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection> openMetadataArchives)
    Set up the list of open metadata archives.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setPluginRepositoryConnection(String userId, String serverName, String connectorProvider, Map<String,Object> additionalProperties)
    Provide the connection to the local repository - used when the local repository mode is set to plugin repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setPluginRepositoryConnection(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Provide the connection to the local repository - used when the local repository mode is set to plugin repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setReadOnlyLocalRepository(String userId, String serverName)
    Set up a read only local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setRepositoryProxyConnection(String userId, String serverName, String connectorProvider, Map<String,Object> additionalProperties)
    Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setRepositoryProxyConnection(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setRepositoryProxyEventMapper(String userId, String serverName, String connectorProvider, String eventSource, Map<String,Object> additionalProperties)
    Provide the connection to a repository proxy's event mapper.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setRepositoryProxyEventMapper(String userId, String serverName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Provide the connection to a repository proxy's event mapper.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setXTDBInMemRepository(String userId, String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Set up an XTDB store as the local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setXTDBLocalKVRepository(String userId, String serverName, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Set up an XTDB store as the local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setXTDBLocalRepository(String userId, String serverName, Map<String,Object> storageProperties)
    Set up an XTDB store as the local repository.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateAuditLogDestination(String userId, String serverName, String connectionName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Update an audit log destination that is identified with the supplied destination name with the supplied connection object.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigRepositoryServicesResource

      public ConfigRepositoryServicesResource()

  • Method Details

    • setDefaultAuditLog

      @PostMapping(path="/audit-log-destinations/default") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setDefaultAuditLog(@PathVariable String userId, @PathVariable String serverName, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Set up the default audit log for the server. This adds the console audit log destination.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - null request body
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addConsoleAuditLogDestination

      @PostMapping(path="/audit-log-destinations/console") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addConsoleAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<String> supportedSeverities)
      Set up the console audit log for the server. This writes selected parts of the audit log record to stdout.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      supportedSeverities - list of severities that should be logged to this destination (empty list means all)
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addSLF4JAuditLogDestination

      @PostMapping(path="/audit-log-destinations/slf4j") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSLF4JAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<String> supportedSeverities)
      Add an audit log destination that creates slf4j records.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      supportedSeverities - list of severities that should be logged to this destination (empty list means all)
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addFileAuditLogDestination

      @PostMapping(path="/audit-log-destinations/files") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addFileAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestParam(required=false) String directoryName, @RequestBody List<String> supportedSeverities)
      Add an audit log destination that creates log records as JSON files in a shared directory.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      directoryName - name of directory
      supportedSeverities - list of severities that should be logged to this destination (empty list means all)
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addJDBCAuditLogDestination

      @PostMapping(path="/audit-log-destinations/jdbc") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addJDBCAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestParam String connectionString, @RequestBody List<String> supportedSeverities)
      Add an audit log destination that creates log records as rows in a JDBC Database.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectionString - name of directory
      supportedSeverities - list of severities that should be logged to this destination (empty list means all)
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addEventTopicAuditLogDestination

      @PostMapping(path="/audit-log-destinations/event-topic") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addEventTopicAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestParam(required=false) String topicName, @RequestBody List<String> supportedSeverities)
      Add an audit log destination that sends each log record as an event on the supplied event topic.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      topicName - name of topic
      supportedSeverities - list of severities that should be logged to this destination (empty list means all)
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • addAuditLogDestination

      @PostMapping(path="/audit-log-destinations/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Add an audit log destination that is defined by the supplied connection object.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connection - connection object that defines the audit log destination
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • updateAuditLogDestination

      @PostMapping(path="/audit-log-destinations/connection/{connectionName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @PathVariable String connectionName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Update an audit log destination that is identified with the supplied destination name with the supplied connection object.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectionName - name of the audit log destination connection to be updated
      connection - connection object that defines the audit log destination
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

    • clearAuditLogDestination

      @DeleteMapping(path="/audit-log-destinations/connection/{connectionName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAuditLogDestination(@PathVariable String userId, @PathVariable String serverName, @PathVariable String connectionName)
      Delete an audit log destination that is identified with the supplied connection's name.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectionName - qualified name of the audit log destination connection to be deleted.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • addStartUpOpenMetadataArchiveFile

      @PostMapping(path="/open-metadata-archives/file") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addStartUpOpenMetadataArchiveFile(@PathVariable String userId, @PathVariable String serverName, @RequestBody String fileName)
      Add a new open metadata archive to load at startup. This open metadata archive is a JSON file.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      fileName - name of the open metadata archive file.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or fileName parameter.

    • setNoRepositoryMode

      @DeleteMapping(path="/local-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setNoRepositoryMode(@PathVariable String userId, @PathVariable String serverName)
      Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setInMemLocalRepository

      @PostMapping(path="/local-repository/mode/in-memory-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setInMemLocalRepository(@PathVariable String userId, @PathVariable String serverName, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Set up an in memory local repository. This repository uses hashmaps to store content. It is useful for demos, testing and POCs.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - null request body
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setGraphLocalRepository

      @PostMapping(path="/local-repository/mode/local-graph-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setGraphLocalRepository(@PathVariable String userId, @PathVariable String serverName, @RequestBody @Nullable Map<String,Object> storageProperties)
      Set up a graph store as the local repository. This repository uses JanusGraph.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      storageProperties - properties used to configure the back end storage for the graph
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setXTDBInMemRepository

      @PostMapping(path="/local-repository/mode/xtdb-in-memory-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setXTDBInMemRepository(@PathVariable String userId, @PathVariable String serverName, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Set up an XTDB store as the local repository. This store uses XTDB to provide a historical metadata repository that operates in memory. This version of the XTDB repository is designed for testing.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - null request body
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setXTDBLocalKVRepository

      @PostMapping(path="/local-repository/mode/xtdb-local-kv-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setXTDBLocalKVRepository(@PathVariable String userId, @PathVariable String serverName, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Set up an XTDB store as the local repository. This store uses XTDB with RocksDB KV store to provide a high performance historical metadata repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - null request body
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setXTDBLocalRepository

      @PostMapping(path="/local-repository/mode/xtdb-local-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setXTDBLocalRepository(@PathVariable String userId, @PathVariable String serverName, @RequestBody Map<String,Object> storageProperties)
      Set up an XTDB store as the local repository. This store uses XTDB to provide a high performance historical metadata repository. It is scalable with different back ends and can be run in a HA context with multiple versions of the same server deployed to the same repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      storageProperties - properties used to configure the back end storage for the graph
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setReadOnlyLocalRepository

      @PostMapping(path="/local-repository/mode/read-only-repository") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setReadOnlyLocalRepository(@PathVariable String userId, @PathVariable String serverName)
      Set up a read only local repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setPluginRepositoryConnection

      @PostMapping(path="/local-repository/mode/plugin-repository/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setPluginRepositoryConnection(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Provide the connection to the local repository - used when the local repository mode is set to plugin repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connection - connection to the OMRS repository connector.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or OMAGConfigurationErrorException the local repository mode has not been set

    • setPluginRepositoryConnection

      @PostMapping(path="/local-repository/mode/plugin-repository/details") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setPluginRepositoryConnection(@PathVariable String userId, @PathVariable String serverName, @RequestParam String connectorProvider, @RequestBody(required=false) Map<String,Object> additionalProperties)
      Provide the connection to the local repository - used when the local repository mode is set to plugin repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectorProvider - connector provider class name to the OMRS repository connector.
      additionalProperties - additional parameters to pass to the repository connector
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or OMAGConfigurationErrorException the local repository mode has not been set.

    • setRepositoryProxyConnection

      @PostMapping(path="/local-repository/mode/repository-proxy/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRepositoryProxyConnection(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connection - connection to the OMRS repository connector.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or OMAGConfigurationErrorException the local repository mode has not been set

    • setRepositoryProxyConnection

      @PostMapping(path="/local-repository/mode/repository-proxy/details") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRepositoryProxyConnection(@PathVariable String userId, @PathVariable String serverName, @RequestParam String connectorProvider, @RequestBody(required=false) Map<String,Object> additionalProperties)
      Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectorProvider - connector provider class name to the OMRS repository connector.
      additionalProperties - additional parameters to pass to the repository connector
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or OMAGConfigurationErrorException the local repository mode has not been set.

    • setRepositoryProxyEventMapper

      @PostMapping(path="/local-repository/event-mapper-connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRepositoryProxyEventMapper(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Provide the connection to a repository proxy's event mapper. The default value is null which means no event mapper. An event mapper is needed if the local repository has additional APIs that can change the metadata in the repository without going through the open metadata and governance services.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connection - connection to the OMRS repository event mapper.
      Returns:
      void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryEventMapper parameter or OMAGConfigurationErrorException the local repository mode, or the event mapper has not been set

    • setRepositoryProxyEventMapper

      @PostMapping(path="/local-repository/event-mapper-details") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setRepositoryProxyEventMapper(@PathVariable String userId, @PathVariable String serverName, @RequestParam String connectorProvider, @RequestParam String eventSource, @RequestBody(required=false) Map<String,Object> additionalProperties)
      Provide the connection to a repository proxy's event mapper. The default value is null which means no event mapper. An event mapper is needed if the local repository has additional APIs that can change the metadata in the repository without going through the open metadata and governance services.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      connectorProvider - Java class name of the connector provider for the OMRS repository event mapper.
      eventSource - topic name or URL to the native event source.
      additionalProperties - additional properties for the event mapper connection
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryEventMapper parameter or OMAGConfigurationErrorException the local repository mode has not been set.

    • getLocalMetadataCollectionName

      @GetMapping(path="/local-repository/metadata-collection-name") public org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse getLocalMetadataCollectionName(@PathVariable String userId, @PathVariable String serverName)
      Return the local metadata collection name. If the local repository is not configured then the invalid parameter exception is returned.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      guid response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or name parameter or OMAGConfigurationErrorException the event bus is not set.

    • setLocalMetadataCollectionName

      @PostMapping(path="/local-repository/metadata-collection-name/{name}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setLocalMetadataCollectionName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String name)
      Set up the local metadata collection name. If this is not set then the default value is the local server name.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      name - metadata collection name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or name parameter or OMAGConfigurationErrorException the event bus is not set.

    • getLocalMetadataCollectionId

      @GetMapping(path="/local-repository/metadata-collection-id") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse getLocalMetadataCollectionId(@PathVariable String userId, @PathVariable String serverName)
      Return the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      guid response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or name parameter or OMAGConfigurationErrorException the event bus is not set.

    • setLocalMetadataCollectionId

      @PostMapping(path="/local-repository/metadata-collection-id") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setLocalMetadataCollectionId(@PathVariable String userId, @PathVariable String serverName, @RequestBody String metadataCollectionId)
      Set up the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      metadataCollectionId - new identifier for the local repository's metadata collection
      Returns:
      void or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or name parameter or OMAGConfigurationErrorException the event bus is not set.

    • addCohortRegistration

      @PostMapping(path="/cohorts/{cohortName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addCohortRegistration(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody(required=false) Map<String,Object> additionalProperties)
      Enable registration of server to an open metadata repository cohort using the default topic structure (DEDICATED_TOPICS). A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to the changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      additionalProperties - additional properties for the event bus connection
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter or OMAGConfigurationErrorException the event bus is not set.

    • addCohortRegistration

      @PostMapping(path="/cohorts/{cohortName}/topic-structure/{cohortTopicStructure}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addCohortRegistration(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @PathVariable org.odpi.openmetadata.adminservices.configuration.properties.CohortTopicStructure cohortTopicStructure, @RequestBody(required=false) Map<String,Object> additionalProperties)
      Enable registration of server to an open metadata repository cohort using the topic pattern specified by cohortTopicStructure. A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to the changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      cohortTopicStructure - the style of cohort topic set up to use
      additionalProperties - additional properties for the event bus connection
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter or OMAGConfigurationErrorException the event bus is not set.

    • getCohortConfig

      @GetMapping(path="/cohorts/{cohortName}") public org.odpi.openmetadata.adminservices.rest.CohortConfigResponse getCohortConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName)
      Retrieve the registration of server to an open metadata repository cohort. This is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to the changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      Returns:
      cohort config response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter or OMAGConfigurationErrorException the event bus is not set.

    • getCohortTopicName

      @GetMapping(path="/cohorts/{cohortName}/topic-name") public org.odpi.openmetadata.commonservices.ffdc.rest.StringResponse getCohortTopicName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName)
      Retrieve the current topic name for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      Returns:
      string name or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • getDedicatedCohortTopicNames

      @GetMapping(path="/cohorts/{cohortName}/dedicated-topic-names") public org.odpi.openmetadata.adminservices.rest.DedicatedTopicListResponse getDedicatedCohortTopicNames(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName)
      Retrieve the current topic name for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      Returns:
      List of topic names - registration first, then types and then instances or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • overrideCohortTopicName

      @PostMapping(path="/cohorts/{cohortName}/topic-name-override") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse overrideCohortTopicName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody String topicName)
      Override the current name for the single topic for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      topicName - new name for the topic.
      Returns:
      void or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • overrideRegistrationCohortTopicName

      @PostMapping(path="/cohorts/{cohortName}/topic-name-override/registration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse overrideRegistrationCohortTopicName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody String topicName)
      Override the current name for the registration topic for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      topicName - new name for the topic.
      Returns:
      void or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • overrideTypesCohortTopicName

      @PostMapping(path="/cohorts/{cohortName}/topic-name-override/types") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse overrideTypesCohortTopicName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody String topicName)
      Override the current name for the "types" topic for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      topicName - new name for the topic.
      Returns:
      void or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • overrideInstancesCohortTopicName

      @PostMapping(path="/cohorts/{cohortName}/topic-name-override/instances") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse overrideInstancesCohortTopicName(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody String topicName)
      Override the current name for the "instances" topic for the cohort. This call can only be made once the cohort is set up with enableCohortRegistration().
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      topicName - new name for the topic.
      Returns:
      void or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or cohortName parameter or OMAGConfigurationErrorException the cohort is not set up.

    • clearCohortConfig

      @DeleteMapping(path="/cohorts/{cohortName}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearCohortConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName)
      Unregister this server from an open metadata repository cohort.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      cohortName - name of the cohort.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter.

    • setAuditLogDestinations

      @PostMapping(path="/audit-log-destinations") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setAuditLogDestinations(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection> auditLogDestinations)
      Set up the list of audit log destinations. These destinations are expressed as Connection objects to the connectors that will handle the audit log records.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      auditLogDestinations - list of connection objects
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • getAuditLogDestinations

      @GetMapping(path="/audit-log-destinations") public org.odpi.openmetadata.adminservices.rest.ConnectionListResponse getAuditLogDestinations(@PathVariable String userId, @PathVariable String serverName)
      Set up the list of audit log destinations. These destinations are expressed as Connection objects to the connectors that will handle the audit log records.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      connection list response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • clearAuditLogDestinations

      @DeleteMapping(path="/audit-log-destinations") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAuditLogDestinations(@PathVariable String userId, @PathVariable String serverName)
      Clears all audit log destinations for this server.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • setOpenMetadataArchives

      @PostMapping(path="/open-metadata-archives") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setOpenMetadataArchives(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection> openMetadataArchives)
      Set up the list of open metadata archives. These are open metadata types and instances that are loaded at repository start up.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      openMetadataArchives - list of connection objects
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • getOpenMetadataArchives

      @GetMapping(path="/open-metadata-archives") public org.odpi.openmetadata.adminservices.rest.ConnectionListResponse getOpenMetadataArchives(@PathVariable String userId, @PathVariable String serverName)
      Return the list of open metadata archives. These are open metadata types and instances that are loaded at repository start up.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      connection list response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • clearOpenMetadataArchives

      @DeleteMapping(path="/open-metadata-archives") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearOpenMetadataArchives(@PathVariable String userId, @PathVariable String serverName)
      Clear the list of open metadata archives. These are the open metadata types and instances that are loaded at repository start up.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName.

    • setLocalRepositoryConfig

      @PostMapping(path="/local-repository/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setLocalRepositoryConfig(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig localRepositoryConfig)
      Set up the configuration for the local repository. This overrides the current values.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      localRepositoryConfig - configuration properties for the local repository.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryConfig parameter.

    • getLocalRepositoryConfig

      @GetMapping(path="/local-repository/configuration") public org.odpi.openmetadata.adminservices.rest.LocalRepositoryConfigResponse getLocalRepositoryConfig(@PathVariable String userId, @PathVariable String serverName)
      Return the configuration for the local repository.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      local repository response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryConfig parameter.

    • clearLocalRepositoryConfig

      @DeleteMapping(path="/local-repository/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearLocalRepositoryConfig(@PathVariable String userId, @PathVariable String serverName)
      Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

    • resetRemoteCohortURL

      @PostMapping(path="/local-repository/configuration/remote-repository-connector-url") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse resetRemoteCohortURL(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.rest.URLRequestBody requestBody)
      Update the URL broadcast across the cohort to allow other members to issue queries to this repository. This method is needed to reconfigure a server that has moved from one platform to another. Once the URL is updated, and the server restarted, it will broadcast its new URL to the rest of the cohort.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - String url.
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverURLRoot parameter.

    • setCohortConfig

      @PostMapping(path="/cohorts/{cohortName}/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setCohortConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String cohortName, @RequestBody org.odpi.openmetadata.adminservices.configuration.properties.CohortConfig cohortConfig)
      Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a cohort. Use setCohortMode to delete a cohort.
      Parameters:
      userId - user that is issuing the request
      serverName - local server name
      cohortName - name of the cohort
      cohortConfig - configuration for the cohort
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or cohortConfig parameter.