Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForIntegrationServices

java.lang.Object

org.odpi.openmetadata.adminservices.server.OMAGServerAdminForIntegrationServices

public class OMAGServerAdminForIntegrationServices
extends Object

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

Constructor Summary

Constructors

Constructor	Description
OMAGServerAdminForIntegrationServices()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearAllIntegrationServices(String userId, String serverName)	Disable the integration services.
VoidResponse	clearIntegrationService(String userId, String serverName, String serviceURLMarker)	Remove an integration service.
VoidResponse	configureIntegrationService(String userId, String serverName, String serviceURLMarker, IntegrationServiceRequestBody requestBody)	Enable a single registered integration service.
VoidResponse	configureIntegrationService(String userId, String serverName, IntegrationServiceConfig serviceConfig)	Add configuration for a single integration service to the server's config document.
IntegrationServiceConfigResponse	getIntegrationServiceConfiguration(String userId, String serverName, String serviceURLMarker)	Return the configuration for the requested integration service that is configured for this server.
IntegrationServicesResponse	getIntegrationServicesConfiguration(String userId, String serverName)	Return the list of integration services that are configured for this server.
RegisteredOMAGServicesResponse	getRegisteredIntegrationServices(String userId, String serverName)	Return the list of integration services that are configured for this server.
VoidResponse	setIntegrationServicesConfig(String userId, String serverName, List<IntegrationServiceConfig> integrationServicesConfig)	Set up the configuration for all the open metadata integration services (OMISs).

Methods inherited from class java.lang.Object

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

Constructor Detail

OMAGServerAdminForIntegrationServices

public OMAGServerAdminForIntegrationServices()

Default constructor

Method Detail

getRegisteredIntegrationServices

public RegisteredOMAGServicesResponse getRegisteredIntegrationServices(String userId,
                                                                       String serverName)

Return the list of integration services that are configured for this server. If you want to see the configuration for these services, use the getIntegrationServicesConfiguration.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of integration service descriptions

getIntegrationServicesConfiguration

public IntegrationServicesResponse getIntegrationServicesConfiguration(String userId,
                                                                       String serverName)

Return the list of integration services that are configured for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of access service configurations

getIntegrationServiceConfiguration

public IntegrationServiceConfigResponse getIntegrationServiceConfiguration(String userId,
                                                                           String serverName,
                                                                           String serviceURLMarker)

Return the configuration for the requested integration service that is configured for this server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - integration service name used in URL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serviceURLMarker parameter.

configureIntegrationService

public VoidResponse configureIntegrationService(String userId,
                                                String serverName,
                                                String serviceURLMarker,
                                                IntegrationServiceRequestBody requestBody)

Enable a single registered integration service. This builds the integration service configuration for the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - integration service name used in URL

requestBody - minimum values to configure an integration service

Returns:

void response 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.

configureIntegrationService

public VoidResponse configureIntegrationService(String userId,
                                                String serverName,
                                                IntegrationServiceConfig serviceConfig)

Add configuration for a single integration service to the server's config document.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceConfig - all values to configure an integration service

Returns:

void response 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.

setIntegrationServicesConfig

public VoidResponse setIntegrationServicesConfig(String userId,
                                                 String serverName,
                                                 List<IntegrationServiceConfig> integrationServicesConfig)

Set up the configuration for all the open metadata integration services (OMISs). This overrides the current values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

integrationServicesConfig - list of configuration properties for each integration service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or integrationServicesConfig parameter.

clearAllIntegrationServices

public VoidResponse clearAllIntegrationServices(String userId,
                                                String serverName)

Disable the integration services. This removes all configuration for the integration services and disables the enterprise repository services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

clearIntegrationService

public VoidResponse clearIntegrationService(String userId,
                                            String serverName,
                                            String serviceURLMarker)

Remove an integration service. This removes all configuration for the integration service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serviceURLMarker - integration service name used in URL

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.