Package org.odpi.openmetadata.integrationservices.topic.client

Class TopicIntegrator

java.lang.Object
org.odpi.openmetadata.integrationservices.topic.client.TopicIntegrator
All Implemented Interfaces:
org.odpi.openmetadata.integrationservices.topic.api.TopicIntegratorAPI
public class TopicIntegrator extends Object implements org.odpi.openmetadata.integrationservices.topic.api.TopicIntegratorAPI
TopicIntegrator is the client library for the Topic Integrator OMIS's REST API.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TopicIntegrator(String serverName, String serverPlatformRootURL)
    Create a new client with no authentication embedded in the HTTP request.
    TopicIntegrator(String serverName, String serverPlatformRootURL, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    TopicIntegrator(String serverName, String serverPlatformRootURL, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    TopicIntegrator(String serverName, String serverPlatformRootURL, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport
    validateConnector(String userId, String connectorProviderClassName)
    Validate the connector and return its connector type.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TopicIntegrator

      public TopicIntegrator(String serverName, String serverPlatformRootURL, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • TopicIntegrator

      public TopicIntegrator(String serverName, String serverPlatformRootURL) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • TopicIntegrator

      public TopicIntegrator(String serverName, String serverPlatformRootURL, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • TopicIntegrator

      public TopicIntegrator(String serverName, String serverPlatformRootURL, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformRootURL - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • validateConnector

      public org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport validateConnector(String userId, String connectorProviderClassName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Validate the connector and return its connector type.
      Specified by:
      validateConnector in interface org.odpi.openmetadata.integrationservices.topic.api.TopicIntegratorAPI
      Parameters:
      userId - calling user
      connectorProviderClassName - name of a specific connector or null for all connectors
      Returns:
      connector report for this connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector provider class name is not a valid connector fo this service
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration service