Package org.odpi.openmetadata.frameworkservices.gaf.client

Class GovernanceConfigurationClientBase

java.lang.Object
org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
org.odpi.openmetadata.frameworkservices.gaf.client.GovernanceConfigurationClientBase
public class GovernanceConfigurationClientBase extends org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
GovernanceEngineConfigurationClient supports the configuration of governance engine and governance services.

  • Constructor Details

    • GovernanceConfigurationClientBase

      public GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, int maxPageSize) 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
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • GovernanceConfigurationClientBase

      public GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, String userId, String password, int maxPageSize) 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
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      maxPageSize - pre-initialized parameter limit
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • GovernanceConfigurationClientBase

      public GovernanceConfigurationClientBase(String serverName, String serverPlatformURLRoot, String serviceURLMarker, GAFRESTClient 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
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      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

    • createGovernanceEngine

      public String createGovernanceEngine(String userId, String governanceEngineType, 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.
      Specified by:
      createGovernanceEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceEngineType - 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.frameworks.governanceaction.properties.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.
      Specified by:
      getGovernanceEngineByGUID in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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.
      Specified by:
      getGovernanceEngineByName in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.GovernanceEngineElement> getAllGovernanceEngines(String userId, String governanceEngineType, 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.
      Specified by:
      getAllGovernanceEngines in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceEngineType - type of governance engine to create
      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.
      Specified by:
      updateGovernanceEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.
      Specified by:
      deleteGovernanceEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 governanceServiceType, 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.
      Specified by:
      createGovernanceService in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceServiceType - type of the governance service to create
      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.frameworks.governanceaction.properties.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.
      Specified by:
      getGovernanceServiceByGUID in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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.
      Specified by:
      getGovernanceServiceByName in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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.
      Specified by:
      getAllGovernanceServices in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.
      Specified by:
      getGovernanceServiceRegistrations in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.
      Specified by:
      updateGovernanceService in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.
      Specified by:
      deleteGovernanceService in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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

      @Deprecated public void registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, Map<String,String> requestParameters) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Register a governance service with a specific governance engine.
      Specified by:
      registerGovernanceServiceWithEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      governanceRequestType - governance request type used by caller and supported by the governance server.
      requestParameters - list of 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.

    • registerGovernanceServiceWithEngine

      public void registerGovernanceServiceWithEngine(String userId, String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> requestParameters) 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.
      Specified by:
      registerGovernanceServiceWithEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      governanceRequestType - governance request type used by caller.
      serviceRequestType - mapped governance request type that this governance service is able to process.
      requestParameters - list of 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.frameworks.governanceaction.properties.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 registered with a governance engine.
      Specified by:
      getRegisteredGovernanceService in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the 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.frameworks.governanceaction.properties.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 governance services registered with a governance engine.
      Specified by:
      getRegisteredGovernanceServices in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 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 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 a governance service from the governance engine.
      Specified by:
      unregisterGovernanceServiceFromEngine in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.properties.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.frameworks.governanceaction.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 relationship for an integration connector.
      Specified by:
      updateCatalogTarget in class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      Parameters:
      userId - identifier of calling user.
      relationshipGUID - unique identifier of the relationship.
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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 named elements
      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 class org.odpi.openmetadata.frameworks.governanceaction.client.GovernanceConfiguration
      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.