Package org.odpi.openmetadata.accessservices.datamanager.client

Class DataManagerBaseClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

Direct Known Subclasses:

DatabaseManagerClient, MetadataSourceClient, SchemaManagerClient, ValidValueManagement

public class DataManagerBaseClient
extends Object

DataManagerBaseClient supports the common properties and functions for the Data Manager OMAS.

Constructor Summary

Constructors

Constructor	Description
DataManagerBaseClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
DataManagerBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
DataManagerBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
DataManagerBaseClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.
DataManagerBaseClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
void	removeReferenceable(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String urlTemplate, boolean cascadedDeleteOption, String methodName)	Remove the metadata element.
void	removeReferenceable(String userId, String externalSourceGUID, String externalSourceName, String elementGUID, String elementGUIDParameterName, String urlTemplate, String methodName)	Remove the metadata element.

Methods inherited from class java.lang.Object

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

Constructor Details

DataManagerBaseClient

public DataManagerBaseClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                      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

auditLog - logging destination

Throws:

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

DataManagerBaseClient

public DataManagerBaseClient(String serverName,
 String serverPlatformURLRoot)
                      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

Throws:

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

DataManagerBaseClient

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

Throws:

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

DataManagerBaseClient

public DataManagerBaseClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                      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

auditLog - logging destination

Throws:

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

DataManagerBaseClient

public DataManagerBaseClient(String serverName,
 String serverPlatformURLRoot,
 DataManagerRESTClient restClient,
 int maxPageSize)
                      throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

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

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

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

Method Details

removeReferenceable

public void removeReferenceable(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String elementGUID,
 String elementGUIDParameterName,
 String urlTemplate,
 String methodName)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to remove

elementGUIDParameterName - name of parameter passing the elementGUID

urlTemplate - URL to call (no expected placeholders)

methodName - calling method

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)

removeReferenceable

public void removeReferenceable(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String elementGUID,
 String elementGUIDParameterName,
 String urlTemplate,
 boolean cascadedDeleteOption,
 String methodName)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to remove

elementGUIDParameterName - name of parameter passing the elementGUID

urlTemplate - URL to call (no expected placeholders)

cascadedDeleteOption - boolean indicating whether the delete request can cascade to dependent elements

methodName - calling method

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)