Package org.odpi.openmetadata.governanceservers.enginehostservices.server

Class EngineHostRESTServices

java.lang.Object
org.odpi.openmetadata.governanceservers.enginehostservices.server.EngineHostRESTServices
public class EngineHostRESTServices extends Object
AssetAnalysisRESTServices provides the external service implementation for a governance engine. Each method contains the governance server name and the governance engine identifier (guid). The AssetAnalysisRESTServices locates the correct governance engine instance within the correct governance server instance and delegates the request.

  • Constructor Details

    • EngineHostRESTServices

      public EngineHostRESTServices()

  • Method Details

    • refreshConfig

      public VoidResponse refreshConfig(String serverName, String userId, 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.
      governanceEngineName - unique name of the governance engine.
      userId - identifier of calling user
      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.

    • refreshConfig

      public VoidResponse refreshConfig(String serverName, String userId)
      Request that all governance engines refresh their 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
      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.

    • getGovernanceEngineSummary

      public GovernanceEngineSummaryResponse getGovernanceEngineSummary(String serverName, String userId, String governanceEngineName)
      Return a summary of the requested engine's status.
      Parameters:
      userId - calling user
      serverName - name of the server tied to the request
      governanceEngineName - qualifiedName of the requested governance engine
      Returns:
      list of governance engine summaries or InvalidParameterException no available instance for the requested server UserNotAuthorizedException user does not have access to the requested server PropertyServerException the service name is not known - indicating a logic error

    • getGovernanceEngineSummaries

      public GovernanceEngineSummariesResponse getGovernanceEngineSummaries(String serverName, String userId, String serviceURLMarker)
      Retrieve the description and status of each governance engine assigned to a specific Open Metadata Engine Service (OMES).
      Parameters:
      serverName - governance server name
      userId - calling user
      serviceURLMarker - URL marker of 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

    • getGovernanceEngineSummaries

      public GovernanceEngineSummariesResponse getGovernanceEngineSummaries(String serverName, String userId)
      Return a summary of each of the governance engines' status for all running engine services.
      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