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 and/or integration groups.

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	clearAllIntegrationGroups()	Disable the integration groups.
void	clearIntegrationGroup(String groupQualifiedName)	Remove an integration group.
void	configureIntegrationGroup(IntegrationGroupConfig groupConfig)	Add configuration for a single integration group to the server's config document.
List<IntegrationGroupConfig>	getIntegrationGroupsConfiguration()	Return the configuration for the integration groups in this server.
void	setIntegrationGroupsConfig(List<IntegrationGroupConfig> integrationGroupConfigs)	Set up the configuration for all the open metadata integration groups.

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

addAuditLogDestination, addConsoleAuditLogDestination, addEventTopicAuditLogDestination, addEventTopicAuditLogDestination, addFileAuditLogDestination, addFileAuditLogDestination, addJDBCAuditLogDestination, addSLF4JAuditLogDestination, clearAuditLogDestination, clearAuditLogDestinations, clearOMAGServerConfig, clearServerSecurityConnection, deployOMAGServerConfig, getBasicServerProperties, getOMAGServerConfig, getOMAGServerInstanceConfig, getServerSecurityConnection, getServerTypeClassification, setAuditLogDestinations, setBasicServerProperties, 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 Details

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 Details

getIntegrationGroupsConfiguration

public List<IntegrationGroupConfig> getIntegrationGroupsConfiguration()
                                                               throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Return the configuration for the integration groups in this server.

Returns:

list of integration group configuration

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

configureIntegrationGroup

public void configureIntegrationGroup(IntegrationGroupConfig groupConfig)
                               throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

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

Parameters:

groupConfig - all values to configure an integration group

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

setIntegrationGroupsConfig

public void setIntegrationGroupsConfig(List<IntegrationGroupConfig> integrationGroupConfigs)
                                throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Set up the configuration for all the open metadata integration groups. This overrides the current values.

Parameters:

integrationGroupConfigs - list of configuration properties for each integration group.

Throws:

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

OMAGInvalidParameterException - invalid parameter.

OMAGConfigurationErrorException - unusual state in the admin server.

clearAllIntegrationGroups

public void clearAllIntegrationGroups()
                               throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

Disable the integration groups. This removes all configuration for the integration groups from 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.

clearIntegrationGroup

public void clearIntegrationGroup(String groupQualifiedName)
                           throws OMAGNotAuthorizedException,
OMAGInvalidParameterException,
OMAGConfigurationErrorException

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

Parameters:

groupQualifiedName - integration group 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.