Package org.odpi.openmetadata.frameworks.integration.client

Class OpenIntegrationClient

java.lang.Object
org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient
public abstract class OpenIntegrationClient extends Object
OpenIntegrationClient defines the interface of the client that implements calls to the metadata server.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenIntegrationClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName, String deployedImplementationType)
    Create a new metadata element to represent a software capability.
    abstract org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse
    getAssetProperties(String userId, String assetGUID)
    Returns a comprehensive collection of properties about the requested asset.
    abstract org.odpi.openmetadata.frameworks.connectors.Connector
    getConnectorToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Return the connector to the requested asset.
    abstract org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport
    getIntegrationReport(String userId, String reportGUID)
    Retrieve a specific integration report by unique identifier.
    abstract List<org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport>
    getIntegrationReports(String userId, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
    Retrieve the published integration reports.
    abstract List<org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport>
    getIntegrationReportsForElement(String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, int startingFrom, int maximumResults)
    Retrieve the integration reports attached to an element.
    abstract String
    getMetadataSourceGUID(String userId, String qualifiedName)
    Retrieve the unique identifier of the metadata element that represents the metadata source.
    abstract void
    publishIntegrationReport(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReportProperties properties)
    Create a new integration report for an element (identified by anchorGUID).
    abstract String
    saveConnection(String userId, String assetGUID, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the unique identifier corresponding to the supplied connection.
    abstract String
    saveConnection(String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Returns the unique identifier corresponding to the supplied connection.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenIntegrationClient

      public OpenIntegrationClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services

  • Method Details

    • getMetadataSourceGUID

      public abstract String getMetadataSourceGUID(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the unique identifier of the metadata element that represents the metadata source.
      Parameters:
      userId - calling user
      qualifiedName - unique name of the metadata source
      Returns:
      unique identifier of the metadata source
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

    • createMetadataSource

      public abstract String createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName, String deployedImplementationType) 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 metadata element to represent a software capability. This describes the metadata source.
      Parameters:
      userId - calling user
      softwareCapabilityTypeName - name of software capability type to describe the metadata source
      classificationName - optional classification name that refines the type of the software capability.
      qualifiedName - unique name for the external source
      deployedImplementationType - type of technology
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • publishIntegrationReport

      public abstract void publishIntegrationReport(String userId, String anchorGUID, org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReportProperties 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 report for an element (identified by anchorGUID).
      Parameters:
      userId - calling user
      anchorGUID - element to attach the integration report to
      properties - properties of the report
      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 with the metadata server.

    • getIntegrationReport

      public abstract org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport getIntegrationReport(String userId, String reportGUID) 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 report by unique identifier.
      Parameters:
      userId - calling user
      reportGUID - unique identifier of the integration report
      Returns:
      report or null
      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 with the metadata server.

    • getIntegrationReportsForElement

      public abstract List<org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport> getIntegrationReportsForElement(String userId, String elementGUID, Date afterCompletionDate, Date beforeStartDate, 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 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:
      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
      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 with the metadata server.

    • getIntegrationReports

      public abstract List<org.odpi.openmetadata.frameworks.governanceaction.properties.IntegrationReport> getIntegrationReports(String userId, Date afterCompletionDate, Date beforeStartDate, 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 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:
      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
      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 with the metadata server.

    • saveConnection

      public abstract String saveConnection(String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the unique identifier corresponding to the supplied connection.
      Parameters:
      userId - calling user
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

    • saveConnection

      public abstract String saveConnection(String userId, String assetGUID, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Returns the unique identifier corresponding to the supplied connection.
      Parameters:
      userId - calling user
      assetGUID - the unique identifier of an asset to attach the connection to
      connection - the connection object that contains the properties needed to create the connection.
      Returns:
      guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.

    • getAssetProperties

      public abstract org.odpi.openmetadata.frameworks.connectors.properties.AssetUniverse getAssetProperties(String userId, String assetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Returns a comprehensive collection of properties about the requested asset.
      Parameters:
      userId - calling user
      assetGUID - the unique identifier of an asset to attach the connection to
      Returns:
      a comprehensive collection of properties about the asset.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving the asset properties from the property servers.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getConnectorToAsset

      public abstract org.odpi.openmetadata.frameworks.connectors.Connector getConnectorToAsset(String userId, String assetGUID, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException, org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException
      Return the connector to the requested asset.
      Parameters:
      userId - calling user
      assetGUID - the unique identifier of an asset to attach the connection to
      auditLog - optional logging destination
      Returns:
      Open Connector Framework (OCF) connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the asset guid is not recognized or the userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException - there are errors in the initialization of the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to access the asset and/or connection needed to create the connector.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem in the store whether the asset/connection properties are kept.