org.odpi.openmetadata.adminservices.spring

Class ConfigAccessServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigAccessServicesResource

@RestController
 @RequestMapping(value="/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 Summary

Constructors

Constructor and Description
ConfigAccessServicesResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearAccessService(String userId, String serverName, String serviceURLMarker) Remove the config for an access service.
VoidResponse	clearAllAccessServices(String userId, String serverName) Disable the access services.
VoidResponse	configureAccessService(String userId, String serverName, String serviceURLMarker, Map<String,Object> accessServiceOptions) Enable a single access service.
VoidResponse	configureAllAccessServices(String userId, String serverName, Map<String,Object> accessServiceOptions) Enable all access services that are registered with this server platform.
AccessServiceConfigResponse	getAccessServiceConfig(String userId, String serverName, String serviceURLMarker) Retrieve the config for an access service.
AccessServicesResponse	getAccessServicesConfiguration(String userId, String serverName) Return the configuration for the access services in this server.
StringMapResponse	getAccessServiceTopicNames(String userId, String serverName, String serviceURLMarker) Retrieve the topic names for this access service
StringMapResponse	getAllAccessServiceTopicNames(String userId, String serverName) Retrieve the topic names for all access services
RegisteredOMAGServicesResponse	getConfiguredAccessServices(String userId, String serverName) Return the list of access services that are configured for this server.
VoidResponse	overrideAccessServiceInTopicName(String userId, String serverName, String serviceURLMarker, String topicName) Update the in topic name for a specific access service.
VoidResponse	overrideAccessServiceOutTopicName(String userId, String serverName, String serviceURLMarker, String topicName) Update the out topic name for a specific access service.
VoidResponse	setAccessServicesConfig(String userId, String serverName, List<AccessServiceConfig> accessServicesConfig) Set up the configuration for selected open metadata access services (OMASs).
VoidResponse	setEnterpriseAccessConfig(String userId, String serverName, EnterpriseAccessConfig enterpriseAccessConfig) Set up the configuration that controls the enterprise repository services.

Methods inherited from class java.lang.Object

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

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.

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.