Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForEngineHostServices

java.lang.Object

org.odpi.openmetadata.tokencontroller.TokenController

org.odpi.openmetadata.adminservices.server.OMAGServerAdminForEngineHostServices

public class OMAGServerAdminForEngineHostServices
extends TokenController

OMAGServerAdminForEngineServices provides the server-side support for the services that add engine services configuration to an OMAG Server.

Constructor Summary

Constructors

Constructor	Description
OMAGServerAdminForEngineHostServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	addEngine(String serverName, String delegatingUserId, EngineConfig engine)	Set up the list of governance engines that will use the metadata from the same metadata access server as the engine host uses for retrieving the engine configuration.
VoidResponse	clearEngineHostServicesConfig(String serverName, String delegatingUserId)	Remove the configuration for an Engine Host OMAG Server in a single call.
EngineHostServicesResponse	getEngineHostServicesConfiguration(String serverName, String delegatingUserId)	Return the engine host services configuration including the list of engine services that are configured for this server.
VoidResponse	setEngineHostServicesConfig(String serverName, String delegatingUserId, List<EngineConfig> governanceEngines)	Set up the configuration for an Engine Host OMAG Server in a single call.

Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController

getUser

Methods inherited from class java.lang.Object

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

Constructor Details

OMAGServerAdminForEngineHostServices

public OMAGServerAdminForEngineHostServices()

Default constructor

Method Details

addEngine

public VoidResponse addEngine(String serverName,
 String delegatingUserId,
 EngineConfig engine)

Set up the list of governance engines that will use the metadata from the same metadata access server as the engine host uses for retrieving the engine configuration.

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

engine - new engine

Returns:

void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.

getEngineHostServicesConfiguration

public EngineHostServicesResponse getEngineHostServicesConfiguration(String serverName,
 String delegatingUserId)

Return the engine host services configuration including the list of engine services that are configured for this server.

Parameters:

serverName - name of server

delegatingUserId - external userId making request

Returns:

engine host services configuration

setEngineHostServicesConfig

public VoidResponse setEngineHostServicesConfig(String serverName,
 String delegatingUserId,
 List<EngineConfig> governanceEngines)

Set up the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

governanceEngines - full configuration for the engine host server.

Returns:

void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.

clearEngineHostServicesConfig

public VoidResponse clearEngineHostServicesConfig(String serverName,
 String delegatingUserId)

Remove the configuration for an Engine Host OMAG Server in a single call. This overrides the current values.

Parameters:

serverName - local server name.

delegatingUserId - external userId making request

Returns:

void response UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or InvalidParameterException invalid serverName parameter.