Package org.odpi.openmetadata.accessservices.governanceengine.handlers

Class GovernanceConfigurationHandler

java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.handlers.GovernanceConfigurationHandler
public class GovernanceConfigurationHandler 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
    GovernanceConfigurationHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String localServerUserId, org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, org.odpi.openmetadata.frameworks.auditlog.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
    void
    addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, org.odpi.openmetadata.accessservices.governanceengine.properties.CatalogTargetProperties properties)
    Add a catalog target to an integration connector.
    String
    createGovernanceEngine(String userId, String typeName, String qualifiedName, String displayName, String description)
    Create a new governance engine definition.
    String
    createGovernanceService(String userId, String typeName, String qualifiedName, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Create a governance service definition.
    String
    createIntegrationConnector(String userId, String qualifiedName, String versionIdentifier, String displayName, String description, boolean usesBlockingCalls, Map<String,String> additionalProperties, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Create an integration connector definition.
    String
    createIntegrationGroup(String userId, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationGroupProperties properties)
    Create a new integration group definition.
    void
    deleteGovernanceEngine(String userId, String guid, String qualifiedName)
    Remove the properties of the governance engine.
    void
    deleteGovernanceService(String userId, String guid, String qualifiedName)
    Remove the properties of the governance service.
    void
    deleteIntegrationConnector(String userId, String guid, String qualifiedName)
    Remove the properties of the integration connector.
    void
    deleteIntegrationGroup(String userId, String guid, String qualifiedName)
    Remove the properties of the integration group.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement>
    getAllGovernanceEngines(String userId, int startingFrom, int maximumResults)
    Return the list of governance engine definitions that are stored.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement>
    getAllGovernanceServices(String userId, int startingFrom, int maximumResults)
    Return the list of governance services definitions that are stored.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement>
    getAllIntegrationConnectors(String userId, int startingFrom, int maximumResults)
    Return the list of integration connectors definitions that are stored.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement>
    getAllIntegrationGroups(String userId, int startingFrom, int maximumResults)
    Return the list of integration group definitions that are stored.
    org.odpi.openmetadata.frameworks.integration.properties.CatalogTarget
    getCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)
    Retrieve a specific catalog target associated with an integration connector.
    List<org.odpi.openmetadata.frameworks.integration.properties.CatalogTarget>
    getCatalogTargets(String userId, String integrationConnectorGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement
    getGovernanceEngineByGUID(String userId, String guid)
    Return the properties from a governance engine definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement
    getGovernanceEngineByName(String userId, String name)
    Return the properties from a governance engine definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement
    getGovernanceServiceByGUID(String userId, String guid)
    Return the properties from a governance service definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement
    getGovernanceServiceByName(String userId, String name)
    Return the properties from a governance service definition.
    List<String>
    getGovernanceServiceRegistrations(String userId, String governanceServiceGUID)
    Return the list of governance engines that a specific governance service is registered with.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement
    getIntegrationConnectorByGUID(String userId, String guid)
    Return the properties from an integration connector definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement
    getIntegrationConnectorByName(String userId, String name)
    Return the properties from an integration connector definition.
    List<String>
    getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID)
    Return the list of integration groups that a specific integration connector is registered with.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement
    getIntegrationGroupByGUID(String userId, String guid)
    Return the properties from an integration group definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement
    getIntegrationGroupByName(String userId, String name)
    Return the properties from an integration group definition.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredGovernanceServiceElement
    getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID)
    Retrieve a specific governance service registrations with a particular governance engine.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredGovernanceServiceElement>
    getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the registered governance services with a governance engine.
    org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredIntegrationConnectorElement
    getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID)
    Retrieve a specific integration connector registrations with a particular integration group.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredIntegrationConnectorElement>
    getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the registered integration connectors with an integration group.
    void
    registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> defaultAnalysisParameters)
    Register a governance service with a specific governance engine.
    void
    registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, String connectorName, String connectorUserId, String metadataSourceQualifiedName, Date startDate, long refreshTimeInterval, Date stopDate, org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization permittedSynchronization)
    Register an integration connector with a specific integration group.
    void
    removeCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID)
    Unregister a catalog target from the integration connector.
    void
    unregisterGovernanceServiceFromEngine(String userId, String governanceEngineGUID, String governanceServiceGUID)
    Unregister all request types for a governance service from the governance engine.
    void
    unregisterGovernanceServiceRequestFromEngine(String userId, String requestType, String governanceEngineGUID, String governanceServiceGUID)
    Remove a request type for a governance service from the governance engine.
    void
    unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)
    Unregister all request types for an integration connector from the integration group.
    void
    updateGovernanceEngine(String userId, String guid, String qualifiedName, String displayName, String description, String typeDescription, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)
    Update the properties of an existing governance engine definition.
    void
    updateGovernanceService(String userId, String guid, String qualifiedName, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)
    Update the properties of an existing governance service definition.
    void
    updateIntegrationConnector(String userId, String guid, boolean isMergeUpdate, String qualifiedName, String versionIdentifier, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)
    Update the properties of an existing integration connector definition.
    void
    updateIntegrationGroup(String userId, String guid, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationGroupProperties properties)
    Update the properties of an existing integration group definition.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GovernanceConfigurationHandler

      public GovernanceConfigurationHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler repositoryHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String localServerUserId, org.odpi.openmetadata.metadatasecurity.server.OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, org.odpi.openmetadata.frameworks.auditlog.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

    • createGovernanceEngine

      public String createGovernanceEngine(String userId, String typeName, String qualifiedName, String displayName, String description) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new governance engine definition.
      Parameters:
      userId - identifier of calling user
      typeName - type of governance engine to create
      qualifiedName - unique name for the governance engine.
      displayName - display name for messages and user interfaces.
      description - description of the types of governance services that will be associated with this governance engine.
      Returns:
      unique identifier (guid) of the governance engine definition. This is for use on other requests.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the governance engine definition.

    • getGovernanceEngineByGUID

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement getGovernanceEngineByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from a governance engine definition. The governance engine 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
      guid - unique identifier (guid) of the governance engine definition.
      Returns:
      properties from the governance engine definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • getGovernanceEngineByName

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement getGovernanceEngineByName(String userId, String name) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from a governance engine definition. The governance engine 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).
      Returns:
      properties from the governance engine definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • getAllGovernanceEngines

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceEngineElement> getAllGovernanceEngines(String userId, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of governance engine definitions that are stored.
      Parameters:
      userId - identifier of calling user
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance engine definitions.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance engine definitions.

    • updateGovernanceEngine

      public void updateGovernanceEngine(String userId, String guid, String qualifiedName, String displayName, String description, String typeDescription, String version, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of an existing governance engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the governance engine - used to locate the definition.
      qualifiedName - new value for unique name of governance engine.
      displayName - new value for the display name.
      description - new description for the governance engine.
      typeDescription - new description of the type ofg governance engine.
      version - new version number for the governance engine implementation.
      patchLevel - new patch level for the governance engine implementation.
      source - new source description for the implementation of the governance engine.
      additionalProperties - additional properties for the governance engine.
      extendedProperties - properties to populate the subtype of the governance engine.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the governance engine definition.

    • deleteGovernanceEngine

      public void deleteGovernanceEngine(String userId, String guid, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the properties of the governance engine. Both the guid and the qualified name is supplied to validate that the correct governance engine is being deleted.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the governance engine - used to locate the definition.
      qualifiedName - unique name for the governance engine.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • createGovernanceService

      public String createGovernanceService(String userId, String typeName, String qualifiedName, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a governance service definition. The same governance service can be associated with multiple governance engines.
      Parameters:
      userId - identifier of calling user
      typeName - type of governance service
      qualifiedName - unique name for the governance service.
      displayName - display name for the governance service.
      description - description of the analysis provided by the governance service.
      connection - connection to instantiate the governance service implementation.
      Returns:
      unique identifier of the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the governance service definition.

    • getGovernanceServiceByGUID

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement getGovernanceServiceByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from a governance service definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier (guid) of the governance service definition.
      Returns:
      properties of the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service definition.

    • getGovernanceServiceByName

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement getGovernanceServiceByName(String userId, String name) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from a governance service definition.
      Parameters:
      userId - identifier of calling user
      name - qualified name or display name (if unique).
      Returns:
      properties from the governance engine definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • getAllGovernanceServices

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceServiceElement> getAllGovernanceServices(String userId, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of governance services definitions that are stored.
      Parameters:
      userId - identifier of calling user
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of governance service definitions.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service definitions.

    • getGovernanceServiceRegistrations

      public List<String> getGovernanceServiceRegistrations(String userId, String governanceServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of governance engines that a specific governance service is registered with.
      Parameters:
      userId - identifier of calling user
      governanceServiceGUID - governance service to search for.
      Returns:
      list of governance engine unique identifiers (guids)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • updateGovernanceService

      public void updateGovernanceService(String userId, String guid, String qualifiedName, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of an existing governance service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the governance service - used to locate the definition.
      qualifiedName - new value for unique name of governance service.
      displayName - new value for the display name.
      description - new value for the description.
      connection - connection used to create an instance of this governance service.
      additionalProperties - additional properties for the governance engine.
      extendedProperties - properties to populate the subtype of the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the governance service definition.

    • deleteGovernanceService

      public void deleteGovernanceService(String userId, String guid, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the properties of the governance service. Both the guid and the qualified name is supplied to validate that the correct governance service is being deleted. The governance service is also unregistered from its governance engines.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the governance service - used to locate the definition.
      qualifiedName - unique name for the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service definition.

    • registerGovernanceServiceWithEngine

      public void registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> defaultAnalysisParameters) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Register a governance service with a specific governance engine. Both the governance service and the governance engine already exist, so it is just a question of creating a relationship between them.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      governanceRequestType - list of governance request types that this governance service is able to process.
      serviceRequestType - request type supported by the service
      defaultAnalysisParameters - list of analysis parameters that are passed to the governance service (via the governance context). These values can be overridden on the actual governance request.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceService

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredGovernanceServiceElement getRegisteredGovernanceService(String userId, String governanceEngineGUID, String governanceServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a specific governance service registrations with a particular governance engine.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the registered governance service.
      Returns:
      details of the governance service and the asset types it is registered for.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceServices

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredGovernanceServiceElement> getRegisteredGovernanceServices(String userId, String governanceEngineGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the identifiers of the registered governance services with a governance engine.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • unregisterGovernanceServiceRequestFromEngine

      public void unregisterGovernanceServiceRequestFromEngine(String userId, String requestType, String governanceEngineGUID, String governanceServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a request type for a governance service from the governance engine.
      Parameters:
      userId - identifier of calling user
      requestType - calling request
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • unregisterGovernanceServiceFromEngine

      public void unregisterGovernanceServiceFromEngine(String userId, String governanceEngineGUID, String governanceServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unregister all request types for a governance service from the governance engine.
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • createIntegrationGroup

      public String createIntegrationGroup(String userId, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationGroupProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new integration group definition.
      Parameters:
      userId - identifier of calling user
      properties - properties for the integration group.
      Returns:
      unique identifier (guid) of the integration group definition. This is for use on other requests.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the integration group definition.

    • getIntegrationGroupByGUID

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement getIntegrationGroupByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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
      guid - unique identifier (guid) of the integration group definition.
      Returns:
      properties from the integration group definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • getIntegrationGroupByName

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement getIntegrationGroupByName(String userId, String name) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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).
      Returns:
      properties from the integration group definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • getAllIntegrationGroups

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationGroupElement> getAllIntegrationGroups(String userId, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of integration group definitions that are stored.
      Parameters:
      userId - identifier of calling user
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration group definitions.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration group definitions.

    • updateIntegrationGroup

      public void updateIntegrationGroup(String userId, String guid, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationGroupProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of an existing integration group definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the integration group - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      properties - properties for the integration group.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the integration group definition.

    • deleteIntegrationGroup

      public void deleteIntegrationGroup(String userId, String guid, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the properties of the integration group. Both the guid and the qualified name is supplied to validate that the correct integration group is being deleted.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the integration group - used to locate the definition.
      qualifiedName - unique name for the integration group.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • createIntegrationConnector

      public String createIntegrationConnector(String userId, String qualifiedName, String versionIdentifier, String displayName, String description, boolean usesBlockingCalls, Map<String,String> additionalProperties, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create an integration connector definition. The same integration connector can be associated with multiple integration groups.
      Parameters:
      userId - identifier of calling user
      qualifiedName - unique name for the integration connector.
      displayName - display name for the integration connector.
      versionIdentifier - identifier if the version
      description - description of the analysis provided by the integration connector.
      usesBlockingCalls - the connector issues blocking calls and needs a dedicated thread.
      additionalProperties - additional properties
      connection - connection to instantiate the integration connector implementation.
      Returns:
      unique identifier of the integration connector.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the integration connector definition.

    • getIntegrationConnectorByGUID

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement getIntegrationConnectorByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from an integration connector definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier (guid) of the integration connector definition.
      Returns:
      properties of the integration connector.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • getIntegrationConnectorByName

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement getIntegrationConnectorByName(String userId, String name) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the properties from an integration connector definition.
      Parameters:
      userId - identifier of calling user
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration connector definition.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • getAllIntegrationConnectors

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.IntegrationConnectorElement> getAllIntegrationConnectors(String userId, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of integration connectors definitions that are stored.
      Parameters:
      userId - identifier of calling user
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of integration connector definitions.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definitions.

    • getIntegrationConnectorRegistrations

      public List<String> getIntegrationConnectorRegistrations(String userId, String integrationConnectorGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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.
      Returns:
      list of integration group unique identifiers (guids)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • updateIntegrationConnector

      public void updateIntegrationConnector(String userId, String guid, boolean isMergeUpdate, String qualifiedName, String versionIdentifier, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of an existing integration connector definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the integration connector - used to locate the definition.
      isMergeUpdate - should the supplied properties be merged with existing properties (true) only replacing the properties with matching names, or should the entire properties of the instance be replaced?
      qualifiedName - new value for unique name of integration connector.
      versionIdentifier - version identifier of the connector.
      displayName - new value for the display name.
      description - new value for the description.
      connection - connection used to create an instance of this integration connector.
      additionalProperties - additional properties for the integration group.
      extendedProperties - properties to populate the subtype of the integration connector.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the integration connector definition.

    • deleteIntegrationConnector

      public void deleteIntegrationConnector(String userId, String guid, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the properties of the integration connector. Both the guid and the qualified name is supplied to validate that the correct integration connector is being deleted. The integration connector is also unregistered from its integration groups.
      Parameters:
      userId - identifier of calling user
      guid - unique identifier of the integration connector - used to locate the definition.
      qualifiedName - unique name for the integration connector.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • registerIntegrationConnectorWithGroup

      public void registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, String connectorName, String connectorUserId, String metadataSourceQualifiedName, Date startDate, long refreshTimeInterval, Date stopDate, org.odpi.openmetadata.frameworks.integration.contextmanager.PermittedSynchronization permittedSynchronization) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Register an integration connector with a specific integration group. Both the integration connector and the integration group already exist, so it is just a question of creating a relationship between them.
      Parameters:
      userId - identifier of calling user
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      connectorName - list of governance request types that this integration connector is able to process.
      connectorUserId - request type supported by the service
      metadataSourceQualifiedName - list of analysis parameters that are passed to the integration connector (via the governance context). These values can be overridden on the actual governance request.
      startDate - earliest date to start the connector
      refreshTimeInterval - how often to run the connector
      stopDate - latest time the connector should run
      permittedSynchronization - which direction should synchronization flow?
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • getRegisteredIntegrationConnector

      public org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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.
      Returns:
      details of the integration connector and the asset types it is registered for.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • getRegisteredIntegrationConnectors

      public List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredIntegrationConnectorElement> getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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.
      Returns:
      list of unique identifiers
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • unregisterIntegrationConnectorFromGroup

      public void unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unregister all request types for an integration connector from the integration group.
      Parameters:
      userId - identifier of calling user
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • addCatalogTarget

      public void addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, org.odpi.openmetadata.accessservices.governanceengine.properties.CatalogTargetProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a catalog target to an integration connector.
      Parameters:
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      properties - properties for the relationship.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem storing the catalog target definition.

    • getCatalogTarget

      public org.odpi.openmetadata.frameworks.integration.properties.CatalogTarget getCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      Returns:
      details of the integration connector and the elements it is to catalog
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • getCatalogTargets

      public List<org.odpi.openmetadata.frameworks.integration.properties.CatalogTarget> getCatalogTargets(String userId, String integrationConnectorGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid,
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • removeCatalogTarget

      public void removeCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unregister a catalog target from the integration connector.
      Parameters:
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      metadataElementGUID - unique identifier of the metadata element.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing/updating the integration connector definition.