Package org.odpi.openmetadata.accessservices.governanceengine.client

Class IntegrationGroupConfigurationClient

java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.client.IntegrationGroupConfigurationClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
public class IntegrationGroupConfigurationClient extends Object implements org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
IntegrationGroupConfigurationClient supports the configuration of integration group and integration connectors.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    addCatalogTarget(String userId, String integrationConnectorGUID, String metadataElementGUID, org.odpi.openmetadata.accessservices.governanceengine.properties.CatalogTargetProperties properties)
    Add a catalog target to an integration connector.
    String
    createIntegrationConnector(String userId, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationConnectorProperties properties)
    Create an integration connector definition.
    String
    createIntegrationGroup(String userId, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationGroupProperties properties)
    Create a new integration group definition.
    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.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.governanceaction.properties.CatalogTarget
    getCatalogTarget(String userId, String relationshipGUID)
    Retrieve a specific catalog target associated with an integration connector.
    List<org.odpi.openmetadata.frameworks.governanceaction.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.
    String
    getConfigurationServerName()
    Return the name of the server where configuration is supposed to be stored.
    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.RegisteredIntegrationConnectorElement
    getRegisteredIntegrationConnector(String userId, String integrationGroupGUID, String integrationConnectorGUID)
    Retrieve a specific integration connector registered with an integration group.
    List<org.odpi.openmetadata.accessservices.governanceengine.metadataelements.RegisteredIntegrationConnectorElement>
    getRegisteredIntegrationConnectors(String userId, String integrationGroupGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the integration connectors registered with an integration group.
    void
    registerIntegrationConnectorWithGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID, org.odpi.openmetadata.accessservices.governanceengine.properties.RegisteredIntegrationConnectorProperties properties)
    Register an integration connector with a specific integration group.
    void
    removeCatalogTarget(String userId, String relationshipGUID)
    Unregister a catalog target from the integration connector.
    void
    unregisterIntegrationConnectorFromGroup(String userId, String integrationGroupGUID, String integrationConnectorGUID)
    Unregister an integration connector from the integration group.
    void
    updateCatalogTarget(String userId, String relationshipGUID, org.odpi.openmetadata.accessservices.governanceengine.properties.CatalogTargetProperties properties)
    Update a catalog target for an integration connector.
    void
    updateIntegrationConnector(String userId, String guid, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationConnectorProperties properties)
    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

    • IntegrationGroupConfigurationClient

      public IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • IntegrationGroupConfigurationClient

      public IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • IntegrationGroupConfigurationClient

      public IntegrationGroupConfigurationClient(String serverName, String serverPlatformURLRoot, GovernanceEngineRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      restClient - pre-initialized REST client
      maxPageSize - pre-initialized parameter limit
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the information about the remote OMAS

  • Method Details

    • getConfigurationServerName

      public String getConfigurationServerName()
      Return the name of the server where configuration is supposed to be stored.
      Returns:
      server name

    • 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.
      Specified by:
      createIntegrationGroup in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user
      properties - values that will be associated with this 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.
      Specified by:
      getIntegrationGroupByGUID in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Specified by:
      getIntegrationGroupByName in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Specified by:
      getAllIntegrationGroups in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Specified by:
      updateIntegrationGroup in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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 - new values for 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.
      Specified by:
      deleteIntegrationGroup in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationConnectorProperties properties) 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.
      Specified by:
      createIntegrationConnector in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user
      properties - values that will be associated with this integration connector - including the connection.
      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.
      Specified by:
      getIntegrationConnectorByGUID in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Specified by:
      getIntegrationConnectorByName in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.

    • 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.
      Specified by:
      getAllIntegrationConnectors in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Specified by:
      getIntegrationConnectorRegistrations in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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, org.odpi.openmetadata.accessservices.governanceengine.properties.IntegrationConnectorProperties 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 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.
      Specified by:
      updateIntegrationConnector in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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?
      properties - values that will be associated with this integration connector - including the connection.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • 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.
      Specified by:
      deleteIntegrationConnector in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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, org.odpi.openmetadata.accessservices.governanceengine.properties.RegisteredIntegrationConnectorProperties properties) 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.
      Specified by:
      registerIntegrationConnectorWithGroup in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the integration connector.
      properties - list of parameters that are used to control to 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.

    • 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 registered with an integration group.
      Specified by:
      getRegisteredIntegrationConnector in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user
      integrationGroupGUID - unique identifier of the integration group.
      integrationConnectorGUID - unique identifier of the 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 integration connectors registered with an integration group.
      Specified by:
      getRegisteredIntegrationConnectors in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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 registered services
      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 an integration connector from the integration group.
      Specified by:
      unregisterIntegrationConnectorFromGroup in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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 String 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.
      Specified by:
      addCatalogTarget in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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.
      Returns:
      catalog target GUID
      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.

    • updateCatalogTarget

      public void updateCatalogTarget(String userId, String relationshipGUID, 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
      Update a catalog target for an integration connector.
      Specified by:
      updateCatalogTarget in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship.
      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.governanceaction.properties.CatalogTarget getCatalogTarget(String userId, String relationshipGUID) 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.
      Specified by:
      getCatalogTarget in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the integration service.
      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.governanceaction.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.
      Specified by:
      getCatalogTargets in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      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 relationshipGUID) 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.
      Specified by:
      removeCatalogTarget in interface org.odpi.openmetadata.accessservices.governanceengine.api.IntegrationGroupConfiguration
      Parameters:
      userId - identifier of calling user.
      relationshipGUID - 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 accessing/updating the integration connector definition.