Package org.odpi.openmetadata.integrationservices.api.client

Class APIIntegrator

java.lang.Object

org.odpi.openmetadata.integrationservices.api.client.APIIntegrator

All Implemented Interfaces:

APIIntegratorAPI

public class APIIntegrator
extends Object
implements APIIntegratorAPI

APIIntegrator is the client library for the API Integrator OMIS's REST API.

Constructor Summary

Constructors

Constructor	Description
APIIntegrator(String serverName, String serverPlatformRootURL)	Create a new client with no authentication embedded in the HTTP request.
APIIntegrator(String serverName, String serverPlatformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
APIIntegrator(String serverName, String serverPlatformRootURL, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
APIIntegrator(String serverName, String serverPlatformRootURL, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
ConnectorType	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 Detail

APIIntegrator

public APIIntegrator(String serverName,
                     String serverPlatformRootURL,
                     AuditLog auditLog)
              throws 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 servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

APIIntegrator

public APIIntegrator(String serverName,
                     String serverPlatformRootURL)
              throws 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 servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

APIIntegrator

public APIIntegrator(String serverName,
                     String serverPlatformRootURL,
                     String userId,
                     String password,
                     AuditLog auditLog)
              throws 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 servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

APIIntegrator

public APIIntegrator(String serverName,
                     String serverPlatformRootURL,
                     String userId,
                     String password)
              throws 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 servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

validateConnector

public ConnectorType validateConnector(String userId,
                                       String connectorProviderClassName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Validate the connector and return its connector type.

Specified by:

validateConnector in interface APIIntegratorAPI

Parameters:

userId - calling user

connectorProviderClassName - name of a specific connector or null for all connectors

Returns:

connector type for this connector

Throws:

InvalidParameterException - the connector provider class name is not a valid connector fo this service

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration service