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 Summary

    Constructors
    Constructor
    Description
    OpenIntegrationRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createMetadataSource(String serverName, String userId, org.odpi.openmetadata.frameworkservices.oif.rest.MetadataSourceRequestBody requestBody)
    Create a new metadata element to represent a software capability.
    org.odpi.openmetadata.frameworkservices.oif.rest.CatalogTargetsResponse
    getCatalogTargets(String serverName, String userId, String integrationConnectorGUID, int startingFrom, int maximumResults)
    Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
    org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportResponse
    getIntegrationReport(String serverName, String userId, String reportGUID)
    Retrieve a specific integration report by unique identifier.
    org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportsResponse
    getIntegrationReports(String serverName, String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
    Retrieve the published integration reports.
    org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportsResponse
    getIntegrationReportsForElement(String serverName, String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
    Retrieve the integration reports attached to an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    getMetadataSourceGUID(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the unique identifier of the external metadata source.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    publishIntegrationReport(String serverName, String userId, String anchorGUID, org.odpi.openmetadata.frameworks.integration.properties.IntegrationReportProperties properties)
    Create a new integration report for an element (identified by anchorGUID).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenIntegrationRESTServices

      public OpenIntegrationRESTServices()
      Default constructor

  • Method Details

    • getMetadataSourceGUID

      public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse getMetadataSourceGUID(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
      Retrieve the unique identifier of the external metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createMetadataSource(String serverName, String userId, org.odpi.openmetadata.frameworkservices.oif.rest.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.
      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 org.odpi.openmetadata.frameworkservices.oif.rest.CatalogTargetsResponse getCatalogTargets(String serverName, 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.
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse publishIntegrationReport(String serverName, String userId, String anchorGUID, org.odpi.openmetadata.frameworks.integration.properties.IntegrationReportProperties properties)
      Create a new integration report for an element (identified by anchorGUID).
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      anchorGUID - element to attach the integration report to
      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 org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportResponse getIntegrationReport(String serverName, String userId, String reportGUID)
      Retrieve a specific integration report by unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      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 org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportsResponse getIntegrationReportsForElement(String serverName, 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.
      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 org.odpi.openmetadata.frameworkservices.oif.rest.IntegrationReportsResponse getIntegrationReports(String serverName, 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.
      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.