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

Class EngineHostServicesResource

java.lang.Object

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

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/engine-host/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 Summary

Constructors

Constructor	Description
EngineHostServicesResource()

Method Summary

Modifier and Type	Method	Description
GovernanceEngineSummariesResponse	getGovernanceEngineSummaries(String serverName, String userId)	Return a summary of each of the governance engines running in the Engine Host.
GovernanceEngineSummaryResponse	getGovernanceEngineSummary(String serverName, String userId, String governanceEngineName)	Retrieve the description and status of the requested governance engine.
GovernanceEngineSummariesResponse	getGovernanceServiceSummary(String serverName, String userId, String serviceURLMarker)	Retrieve the description and status of each governance engine assigned to a specific Open Metadata Engine Service (OMES).
VoidResponse	refreshConfig(String serverName, String userId)	Request that all governance engines refresh their configuration by calling the metadata server.
VoidResponse	refreshConfig(String serverName, String userId, String governanceEngineName)	Request that the governance engine refresh its configuration by calling the metadata server.

Methods inherited from class java.lang.Object

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

Constructor Details

EngineHostServicesResource

public EngineHostServicesResource()

Method Details

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.

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

getGovernanceServiceSummary

@GetMapping(path="/engine-service/{serviceURLMarker}/governance-engines/summary")
public GovernanceEngineSummariesResponse getGovernanceServiceSummary(@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.

refreshConfig

@GetMapping(path="/governance-engines/refresh-config")
public VoidResponse refreshConfig(@PathVariable
 String serverName,
 @PathVariable
 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.