Package org.odpi.openmetadata.frameworkservices.gaf.handlers

Class IntegrationGroupConfigurationHandler

java.lang.Object

org.odpi.openmetadata.frameworkservices.gaf.handlers.IntegrationGroupConfigurationHandler

public class IntegrationGroupConfigurationHandler
extends Object

GovernanceConfigurationHandler provides the open metadata server side implementation of GovernanceConfigurationServer which is part of the Open Governance Framework (ODF).

Constructor Summary

Constructors

Constructor	Description
IntegrationGroupConfigurationHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)	Construct the governance engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method	Description
IntegrationConnectorElement	getIntegrationConnectorByGUID(String userId, String guid, List<String> serviceSupportedZones)	Return the properties from an integration connector definition.
List<String>	getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID, List<String> serviceSupportedZones)	Return the list of integration groups that a specific integration connector is registered with.
IntegrationGroupElement	getIntegrationGroupByName(String userId, String name, List<String> serviceSupportedZones)	Return the properties from an integration group definition.
RegisteredIntegrationConnectorElement	getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID, List<String> serviceSupportedZones)	Retrieve a specific integration connector registrations with a particular integration group.
List<RegisteredIntegrationConnectorElement>	getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults, List<String> serviceSupportedZones)	Retrieve the identifiers of the registered integration connectors with an integration group.

Methods inherited from class java.lang.Object

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

Constructor Details

IntegrationGroupConfigurationHandler

public IntegrationGroupConfigurationHandler(String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 RepositoryHandler repositoryHandler,
 OMRSRepositoryHelper repositoryHelper,
 String localServerUserId,
 OpenMetadataServerSecurityVerifier securityVerifier,
 List<String> supportedZones,
 List<String> defaultZones,
 List<String> publishZones,
 AuditLog auditLog)

Construct the governance engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve B instances from.

defaultZones - list of zones that the access service should set in all new B instances.

publishZones - list of zones that the access service sets up in published B instances.

auditLog - logging destination

Method Details

getIntegrationGroupByName

public IntegrationGroupElement getIntegrationGroupByName(String userId,
 String name,
 List<String> serviceSupportedZones)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration group definition. The integration group definition is completely contained in a single entity that can be retrieved from the repository services and converted to a bean.

Parameters:

userId - identifier of calling user

name - qualified name or display name (if unique).

serviceSupportedZones - supported zones for calling service

Returns:

properties from the integration group definition.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration group definition.

getIntegrationConnectorByGUID

public IntegrationConnectorElement getIntegrationConnectorByGUID(String userId,
 String guid,
 List<String> serviceSupportedZones)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the properties from an integration connector definition.

Parameters:

userId - identifier of calling user

guid - unique identifier (guid) of the integration connector definition.

serviceSupportedZones - supported zones for calling service

Returns:

properties of the integration connector.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector definition.

getIntegrationConnectorRegistrations

public List<String> getIntegrationConnectorRegistrations(String userId,
 String integrationConnectorGUID,
 List<String> serviceSupportedZones)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of integration groups that a specific integration connector is registered with.

Parameters:

userId - identifier of calling user

integrationConnectorGUID - integration connector to search for.

serviceSupportedZones - supported zones for calling service

Returns:

list of integration group unique identifiers (guids)

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

getRegisteredIntegrationConnector

public RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String userId,
 String integrationGroupGUID,
 String integrationConnectorGUID,
 List<String> serviceSupportedZones)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a specific integration connector registrations with a particular integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

integrationConnectorGUID - unique identifier of the registered integration connector.

serviceSupportedZones - supported zones for calling service

Returns:

details of the integration connector and the asset types it is registered for.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

getRegisteredIntegrationConnectors

public List<RegisteredIntegrationConnectorElement> getRegisteredIntegrationConnectors(String userId,
 String integrationGroupGUID,
 int startingFrom,
 int maximumResults,
 List<String> serviceSupportedZones)
                                                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the identifiers of the registered integration connectors with an integration group.

Parameters:

userId - identifier of calling user

integrationGroupGUID - unique identifier of the integration group.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

serviceSupportedZones - supported zones for calling service

Returns:

list of unique identifiers

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - problem retrieving the integration connector and/or integration group definitions.