Package org.odpi.openmetadata.frameworkservices.oif.client

Class OpenIntegrationServiceBase

java.lang.Object

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

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

Direct Known Subclasses:

OpenIntegrationServiceClient

public class OpenIntegrationServiceBase
extends OpenIntegrationClient

OpenIntegrationServiceBase supports the open integration interface.

Field Summary

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

serverName, serverPlatformURLRoot, serviceURLMarker

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	createMetadataSource(String userId, String softwareCapabilityTypeName, String classificationName, String qualifiedName, String deployedImplementationType)	Create a new metadata element to represent a software capability.
String	getMetadataSourceGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the metadata element that represents the metadata source.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                           throws InvalidParameterException

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

maxPageSize - maximum value allowed for page size

Throws:

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

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 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:

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

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.

OpenIntegrationServiceBase

public OpenIntegrationServiceBase(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot,
 OpenIntegrationRESTClient restClient,
 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:

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

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

getMetadataSourceGUID

public String getMetadataSourceGUID(String userId,
 String qualifiedName)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the unique identifier of the metadata element that represents the metadata source.

Specified by:

getMetadataSourceGUID in class OpenIntegrationClient

Parameters:

userId - calling user

qualifiedName - unique name of the metadata source

Returns:

unique identifier of the metadata source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createMetadataSource

public String createMetadataSource(String userId,
 String softwareCapabilityTypeName,
 String classificationName,
 String qualifiedName,
 String deployedImplementationType)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a software capability. This describes the metadata source.

Specified by:

createMetadataSource in class OpenIntegrationClient

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:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)