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	configureAccessService(String userId, String serverName, String serviceURLMarker, Map<String,Object> accessServiceOptions) Enable a single access service.
VoidResponse	disableAccessServices(String userId, String serverName) Disable the access services.
VoidResponse	enableAccessServices(String userId, String serverName, Map<String,Object> accessServiceOptions) Enable all access services that are registered with this server platform.
RegisteredOMAGServicesResponse	getConfiguredAccessServices(String userId, String serverName) Return the list of access services that are configured for this server.
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

@RequestMapping(method=GET,
                path="/access-services/configuration")
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

configureAccessService

@RequestMapping(method=POST,
                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 calling

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.

enableAccessServices

@RequestMapping(method=POST,
                path="/access-services")
public VoidResponse enableAccessServices(@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.

disableAccessServices

@RequestMapping(method=DELETE,
                path="/access-services")
public VoidResponse disableAccessServices(@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.

setAccessServicesConfig

@RequestMapping(method=POST,
                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.

setEnterpriseAccessConfig

@RequestMapping(method=POST,
                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.