Package org.odpi.openmetadata.adminservices.spring

Class ConfigAccessServicesResource

  • @RestController
@RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}")
public class ConfigAccessServicesResource
extends Object
    ConfigAccessServicesResource provides the configuration for setting up the Open Metadata Access Services (OMASs).

    • Constructor Detail

      • ConfigAccessServicesResource

        public ConfigAccessServicesResource()

    • Method Detail

      • getConfiguredAccessServices

        @GetMapping(path="/access-services")
public RegisteredOMAGServicesResponse getConfiguredAccessServices​(@PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String serverName)
        Return the list of access services that are configured for this server.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of access service descriptions

      • getAccessServicesConfiguration

        @GetMapping(path="/access-services/configuration")
public AccessServicesResponse getAccessServicesConfiguration​(@PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String serverName)
        Return the configuration for the access services in this server.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of access service configurations

      • configureAccessService

        @PostMapping(path="/access-services/{serviceURLMarker}")
public VoidResponse configureAccessService​(@PathVariable
                                           String userId,
                                           @PathVariable
                                           String serverName,
                                           @PathVariable
                                           String serviceURLMarker,
                                           @RequestBody(required=false)
                                           Map<String,​Object> accessServiceOptions)
        Enable a single access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        serviceURLMarker - string indicating which access service it is configuring
        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 parameter.

      • configureAllAccessServices

        @PostMapping(path="/access-services")
public VoidResponse configureAllAccessServices​(@PathVariable
                                               String userId,
                                               @PathVariable
                                               String serverName,
                                               @RequestBody(required=false)
                                               Map<String,​Object> accessServiceOptions)
        Enable all access services that are registered with this server platform. The access services are set up to use the default event bus.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        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 parameter.

      • configureAccessServiceNoTopics

        @PostMapping(path="/access-services/{serviceURLMarker}/no-topics")
public VoidResponse configureAccessServiceNoTopics​(@PathVariable
                                                   String userId,
                                                   @PathVariable
                                                   String serverName,
                                                   @PathVariable
                                                   String serviceURLMarker,
                                                   @RequestBody(required=false)
                                                   Map<String,​Object> accessServiceOptions)
        Enable a single access service. This version of the call does not set up the InTopic nor the OutTopic.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        serviceURLMarker - string indicating which access service it is configuring
        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 parameter.

      • configureAllAccessServicesNoTopics

        @PostMapping(path="/access-services/no-topics")
public VoidResponse configureAllAccessServicesNoTopics​(@PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String serverName,
                                                       @RequestBody(required=false)
                                                       Map<String,​Object> accessServiceOptions)
        Enable all access services that are registered with this server platform. This version of the call does not set up the InTopic nor the OutTopic.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        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 parameter.

      • clearAllAccessServices

        @DeleteMapping(path="/access-services")
public VoidResponse clearAllAccessServices​(@PathVariable
                                           String userId,
                                           @PathVariable
                                           String serverName)
        Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.
        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 parameter or OMAGConfigurationErrorException unusual state in the admin server.

      • getAccessServiceConfig

        @GetMapping(path="/access-services/{serviceURLMarker}")
public AccessServiceConfigResponse getAccessServiceConfig​(@PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String serviceURLMarker)
        Retrieve the config for an access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it is configuring
        Returns:
        AccessServiceConfig response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or OMAGConfigurationErrorException unusual state in the admin server.

      • getAccessServiceTopicNames

        @GetMapping(path="/access-services/{serviceURLMarker}/topic-names")
public StringMapResponse getAccessServiceTopicNames​(@PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String serviceURLMarker)
        Retrieve the topic names for this access service
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

      • getAllAccessServiceTopicNames

        @GetMapping(path="/access-services/topic-names")
public StringMapResponse getAllAccessServiceTopicNames​(@PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String serverName)
        Retrieve the topic names for all access services
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

      • overrideAccessServiceInTopicName

        @PostMapping(path="/access-services/{serviceURLMarker}/topic-names/in-topic")
public VoidResponse overrideAccessServiceInTopicName​(@PathVariable
                                                     String userId,
                                                     @PathVariable
                                                     String serverName,
                                                     @PathVariable
                                                     String serviceURLMarker,
                                                     @RequestBody
                                                     String topicName)
        Update the in topic name for a specific access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        topicName - string for new topic name
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

      • overrideAccessServiceOutTopicName

        @PostMapping(path="/access-services/{serviceURLMarker}/topic-names/out-topic")
public VoidResponse overrideAccessServiceOutTopicName​(@PathVariable
                                                      String userId,
                                                      @PathVariable
                                                      String serverName,
                                                      @PathVariable
                                                      String serviceURLMarker,
                                                      @RequestBody
                                                      String topicName)
        Update the out topic name for a specific access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        topicName - string for new topic name
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

      • clearAccessService

        @DeleteMapping(path="/access-services/{serviceURLMarker}")
public VoidResponse clearAccessService​(@PathVariable
                                       String userId,
                                       @PathVariable
                                       String serverName,
                                       @PathVariable
                                       String serviceURLMarker)
        Remove the config for an access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service to clear
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or OMAGConfigurationErrorException unusual state in the admin server.

      • setAccessServicesConfig

        @PostMapping(path="/access-services/configuration")
public VoidResponse setAccessServicesConfig​(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @RequestBody
                                            List<AccessServiceConfig> accessServicesConfig)
        Set up the configuration for selected open metadata access services (OMASs). This overrides the current default values.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServicesConfig - list of configuration properties for each access service.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter or OMAGConfigurationErrorException unusual state in the admin server.

      • setEnterpriseAccessConfig

        @PostMapping(path="/enterprise-access/configuration")
public VoidResponse setEnterpriseAccessConfig​(@PathVariable
                                              String userId,
                                              @PathVariable
                                              String serverName,
                                              @RequestBody
                                              EnterpriseAccessConfig enterpriseAccessConfig)
        Set up the configuration that controls the enterprise repository services. These services are part of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event notifications that cover metadata from the local repository plus any repositories connected via open metadata repository cohorts.
        Parameters:
        userId - user that is issuing the request
        serverName - local server name
        enterpriseAccessConfig - enterprise repository services configuration properties.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or enterpriseAccessConfig parameter or OMAGConfigurationErrorException unusual state in the admin server.