org.odpi.openmetadata.viewservices.serverauthor.server.spring

Class ConfigAccessServicesViewResource

java.lang.Object

org.odpi.openmetadata.viewservices.serverauthor.server.spring.ConfigAccessServicesViewResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/view-services/server-author/users/{userId}/servers/{serverToBeConfiguredName}")
public class ConfigAccessServicesViewResource
extends Object

ConfigAccessServicesResource provides the configuration for setting up the Open Metadata Access Services (OMASs).

Constructor Summary

Constructors

Constructor and Description
ConfigAccessServicesViewResource()

Method Summary

Modifier and Type	Method and Description
ServerAuthorConfigurationResponse	configureAccessService(String userId, String serverName, String serverToBeConfiguredName, String serviceURLMarker, Map<String,Object> accessServiceOptions) Enable a single access service.
ServerAuthorConfigurationResponse	configureAllAccessServices(String userId, String serverName, String serverToBeConfiguredName, Map<String,Object> accessServiceOptions) Enable all access services that are registered with this server platform.
ServerAuthorConfigurationResponse	setEnterpriseAccessConfig(String userId, String serverName, String serverToBeConfiguredName, 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

ConfigAccessServicesViewResource

public ConfigAccessServicesViewResource()

Method Detail

configureAccessService

@PostMapping(path="/access-services/{serviceURLMarker}")
public ServerAuthorConfigurationResponse configureAccessService(@PathVariable
                                                                                                                         String userId,
                                                                                                                         @PathVariable
                                                                                                                         String serverName,
                                                                                                                         @PathVariable
                                                                                                                         String serverToBeConfiguredName,
                                                                                                                         @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.

serverToBeConfiguredName - name of the server to be configured.

accessServiceOptions - property name/value pairs used to configure the access services

serviceURLMarker - string indicating which access service it is configuring

Returns:

the current stored configuration 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 ServerAuthorConfigurationResponse configureAllAccessServices(@PathVariable
                                                                                                          String userId,
                                                                                                          @PathVariable
                                                                                                          String serverName,
                                                                                                          @PathVariable
                                                                                                          String serverToBeConfiguredName,
                                                                                                          @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.

serverToBeConfiguredName - name of the server to be configured.

accessServiceOptions - property name/value pairs used to configure the access services

Returns:

the current stored configuration 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.

setEnterpriseAccessConfig

@PostMapping(path="/enterprise-access/configuration")
public ServerAuthorConfigurationResponse setEnterpriseAccessConfig(@PathVariable
                                                                                                                         String userId,
                                                                                                                         @PathVariable
                                                                                                                         String serverName,
                                                                                                                         @PathVariable
                                                                                                                         String serverToBeConfiguredName,
                                                                                                                         @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

serverToBeConfiguredName - name of the server to be configured.

enterpriseAccessConfig - enterprise repository services configuration properties.

Returns:

the current stored configuration 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.