Package org.odpi.openmetadata.adminservices.spring

Class 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 Detail

      • ConfigRepositoryServicesResource

        public ConfigRepositoryServicesResource()

    • Method Detail

      • setDefaultAuditLog

        @PostMapping(path="/audit-log-destinations/default")
public VoidResponse setDefaultAuditLog​(@PathVariable
                                       String userId,
                                       @PathVariable
                                       String serverName,
                                       @RequestBody(required=false)
                                       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 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 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 VoidResponse addFileAuditLogDestination​(@PathVariable
                                               String userId,
                                               @PathVariable
                                               String serverName,
                                               @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.
        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 VoidResponse addEventTopicAuditLogDestination​(@PathVariable
                                                     String userId,
                                                     @PathVariable
                                                     String serverName,
                                                     @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.
        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 VoidResponse addAuditLogDestination​(@PathVariable
                                           String userId,
                                           @PathVariable
                                           String serverName,
                                           @RequestBody
                                           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 VoidResponse updateAuditLogDestination​(@PathVariable
                                              String userId,
                                              @PathVariable
                                              String serverName,
                                              @PathVariable
                                              String connectionName,
                                              @RequestBody
                                              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 VoidResponse clearAuditLogDestination​(@PathVariable
                                             String userId,
                                             @PathVariable
                                             String serverName,
                                             @PathVariable
                                             String connectionName)
        Delete an audit log destination that is identified with the supplied destination name
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        connectionName - 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 VoidResponse addStartUpOpenMetadataArchiveFile​(@PathVariable
                                                      String userId,
                                                      @PathVariable
                                                      String serverName,
                                                      @RequestBody
                                                      String fileName)
        Add a new open metadata archive to load at startup.
        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 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 VoidResponse setInMemLocalRepository​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @RequestBody(required=false)
                                            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 VoidResponse setGraphLocalRepository​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @RequestBody @Nullable
                                            Map<String,​Object> storageProperties)
        Set up a graph store as the local 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 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 VoidResponse setPluginRepositoryConnection​(@PathVariable
                                                  String userId,
                                                  @PathVariable
                                                  String serverName,
                                                  @RequestBody
                                                  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 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 VoidResponse setRepositoryProxyConnection​(@PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String serverName,
                                                 @RequestBody
                                                 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 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 VoidResponse setRepositoryProxyEventMapper​(@PathVariable
                                                  String userId,
                                                  @PathVariable
                                                  String serverName,
                                                  @RequestBody
                                                  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 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.

      • setLocalMetadataCollectionName

        @PostMapping(path="/local-repository/metadata-collection-name/{name}")
public 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 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 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 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 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 VoidResponse addCohortRegistration​(@PathVariable
                                          String userId,
                                          @PathVariable
                                          String serverName,
                                          @PathVariable
                                          String cohortName,
                                          @PathVariable
                                          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 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 CohortConfigResponse getCohortConfig​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @PathVariable
                                            String cohortName)
        Enable 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 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 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 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 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 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 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 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 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 VoidResponse setAuditLogDestinations​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @RequestBody
                                            List<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 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 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 VoidResponse setOpenMetadataArchives​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @RequestBody
                                            List<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 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 VoidResponse clearOpenMetadataArchives​(@PathVariable
                                              String userId,
                                              @PathVariable
                                              String serverName)
        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.
        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 VoidResponse setLocalRepositoryConfig​(@PathVariable
                                             String userId,
                                             @PathVariable
                                             String serverName,
                                             @RequestBody
                                             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 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 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.

      • setCohortConfig

        @PostMapping(path="/cohorts/{cohortName}/configuration")
public VoidResponse setCohortConfig​(@PathVariable
                                    String userId,
                                    @PathVariable
                                    String serverName,
                                    @PathVariable
                                    String cohortName,
                                    @RequestBody
                                    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.