Package org.odpi.openmetadata.frameworks.governanceaction

Interface GovernanceContext

All Known Subinterfaces:
ProvisioningGovernanceContext, RemediationGovernanceContext, TriageGovernanceContext, VerificationGovernanceContext, WatchdogGovernanceContext
All Known Implementing Classes:
GovernanceActionContext
public interface GovernanceContext
GovernanceContext provides the governance action service with access to information about the governance request along with the open metadata repository interfaces. The abstract methods are implemented by the technology that supports the real metadata store.

  • Method Details

    • getEngineActionGUID

      String getEngineActionGUID()
      Return the unique identifier of the engine action that this service request is associated with.
      Returns:
      string guid

    • getRequestType

      String getRequestType()
      Return the unique identifier of the asset being discovered.
      Returns:
      string guid

    • getRequestParameters

      Map<String,String> getRequestParameters()
      Return the properties that hold the parameters used to drive the governance action service's processing.
      Returns:
      property map

    • getRequesterUserId

      String getRequesterUserId()
      Return the userId of the original person, process, service that requested this action.
      Returns:
      string userId

    • getRequestSourceElements

      List<RequestSourceElement> getRequestSourceElements()
      Return the list of metadata elements associated with the request to the governance action service. This list will not change during the lifetime of the service.
      Returns:
      list of request source elements

    • getActionTargetElements

      List<ActionTargetElement> getActionTargetElements()
      Return the list of elements that this governance action service should work on.
      Returns:
      cached list of action target metadata elements

    • getOpenMetadataStore

      OpenMetadataStore getOpenMetadataStore()
      Return the client to access metadata from the open metadata repositories. This enables the governance action service to retrieve more information about the metadata elements linked to the request source and action target elements.
      Returns:
      metadata store client

    • getMaxPageSize

      int getMaxPageSize()
      Return the maximum number of elements that can be returned on a request.
      Returns:
      int

    • createIncidentReport

      String createIncidentReport(String qualifiedName, int domainIdentifier, String background, List<org.odpi.openmetadata.frameworks.openmetadata.properties.IncidentImpactedElement> impactedResources, List<org.odpi.openmetadata.frameworks.openmetadata.properties.IncidentDependency> previousIncidents, Map<String,Integer> incidentClassifiers, Map<String,String> additionalProperties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.
      Parameters:
      qualifiedName - unique identifier to give this new incident report
      domainIdentifier - governance domain associated with this action (0=ALL)
      background - description of the situation
      impactedResources - details of the resources impacted by this situation
      previousIncidents - links to previous incident reports covering this situation
      incidentClassifiers - initial classifiers for the incident report
      additionalProperties - additional arbitrary properties for the incident reports
      Returns:
      unique identifier of the resulting incident report
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - null or non-unique qualified name for the incident report
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - this governance action service is not authorized to create an incident report
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem with the metadata store

    • updateActionTargetStatus

      void updateActionTargetStatus(String actionTargetGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus status, Date startDate, Date completionDate, String completionMessage) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
      Parameters:
      actionTargetGUID - unique identifier of the governance action service.
      status - status enum to show its progress
      startDate - date/time that the governance action service started processing the target
      completionDate - date/time that the governance process completed processing this target.
      completionMessage - message to describe completion results or reasons for failure
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the action target GUID is not recognized
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the action target properties
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(CompletionStatus status, List<String> outputGuards) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service completion status
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(CompletionStatus status, List<String> outputGuards, List<org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget> newActionTargets) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      newActionTargets - list of action target names to GUIDs for the resulting governance action service
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service completion status
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(CompletionStatus status, List<String> outputGuards, Map<String,String> newRequestParameters, List<org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget> newActionTargets) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      newRequestParameters - additional request parameters. These override/augment any request parameters defined for the next invoked service
      newActionTargets - list of action target names to GUIDs for the resulting governance action service
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service completion status
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(CompletionStatus status, List<String> outputGuards, Map<String,String> newRequestParameters, List<org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget> newActionTargets, String completionMessage) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      newRequestParameters - additional request parameters. These override/augment any request parameters defined for the next invoked service
      newActionTargets - list of action target names to GUIDs for the resulting governance action service
      completionMessage - message to describe completion results or reasons for failure
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service completion status
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • recordCompletionStatus

      void recordCompletionStatus(CompletionStatus status, List<String> outputGuards, Map<String,String> newRequestParameters, List<org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget> newActionTargets, org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition completionMessage) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Declare that all the processing for the governance action service is finished and the status of the work.
      Parameters:
      status - completion status enum value
      outputGuards - optional guard strings for triggering subsequent action(s)
      newRequestParameters - additional request parameters. These override/augment any request parameters defined for the next invoked service
      newActionTargets - list of action target names to GUIDs for the resulting governance action service
      completionMessage - message to describe completion results or reasons for failure
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the completion status is null
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update the governance action service completion status
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem connecting to the metadata store

    • getCompletionStatus

      CompletionStatus getCompletionStatus()
      Return any completion status from the governance action service.
      Returns:
      completion status enum

    • createGovernanceEngine

      String createGovernanceEngine(String governanceEngineType, String qualifiedName, String displayName, String description) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new governance engine definition.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the governance engine definition.

    • getGovernanceEngineByGUID

      GovernanceEngineElement getGovernanceEngineByGUID(String guid) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the properties from a governance engine definition.
      Parameters:
      guid - unique identifier (guid) of the governance engine definition.
      Returns:
      properties from the governance engine definition.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • getGovernanceEngineByName

      GovernanceEngineElement getGovernanceEngineByName(String name) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the properties from a governance engine definition.
      Parameters:
      name - qualified name or display name (if unique).
      Returns:
      properties from the governance engine definition.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance engine definition.

    • getAllGovernanceEngines

      List<GovernanceEngineElement> getAllGovernanceEngines(String governanceEngineType, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of governance engine definitions that are stored.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance engine definitions.

    • updateGovernanceEngine

      void updateGovernanceEngine(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.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the properties of an existing governance engine definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the governance engine definition.

    • deleteGovernanceEngine

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

    • createGovernanceService

      String createGovernanceService(String governanceServiceType, String qualifiedName, String displayName, String description, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a governance service definition. The same governance service can be associated with multiple governance engines.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the governance service definition.

    • getGovernanceServiceByGUID

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

    • getGovernanceServiceByName

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

    • getAllGovernanceServices

      List<GovernanceServiceElement> getAllGovernanceServices(int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of governance services definitions that are stored.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance service definitions.

    • getGovernanceServiceRegistrations

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

    • updateGovernanceService

      void updateGovernanceService(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.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the properties of an existing governance service definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the governance service definition.

    • deleteGovernanceService

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

    • registerGovernanceServiceWithEngine

      void registerGovernanceServiceWithEngine(String governanceEngineGUID, String governanceServiceGUID, String requestType, Map<String,String> requestParameters) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Register a governance service with a specific governance engine.
      Parameters:
      governanceEngineGUID - unique identifier of the governance engine.
      governanceServiceGUID - unique identifier of the governance service.
      requestType - request type that this governance service is able to process.
      requestParameters - list of parameters that are passed to the governance service (via the context). These values can be overridden on the actual governance service request.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • registerGovernanceServiceWithEngine

      void registerGovernanceServiceWithEngine(String governanceEngineGUID, String governanceServiceGUID, String governanceRequestType, String serviceRequestType, Map<String,String> requestParameters) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Register a governance service with a specific governance engine.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceService

      RegisteredGovernanceServiceElement getRegisteredGovernanceService(String governanceEngineGUID, String governanceServiceGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve a specific governance service registered with a governance engine.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the governance service and/or governance engine definitions.

    • getRegisteredGovernanceServices

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

    • unregisterGovernanceServiceFromEngine

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

    • createIntegrationGroup

      String createIntegrationGroup(IntegrationGroupProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create a new integration group definition.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the integration group definition.

    • getIntegrationGroupByGUID

      IntegrationGroupElement getIntegrationGroupByGUID(String guid) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the properties from an integration group definition.
      Parameters:
      guid - unique identifier (guid) of the integration group definition.
      Returns:
      properties from the integration group definition.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • getIntegrationGroupByName

      IntegrationGroupElement getIntegrationGroupByName(String name) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the properties from an integration group definition.
      Parameters:
      name - qualified name or display name (if unique).
      Returns:
      properties from the integration group definition.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration group definition.

    • getAllIntegrationGroups

      List<IntegrationGroupElement> getAllIntegrationGroups(int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of integration group definitions that are stored.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration group definitions.

    • updateIntegrationGroup

      void updateIntegrationGroup(String guid, boolean isMergeUpdate, IntegrationGroupProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the properties of an existing integration group definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      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 - values that will be associated with this integration group.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the integration group definition.

    • deleteIntegrationGroup

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

    • createIntegrationConnector

      String createIntegrationConnector(IntegrationConnectorProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create an integration connector definition. The same integration connector can be associated with multiple integration groups.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the integration connector definition.

    • getIntegrationConnectorByGUID

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

    • getIntegrationConnectorByName

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

    • getAllIntegrationConnectors

      List<IntegrationConnectorElement> getAllIntegrationConnectors(int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of integration connectors definitions that are stored.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector definitions.

    • getIntegrationConnectorRegistrations

      List<String> getIntegrationConnectorRegistrations(String integrationConnectorGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Return the list of integration groups that a specific integration connector is registered with.
      Parameters:
      integrationConnectorGUID - integration connector to search for.
      Returns:
      list of integration group unique identifiers (guids)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • updateIntegrationConnector

      void updateIntegrationConnector(String guid, boolean isMergeUpdate, IntegrationConnectorProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update the properties of an existing integration connector definition. Use the current value to keep a property value the same, or use the new value. Null means remove the property from the definition.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • deleteIntegrationConnector

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

    • registerIntegrationConnectorWithGroup

      void registerIntegrationConnectorWithGroup(String integrationGroupGUID, String integrationConnectorGUID, RegisteredIntegrationConnectorProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Register an integration connector with a specific integration group.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • getRegisteredIntegrationConnector

      RegisteredIntegrationConnectorElement getRegisteredIntegrationConnector(String integrationGroupGUID, String integrationConnectorGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve a specific integration connector registered with an integration group.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • getRegisteredIntegrationConnectors

      List<RegisteredIntegrationConnectorElement> getRegisteredIntegrationConnectors(String integrationGroupGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the identifiers of the integration connectors registered with an integration group.
      Parameters:
      integrationGroupGUID - unique identifier of the integration group.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector and/or integration group definitions.

    • unregisterIntegrationConnectorFromGroup

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

    • addCatalogTarget

      String addCatalogTarget(String integrationConnectorGUID, String metadataElementGUID, CatalogTargetProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Add a catalog target to an integration connector.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the catalog target definition.

    • updateCatalogTarget

      void updateCatalogTarget(String catalogTargetGUID, CatalogTargetProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update a catalog target for an integration connector.
      Parameters:
      catalogTargetGUID - unique identifier of the relationship.
      properties - properties for the relationship.
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem storing the catalog target definition.

    • getCatalogTarget

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

    • getCatalogTargets

      List<CatalogTarget> getCatalogTargets(String integrationConnectorGUID, int startingFrom, int maximumResults) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      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.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid,
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem retrieving the integration connector definition.

    • removeCatalogTarget

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