Package org.odpi.openmetadata.accessservices.digitalservice.client

Class OpenMetadataBaseClient

java.lang.Object

org.odpi.openmetadata.accessservices.digitalservice.client.OpenMetadataBaseClient

Direct Known Subclasses:

CollectionsClient

public abstract class OpenMetadataBaseClient
extends Object

OpenMetadataBaseClient supports the common properties and functions for the open metadata based clients.

Field Summary

Fields

Modifier and Type	Field	Description
protected final InvalidParameterHandler	invalidParameterHandler
protected final OpenMetadataStoreClient	openMetadataStoreClient
protected final PropertyHelper	propertyHelper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ElementProperties	getElementProperties(CollectionMembershipProperties collectionMembershipProperties)	Convert the digital product properties into a set of element properties for the open metadata client.
protected ElementProperties	getElementProperties(CollectionProperties collectionProperties)	Convert the collection properties into a set of element properties for the open metadata client.
protected ElementProperties	getElementProperties(DigitalProductProperties digitalProductProperties)	Convert the digital product properties into a set of element properties for the open metadata client.

Methods inherited from class java.lang.Object

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

Field Details

invalidParameterHandler

protected final InvalidParameterHandler invalidParameterHandler

propertyHelper

protected final PropertyHelper propertyHelper

openMetadataStoreClient

protected final OpenMetadataStoreClient openMetadataStoreClient

Constructor Details

OpenMetadataBaseClient

public OpenMetadataBaseClient(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 - number of elements that can be returned on a call

Throws:

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

OpenMetadataBaseClient

public OpenMetadataBaseClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 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

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - number of elements that can be returned on a call

Throws:

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

Method Details

getElementProperties

protected ElementProperties getElementProperties(CollectionProperties collectionProperties)

Convert the collection properties into a set of element properties for the open metadata client.

Parameters:

collectionProperties - supplied collection properties

Returns:

element properties

getElementProperties

protected ElementProperties getElementProperties(DigitalProductProperties digitalProductProperties)

Convert the digital product properties into a set of element properties for the open metadata client.

Parameters:

digitalProductProperties - supplied digital product properties

Returns:

element properties

getElementProperties

protected ElementProperties getElementProperties(CollectionMembershipProperties collectionMembershipProperties)

Convert the digital product properties into a set of element properties for the open metadata client.

Parameters:

collectionMembershipProperties - supplied collection membership properties

Returns:

element properties