Package org.odpi.openmetadata.frameworkservices.oif.server

Class OpenIntegrationRESTServices

java.lang.Object
org.odpi.openmetadata.frameworkservices.oif.server.OpenIntegrationRESTServices
public class OpenIntegrationRESTServices extends Object
The OpenIntegrationRESTServices provides the server-side implementation of the services used by the governance engine as it is managing requests to execute open governance services in the governance server. These services align with the interface definitions from the Open Integration Framework (OIF).

  • Constructor Details

    • OpenIntegrationRESTServices

      public OpenIntegrationRESTServices()
      Default constructor

  • Method Details

    • getMetadataSourceGUID

      public GUIDResponse getMetadataSourceGUID(String serverName, String serviceURLMarker, String userId, NameRequestBody requestBody)
      Retrieve the unique identifier of the external metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - unique name of the software capability
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createMetadataSource

      public GUIDResponse createMetadataSource(String serverName, String serviceURLMarker, String userId, MetadataSourceRequestBody requestBody)
      Create a new metadata element to represent a software capability. This describes the metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - properties of the software capability
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • getCatalogTargets

      public CatalogTargetsResponse getCatalogTargets(String serverName, String serviceURLMarker, String userId, String integrationConnectorGUID, int startingFrom, int maximumResults)
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the integration connector definition.

    • publishIntegrationReport

      public VoidResponse publishIntegrationReport(String serverName, String serviceURLMarker, String userId, String anchorGUID, String anchorTypeName, IntegrationReportProperties properties)
      Create a new integration report for an element (identified by anchorGUID).
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      anchorGUID - element to attach the integration report to
      anchorTypeName - typeName of the anchor for the integration report
      properties - properties of the report
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request, PropertyServerException problem with the metadata server.

    • getIntegrationReport

      public IntegrationReportResponse getIntegrationReport(String serverName, String serviceURLMarker, String userId, String reportGUID)
      Retrieve a specific integration report by unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      reportGUID - unique identifier of the integration report
      Returns:
      report or null or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request, PropertyServerException problem with the metadata server.

    • getIntegrationReportsForElement

      public IntegrationReportsResponse getIntegrationReportsForElement(String serverName, String serviceURLMarker, String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
      Retrieve the integration reports attached to an element. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      elementGUID - calling user
      afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).
      beforeStartDate - restrict reports to those that started before the requested time (null for any start time).
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of qualifying reports or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request. PropertyServerException problem with the metadata server.

    • getIntegrationReports

      public IntegrationReportsResponse getIntegrationReports(String serverName, String serviceURLMarker, String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
      Retrieve the published integration reports. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).
      beforeStartDate - restrict reports to those that started before the requested time (null for any start time).
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of qualifying reports or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request. PropertyServerException problem with the metadata server.