Package org.odpi.openmetadata.adminservices.client

Class IntegrationDaemonConfigurationClient

java.lang.Object

org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

org.odpi.openmetadata.adminservices.client.GovernanceServerConfigurationClient

org.odpi.openmetadata.adminservices.client.IntegrationDaemonConfigurationClient

public class IntegrationDaemonConfigurationClient
extends GovernanceServerConfigurationClient

IntegrationDaemonConfigurationClient provides the configuration services for integration daemons. This involves creating a list of integration services.

Field Summary

Fields inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

adminUserId, invalidParameterHandler, nullRequestBody, restClient, serverName, serverPlatformRootURL

Constructor Summary

Constructors

Constructor	Description
IntegrationDaemonConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
IntegrationDaemonConfigurationClient(String adminUserId, String serverName, String serverPlatformRootURL, String connectionUserId, String connectionPassword)	Create a new client that passes a connection userId and password in each HTTP request.

Method Summary

Modifier and Type	Method	Description
void	clearAllIntegrationServices()	Disable the integration services.
void	clearIntegrationService(String serviceURLMarker)	Disable the integration services.
void	configureIntegrationService(String partnerOMASServerURLRoot, String partnerOMASServerName, String serviceURLMarker, Map<String,Object> integrationServiceOptions, List<IntegrationConnectorConfig> integrationConnectorConfigs)	Enable a single integration service.
void	configureIntegrationService(IntegrationServiceConfig serviceConfig)	Add configuration for a single integration service to the server's config document.
void	disableIntegrationService(String serviceURLMarker)	Disable a single integration service.
List<RegisteredOMAGService>	getConfiguredIntegrationServices()	Return the list of integration services for this server.
IntegrationServiceConfig	getIntegrationServiceConfiguration(String serviceURLMarker)	Return the configuration for the named integration service for this server.
List<IntegrationServiceConfig>	getIntegrationServicesConfiguration()	Return the configuration for the integration services in this server.
List<RegisteredOMAGService>	getRegisteredIntegrationServices()	Return the list of integration services for this server.
void	setIntegrationServicesConfig(List<IntegrationServiceConfig> integrationServicesConfig)	Set up the configuration for all of the open metadata integration services (OMISs).

Methods inherited from class org.odpi.openmetadata.adminservices.client.OMAGServerConfigurationClient

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerClassification, getServerSecurityConnection, setAuditLogDestinations, setDefaultAuditLog, setEventBus, setMaxPageSize, setOMAGServerConfig, setOrganizationName, setServerDescription, setServerPassword, setServerSecurityConnection, setServerType, setServerURLRoot, setServerUserId, updateAuditLogDestination

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrationDaemonConfigurationClient

public IntegrationDaemonConfigurationClient(String adminUserId,
                                            String serverName,
                                            String serverPlatformRootURL)
                                     throws OMAGInvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

IntegrationDaemonConfigurationClient

public IntegrationDaemonConfigurationClient(String adminUserId,
                                            String serverName,
                                            String serverPlatformRootURL,
                                            String connectionUserId,
                                            String connectionPassword)
                                     throws OMAGInvalidParameterException

Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.

Parameters:

adminUserId - administrator's (end user's) userId to associate with calls.

serverName - name of the server to connect to

serverPlatformRootURL - the network address of the server running the admin services

connectionUserId - caller's system userId embedded in all HTTP requests

connectionPassword - caller's system password embedded in all HTTP requests

Throws:

OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

getRegisteredIntegrationServices

public List<RegisteredOMAGService> getRegisteredIntegrationServices()
                                                             throws OMAGNotAuthorizedException,
                                                                    OMAGInvalidParameterException,
                                                                    OMAGConfigurationErrorException

Return the list of integration services for this server.

Returns:

list of integration service descriptions

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getConfiguredIntegrationServices

public List<RegisteredOMAGService> getConfiguredIntegrationServices()
                                                             throws OMAGNotAuthorizedException,
                                                                    OMAGInvalidParameterException,
                                                                    OMAGConfigurationErrorException

Return the list of integration services for this server.

Returns:

list of integration service descriptions

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getIntegrationServicesConfiguration

public List<IntegrationServiceConfig> getIntegrationServicesConfiguration()
                                                                   throws OMAGNotAuthorizedException,
                                                                          OMAGInvalidParameterException,
                                                                          OMAGConfigurationErrorException

Return the configuration for the integration services in this server.

Returns:

list of integration service configuration

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

getIntegrationServiceConfiguration

public IntegrationServiceConfig getIntegrationServiceConfiguration(String serviceURLMarker)
                                                            throws OMAGNotAuthorizedException,
                                                                   OMAGInvalidParameterException,
                                                                   OMAGConfigurationErrorException

Return the configuration for the named integration service for this server.

Parameters:

serviceURLMarker - integration service name used in URL

Returns:

response containing the integration services configuration

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureIntegrationService

public void configureIntegrationService(String partnerOMASServerURLRoot,
                                        String partnerOMASServerName,
                                        String serviceURLMarker,
                                        Map<String,Object> integrationServiceOptions,
                                        List<IntegrationConnectorConfig> integrationConnectorConfigs)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Enable a single integration service.

Parameters:

partnerOMASServerURLRoot - URL root of the OMAG Server Platform where the access service used by this integration service is running

partnerOMASServerName - name of server where the access service used by this integration service is running

serviceURLMarker - string indicating which integration service it is configuring

integrationServiceOptions - property name/value pairs used to configure the integration service

integrationConnectorConfigs - Connection properties

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

disableIntegrationService

public void disableIntegrationService(String serviceURLMarker)
                               throws OMAGNotAuthorizedException,
                                      OMAGInvalidParameterException,
                                      OMAGConfigurationErrorException

Disable a single integration service.

Parameters:

serviceURLMarker - string indicating which integration service it is configuring

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureIntegrationService

public void configureIntegrationService(IntegrationServiceConfig serviceConfig)
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

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

Parameters:

serviceConfig - all values to configure an integration service

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setIntegrationServicesConfig

public void setIntegrationServicesConfig(List<IntegrationServiceConfig> integrationServicesConfig)
                                  throws OMAGNotAuthorizedException,
                                         OMAGInvalidParameterException,
                                         OMAGConfigurationErrorException

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

Parameters:

integrationServicesConfig - list of configuration properties for each integration service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllIntegrationServices

public void clearAllIntegrationServices()
                                 throws OMAGNotAuthorizedException,
                                        OMAGInvalidParameterException,
                                        OMAGConfigurationErrorException

Disable the integration services. This removes all configuration for the integration daemon.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearIntegrationService

public void clearIntegrationService(String serviceURLMarker)
                             throws OMAGNotAuthorizedException,
                                    OMAGInvalidParameterException,
                                    OMAGConfigurationErrorException

Disable the integration services. This removes all configuration for the integration daemon.

Parameters:

serviceURLMarker - integration service name used in URL

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.