Package org.odpi.openmetadata.accessservices.digitalarchitecture.client

Class OpenIntegrationServiceClient

java.lang.Object

org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

org.odpi.openmetadata.frameworkservices.oif.client.OpenIntegrationServiceBase

org.odpi.openmetadata.accessservices.digitalarchitecture.client.OpenIntegrationServiceClient

public class OpenIntegrationServiceClient
extends OpenIntegrationServiceBase

OpenIntegrationServiceClient provides an interface to the open integration service. This is part of the Open Integration Framework (OIF) and provides an interface for understanding the work of the integration connectors that are synchronizing metadata.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.client.OpenIntegrationClient

serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
OpenIntegrationServiceClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
OpenIntegrationServiceClient(String serverName, String serverPlatformURLRoot, String serverUserId, String serverPassword, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworkservices.oif.client.OpenIntegrationServiceBase

createMetadataSource, getAssetProperties, getConnectorToAsset, getIntegrationReport, getIntegrationReports, getIntegrationReportsForElement, getMetadataSourceGUID, publishIntegrationReport, saveConnection, saveConnection

Methods inherited from class java.lang.Object

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

Constructor Details

OpenIntegrationServiceClient

public OpenIntegrationServiceClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                             throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

maxPageSize - maximum value allowed for page size

Throws:

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

OpenIntegrationServiceClient

public OpenIntegrationServiceClient(String serverName,
 String serverPlatformURLRoot,
 String serverUserId,
 String serverPassword,
 int maxPageSize)
                             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

serverPlatformURLRoot - the network address of the server running the OMAS REST services

serverUserId - caller's userId embedded in all HTTP requests

serverPassword - caller's password embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

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