Package org.odpi.openmetadata.engineservices.assetanalysis.server.spring

Class EngineHostServicesResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/engine-host-services/users/{userId}")
public class EngineHostServicesResource
extends Object
    EngineHostServicesResource provides the server-side catcher for REST calls using Spring. The OMAG ServerPlatform routes these requests to the engine host services active in the server.

    • Constructor Detail

      • EngineHostServicesResource

        public EngineHostServicesResource()

    • Method Detail

      • getGovernanceEngineSummary

        @GetMapping(path="/governance-engines/{governanceEngineName}/summary")
public GovernanceEngineSummaryResponse getGovernanceEngineSummary​(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String governanceEngineName)
        Retrieve the description and status of the requested governance engine.
        Parameters:
        serverName - engine host server name
        userId - calling user
        governanceEngineName - name of governance engine of interest
        Returns:
        list of statuses - on for each assigned governance engines or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

      • getGovernanceEngineSummaries

        @GetMapping(path="/governance-engines/summary")
public GovernanceEngineSummariesResponse getGovernanceEngineSummaries​(@PathVariable
                                                                      String serverName,
                                                                      @PathVariable
                                                                      String userId)
        Return a summary of each of the governance engines running in the Engine Host Server.
        Parameters:
        serverName - engine host server name
        userId - calling user
        Returns:
        list of statuses - on for each assigned governance engines or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

      • getGovernanceEngineSummaries

        @GetMapping(path="/engine-service/{serviceURLMarker}/governance-engines/summary")
public GovernanceEngineSummariesResponse getGovernanceEngineSummaries​(@PathVariable
                                                                      String serverName,
                                                                      @PathVariable
                                                                      String userId,
                                                                      @PathVariable
                                                                      String serviceURLMarker)
        Retrieve the description and status of each governance engine assigned to a specific Open Metadata Engine Service (OMES).
        Parameters:
        serverName - engine host server name
        userId - calling user
        serviceURLMarker - url name for the engine service
        Returns:
        list of statuses - on for each assigned governance engines or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or

      • refreshConfig

        @GetMapping(path="/governance-engines/{governanceEngineName}/refresh-config")
public VoidResponse refreshConfig​(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String governanceEngineName)
        Request that the governance engine refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.
        Parameters:
        serverName - name of the governance server
        userId - identifier of calling user
        governanceEngineName - unique name of the governance engine
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or GovernanceEngineException there was a problem detected by the governance engine.