Class EngineHostServicesViewResource
java.lang.Object
org.odpi.openmetadata.viewservices.serverauthor.server.spring.EngineHostServicesViewResource
@RestController
@RequestMapping("/servers/{serverName}/open-metadata/view-services/server-author/users/{userId}/servers/{serverToBeConfiguredName}")
public class EngineHostServicesViewResource
extends Object
EngineHostServicesViewResource provides the configuration for setting up an Engine Host.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconfigureEngineService
(String userId, String serverName, String serverToBeConfiguredName, String serviceURLMarker, EngineServiceRequestBody requestBody) Enable a single engine service.disableEngineService
(String userId, String serverName, String serverToBeConfiguredName, String serviceURLMarker) Disable a single engine service.
-
Constructor Details
-
EngineHostServicesViewResource
public EngineHostServicesViewResource()
-
-
Method Details
-
configureEngineService
@PostMapping(path="/engine-services/{serviceURLMarker}") public ServerAuthorConfigurationResponse configureEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverToBeConfiguredName, @PathVariable String serviceURLMarker, @RequestBody EngineServiceRequestBody requestBody) Enable a single engine service.- Parameters:
userId
- user that is issuing the request.serverName
- local server name.serverToBeConfiguredName
- name of the server to be configured.requestBody
- Engine host service request bodyserviceURLMarker
- string indicating which engine 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.
-
disableEngineService
@DeleteMapping(path="/engine-services/{serviceURLMarker}") public ServerAuthorConfigurationResponse disableEngineService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serverToBeConfiguredName, @PathVariable String serviceURLMarker) Disable a single engine service.- Parameters:
userId
- user that is issuing the request.serverName
- local server name.serverToBeConfiguredName
- name of the server to be configured.serviceURLMarker
- string indicating which engine 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.
-