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

Class OpenIntegrationClient

java.lang.Object

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

Direct Known Subclasses:

OpenIntegrationServiceBase

public abstract class OpenIntegrationClient
extends Object

OpenIntegrationClient defines the interface of the client that implements calls to the metadata server.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	serverName
protected final String	serverPlatformURLRoot
protected final String	serviceURLMarker

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 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

Field Details

serverName

protected final String serverName

serverPlatformURLRoot

protected final String serverPlatformURLRoot

serviceURLMarker

protected final String serviceURLMarker

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 InvalidParameterException,
UserNotAuthorizedException,
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:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createMetadataSource

public abstract 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.

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)