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

Class CollectionsClient

java.lang.Object

org.odpi.openmetadata.frameworkservices.omf.client.handlers.CollectionHandler

org.odpi.openmetadata.accessservices.digitalservice.client.CollectionsClient

public class CollectionsClient
extends CollectionHandler

The CollectionsClient supports requests related to collections.

Constructor Summary

Constructors

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

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworkservices.omf.client.handlers.CollectionHandler

addToCollection, attachCollection, createCollection, createCollectionFromTemplate, deleteCollection, detachAgreementActor, detachAgreementItem, detachCollection, detachContract, detachDigitalProductDependency, detachProductManager, detachSubscriber, findCollections, getAttachedCollections, getCollection, getCollectionGraph, getCollectionMembers, getCollectionsByName, getCollectionsByType, getElementStatus, getElementStatus, linkAgreementActor, linkAgreementItem, linkContract, linkDigitalProductDependency, linkProductManager, linkSubscriber, removeFromCollection, updateCollection, updateCollectionMembership, updateCollectionStatus

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionsClient

public CollectionsClient(String localServerName,
 String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                  throws InvalidParameterException

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

Parameters:

localServerName - name of this server (view server)

serverName - name of the server to connect to

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

auditLog - logging destination

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.

CollectionsClient

public CollectionsClient(String localServerName,
 String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog,
 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:

localServerName - name of this server (view server)

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

auditLog - logging destination

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.