Package org.odpi.openmetadata.adminservices.spring

Class ConfigIntegrationServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigIntegrationServicesResource

@RestController
@RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}")
public class ConfigIntegrationServicesResource
extends Object

ConfigIntegrationServicesResource provides the configuration for setting up the Open Metadata Integration Services (OMISs).

Constructor Summary

Constructors

Constructor	Description
ConfigIntegrationServicesResource()

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearAllIntegrationServices(String userId, String serverName)	Disable the integration services.
VoidResponse	clearIntegrationService(String userId, String serverName, String serviceURLMarker)	Remove an integration service.
VoidResponse	configureIntegrationService(String userId, String serverName, String serviceURLMarker, IntegrationServiceRequestBody requestBody)	Enable a single registered integration service.
VoidResponse	configureIntegrationService(String userId, String serverName, IntegrationServiceConfig serviceConfig)	Add configuration for a single integration service to the server's config document.
IntegrationServiceConfigResponse	getIntegrationServiceConfiguration(String userId, String serverName, String serviceURLMarker)	Return the configuration for the named integration service for this server.
IntegrationServicesResponse	getIntegrationServicesConfiguration(String userId, String serverName)	Return the integration services configuration for this server.
RegisteredOMAGServicesResponse	getRegisteredIntegrationServices(String userId, String serverName)	Return the list of registered integration services for this server.
VoidResponse	setIntegrationServicesConfig(String userId, String serverName, List<IntegrationServiceConfig> integrationServicesConfig)	Set up the configuration for all the open metadata integration services (OMISs).

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigIntegrationServicesResource

public ConfigIntegrationServicesResource()

Method Detail

getRegisteredIntegrationServices

@GetMapping("/integration-services")
public RegisteredOMAGServicesResponse getRegisteredIntegrationServices(@PathVariable
                                                                       String userId,
                                                                       @PathVariable
                                                                       String serverName)

Return the list of registered integration services for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of integration service descriptions

getIntegrationServicesConfiguration

@GetMapping("/integration-services/configuration")
public IntegrationServicesResponse getIntegrationServicesConfiguration(@PathVariable
                                                                       String userId,
                                                                       @PathVariable
                                                                       String serverName)

Return the integration services configuration for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

response containing the integration services configuration

getIntegrationServiceConfiguration

@GetMapping("/integration-services/{serviceURLMarker}/configuration")
public IntegrationServiceConfigResponse getIntegrationServiceConfiguration(@PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String serviceURLMarker)

Return the configuration for the named integration service for this server.

Parameters:

userId - calling user

serverName - name of server

serviceURLMarker - integration service name used in URL

Returns:

response containing the integration services configuration

configureIntegrationService

@PostMapping(path="/integration-services/{serviceURLMarker}")
public VoidResponse configureIntegrationService(@PathVariable
                                                String userId,
                                                @PathVariable
                                                String serverName,
                                                @PathVariable
                                                String serviceURLMarker,
                                                @RequestBody
                                                IntegrationServiceRequestBody requestBody)

Enable a single registered integration service. This builds the integration service configuration for the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - string indicating which integration service it is configuring

requestBody - minimum values to configure an integration service

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.

configureIntegrationService

@PostMapping(path="/integration-services/configuration")
public VoidResponse configureIntegrationService(@PathVariable
                                                String userId,
                                                @PathVariable
                                                String serverName,
                                                @RequestBody
                                                IntegrationServiceConfig serviceConfig)

Add configuration for a single integration service to the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceConfig - all values to configure an integration service

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.

setIntegrationServicesConfig

@PostMapping(path="/integration-services/configuration/all")
public VoidResponse setIntegrationServicesConfig(@PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String serverName,
                                                 @RequestBody
                                                 List<IntegrationServiceConfig> integrationServicesConfig)

Set up the configuration for all the open metadata integration services (OMISs). This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

integrationServicesConfig - list of configuration properties for each integration service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or integrationServicesConfig parameter.

clearAllIntegrationServices

@DeleteMapping(path="/integration-services")
public VoidResponse clearAllIntegrationServices(@PathVariable
                                                String userId,
                                                @PathVariable
                                                String serverName)

Disable the integration services. This removes all configuration for the integration services nad hence the integration daemon.

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.

clearIntegrationService

@DeleteMapping(path="/integration-services/{serviceURLMarker}")
public VoidResponse clearIntegrationService(@PathVariable
                                            String userId,
                                            @PathVariable
                                            String serverName,
                                            @PathVariable
                                            String serviceURLMarker)

Remove an integration service. This removes all configuration for the integration service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - integration service name used in URL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.